From 5bb7eae1a2014fca73c0dc6ec758daac90066841 Mon Sep 17 00:00:00 2001 From: Josh Date: Thu, 9 Jul 2026 12:53:31 -0400 Subject: [PATCH] feat(occ): improve config:list help text/descriptions - Make language more descriptive, precise, and consistent - Add examples Signed-off-by: Josh --- core/Command/Config/ListConfigs.php | 35 ++++++++++++++++++++++++----- 1 file changed, 30 insertions(+), 5 deletions(-) diff --git a/core/Command/Config/ListConfigs.php b/core/Command/Config/ListConfigs.php index 9003ec49c938d..e903aec90a5e1 100644 --- a/core/Command/Config/ListConfigs.php +++ b/core/Command/Config/ListConfigs.php @@ -37,21 +37,46 @@ protected function configure() { $this ->setName('config:list') - ->setDescription('List all configs') + ->setDescription('List system and app configuration values') ->addArgument( 'app', InputArgument::OPTIONAL, - 'Name of the app ("system" to get the config.php values, "all" for all apps and system)', + 'What to list: an app name, "system" for system configuration values, or "all" for system and all app configs', 'all' ) ->addOption( 'private', null, InputOption::VALUE_NONE, - 'Use this option when you want to include sensitive configs like passwords, salts, ...' + 'Include sensitive configuration values like passwords and secrets' ) - ->addOption('migrate', null, InputOption::VALUE_NONE, 'Rename config keys of all enabled apps, based on ConfigLexicon') - ; + ->addOption( + 'migrate', + null, + InputOption::VALUE_NONE, + 'Migrate config keys using the ConfigLexicon before listing', + ) + ->setHelp(<<<'HELP' +The %command.name% command lists system and app configuration values. + +For system, this shows the effective system configuration as loaded by +Nextcloud. It may include values from config.php, additional *.config.php +files, and NC_* environment variables. + +Examples: + + php occ config:list + List all system and app configuration values + + php occ config:list system + List only system configuration values + + php occ config:list files_sharing + List configuration values for the files_sharing app + + php occ config:list --private + List all system and app configuration values, including sensitive values +HELP); } #[\Override]