Skip to content

feat(occ): improve config:list help text/descriptions - #61953

Open
joshtrichards wants to merge 1 commit into
masterfrom
jtr/feat-occ-configList-help-text
Open

feat(occ): improve config:list help text/descriptions#61953
joshtrichards wants to merge 1 commit into
masterfrom
jtr/feat-occ-configList-help-text

Conversation

@joshtrichards

@joshtrichards joshtrichards commented Jul 9, 2026

Copy link
Copy Markdown
Member
  • Resolves: #

Summary

  • Make language more descriptive, precise, and consistent
  • Add examples

Before:

root@90c0b61e2a5c:/var/www/html# ./occ config:list --help   
Description:
  List all configs

Usage:
  config:list [options] [--] [<app>]

Arguments:
  app                    Name of the app ("system" to get the config.php values, "all" for all apps and system) [default: "all"]

Options:
      --output[=OUTPUT]  Output format (plain, json or json_pretty, default is plain) [default: "json_pretty"]
      --private          Use this option when you want to include sensitive configs like passwords, salts, ...
      --migrate          Rename config keys of all enabled apps, based on ConfigLexicon
  -h, --help             Display help for the given command. When no command is given display help for the list command
  -q, --quiet            Do not output any message
  -V, --version          Display this application version
      --ansi|--no-ansi   Force (or disable --no-ansi) ANSI output
  -n, --no-interaction   Do not ask any interactive question
      --no-warnings      Skip global warnings, show command output only
  -v|vv|vvv, --verbose   Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
  More extensive and thorough documentation may be found at https://docs.nextcloud.com

After:

root@55f7573a36fc:/var/www/html# ./occ config:list --help
Description:
  List system and app configuration values

Usage:
  config:list [options] [--] [<app>]

Arguments:
  app                    What to list: an app name, "system" for system configuration values, or "all" for system and all app configs [default: "all"]

Options:
      --output[=OUTPUT]  Output format (plain, json or json_pretty, default is plain) [default: "json_pretty"]
      --private          Include sensitive configuration values like passwords and secrets
      --migrate          Migrate config keys using the ConfigLexicon before listing
  -h, --help             Display help for the given command. When no command is given display help for the list command
  -q, --quiet            Do not output any message
  -V, --version          Display this application version
      --ansi|--no-ansi   Force (or disable --no-ansi) ANSI output
  -n, --no-interaction   Do not ask any interactive question
      --no-warnings      Skip global warnings, show command output only
  -v|vv|vvv, --verbose   Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
  The config:list 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

Checklist

AI (if applicable)

  • The content of this PR was partly or fully generated using AI

- Make language more descriptive, precise, and consistent
- Add examples

Signed-off-by: Josh <josh.t.richards@gmail.com>
@joshtrichards joshtrichards added this to the Nextcloud 35 milestone Jul 9, 2026
@joshtrichards
joshtrichards marked this pull request as ready for review July 9, 2026 19:52
@joshtrichards
joshtrichards requested a review from a team as a code owner July 9, 2026 19:52
@joshtrichards
joshtrichards requested review from ArtificialOwl, leftybournes, provokateurin and salmart-dev and removed request for a team July 9, 2026 19:52
@joshtrichards joshtrichards added 3. to review Waiting for reviews and removed 2. developing Work in progress labels Jul 9, 2026
@joshtrichards
joshtrichards requested a review from szaimen July 10, 2026 12:18
@susnux susnux added the community pull requests from community label Jul 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

3. to review Waiting for reviews community pull requests from community enhancement feature: occ

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants