Skip to content

Commit 5bb7eae

Browse files
feat(occ): improve config:list help text/descriptions
- Make language more descriptive, precise, and consistent - Add examples Signed-off-by: Josh <josh.t.richards@gmail.com>
1 parent 1dcf94e commit 5bb7eae

1 file changed

Lines changed: 30 additions & 5 deletions

File tree

core/Command/Config/ListConfigs.php

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,21 +37,46 @@ protected function configure() {
3737

3838
$this
3939
->setName('config:list')
40-
->setDescription('List all configs')
40+
->setDescription('List system and app configuration values')
4141
->addArgument(
4242
'app',
4343
InputArgument::OPTIONAL,
44-
'Name of the app ("system" to get the config.php values, "all" for all apps and system)',
44+
'What to list: an app name, "system" for system configuration values, or "all" for system and all app configs',
4545
'all'
4646
)
4747
->addOption(
4848
'private',
4949
null,
5050
InputOption::VALUE_NONE,
51-
'Use this option when you want to include sensitive configs like passwords, salts, ...'
51+
'Include sensitive configuration values like passwords and secrets'
5252
)
53-
->addOption('migrate', null, InputOption::VALUE_NONE, 'Rename config keys of all enabled apps, based on ConfigLexicon')
54-
;
53+
->addOption(
54+
'migrate',
55+
null,
56+
InputOption::VALUE_NONE,
57+
'Migrate config keys using the ConfigLexicon before listing',
58+
)
59+
->setHelp(<<<'HELP'
60+
The <info>%command.name%</info> command lists system and app configuration values.
61+
62+
For system, this shows the effective system configuration as loaded by
63+
Nextcloud. It may include values from <info>config.php</info>, additional <info>*.config.php</info>
64+
files, and <info>NC_*</info> environment variables.
65+
66+
Examples:
67+
68+
<info>php occ config:list</info>
69+
List all system and app configuration values
70+
71+
<info>php occ config:list system</info>
72+
List only system configuration values
73+
74+
<info>php occ config:list files_sharing</info>
75+
List configuration values for the files_sharing app
76+
77+
<info>php occ config:list --private</info>
78+
List all system and app configuration values, including sensitive values
79+
HELP);
5580
}
5681

5782
#[\Override]

0 commit comments

Comments
 (0)