core icon indicating copy to clipboard operation
core copied to clipboard

config:app:list command

Open mmattel opened this issue 3 years ago • 6 comments

Steps to reproduce

  1. There are config:app:get and config:app:set commands
  2. but no config:app:list

Expected behaviour

New command: config:app:list + options

Actual behaviour

Missing command, refrencing discussion starting at: https://github.com/owncloud/core/issues/37697#issuecomment-660071523

This is not only an admin but also a documentation nightmare. Nobody will remember config:app variables days after implementaion without a list command and documentation! In addition, a mistyped variable or value will be accepted but not considered in the program leading to confusion.

Suggestion:

config:app:list <options> <options>: --app <appname> (the app name, else all) --internal (list known changeable interal variables and their possible predifined values) --set (list of changeable variables set and their values independent of internal or manually set)

(--set and --internal are mutually exclusive)

Example: config:app:list --app files --internal

Server configuration

ownCloud version: 10.4.1 (10.5 RC2)

@phil-davis @pmaier1 @micbar

mmattel avatar Jul 17 '20 13:07 mmattel

This would be handy to have. But it will require some engineering design so that when it is given the app name it can call some standard method in the app that is expected to return the information. And error handling for apps that do not yet have such a method.

phil-davis avatar Jul 17 '20 14:07 phil-davis

And please keep in mind: oc10 is soon EOL. Why waste energy on such things.

DeepDiver1975 avatar Jul 17 '20 15:07 DeepDiver1975

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 10 days if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Mar 21 '22 01:03 github-actions[bot]

There is already the config:list command. That lets you put an app name to list just the configs for that app:

$ php occ config:list files_sharing
{
    "apps": {
        "files_sharing": {
            "enabled": "yes",
            "incoming_server2server_share_enabled": "yes",
            "installed_version": "0.14.0",
            "outgoing_server2server_share_enabled": "yes",
            "types": "filesystem"
        }
    }
}

and you can do config:list core to get various settings that are deemed to be core app. Or config:list system to list what is is config/config.php

phil-davis avatar Mar 21 '22 02:03 phil-davis

And documentation is here: https://doc.owncloud.com/server/next/admin_manual/configuration/server/occ_command.html#config-commands

config:list shows the currently-set app config keys/values. So I think the issue is really what about cases where the is a possible setting to control something, but it has never been set to a specific value (some default is being used) - that won't even be mentioned in the output of config:list, and that makes it difficult for someone to know that such "hidden" app config settings even exist.

phil-davis avatar Mar 21 '22 03:03 phil-davis

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 10 days if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Sep 18 '22 01:09 github-actions[bot]

This issue has been automatically closed.

github-actions[bot] avatar Sep 29 '22 01:09 github-actions[bot]