Add generated command reference docs

.github/workflows/ci.yml

@@ -39,6 +39,18 @@ jobs:
           VERSION: ci
       - run: ./packaging/package-release.sh ci
 
+  docs:
+    name: Generated docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-go@v6
+        with:
+          go-version: "1.25"
+      - run: go run ./tools/gen-docs
+      - run: git diff --exit-code docs/commands
+      - run: test -z "$(git status --porcelain -- docs/commands)"
+
   chocolatey:
     name: Chocolatey package
     runs-on: windows-latest

README.md

@@ -148,6 +148,8 @@ Flags:
 Use "dbxcli [command] --help" for more information about a command.
 ```
 
+The complete generated command reference is available in [docs/commands/dbxcli.md](https://github.com/dropbox/dbxcli/blob/master/docs/commands/dbxcli.md).
+
 ### Output formats
 
 Text output is the default. JSON output is available through the global `--output` flag for migrated commands:
@@ -208,7 +210,7 @@ In JSON mode, error responses are written to stdout and the process exits with a
 }
 ```
 
-The full JSON command catalog, stable error codes, and schemas live in [docs/json-schema/v1](docs/json-schema/v1/). Commands that intentionally do not support JSON output yet include `login`, `logout`, and `completion`. Help output and shell-completion protocol commands are text-only.
+The full JSON command catalog, stable error codes, and schemas live in [docs/json-schema/v1](https://github.com/dropbox/dbxcli/tree/master/docs/json-schema/v1). Commands that intentionally do not support JSON output yet include `login`, `logout`, and `completion`. Help output and shell-completion protocol commands are text-only.
 
 ### Authentication
 

docs/commands/dbxcli.md

@@ -0,0 +1,42 @@
+<!-- Code generated by go run ./tools/gen-docs; DO NOT EDIT. -->
+
+## dbxcli
+
+A command line tool for Dropbox users and team admins
+
+### Synopsis
+
+Use dbxcli to quickly interact with your Dropbox, upload/download files,
+manage your team and more. It is easy, scriptable and works on all platforms!
+
+### Options
+
+```
+      --as-member string   Member ID to perform action as
+  -h, --help               help for dbxcli
+      --output string      Output format: text, json (default "text")
+  -v, --verbose            Enable verbose logging
+```
+
+### SEE ALSO
+
+* [dbxcli account](dbxcli_account.md)	 - Display account information
+* [dbxcli completion](dbxcli_completion.md)	 - Generate the autocompletion script for the specified shell
+* [dbxcli cp](dbxcli_cp.md)	 - Copy a file or folder to a different location in the user's Dropbox. If the source path is a folder all its contents will be copied.
+* [dbxcli du](dbxcli_du.md)	 - Display usage information
+* [dbxcli get](dbxcli_get.md)	 - Download a file or folder
+* [dbxcli login](dbxcli_login.md)	 - Log in and save Dropbox credentials
+* [dbxcli logout](dbxcli_logout.md)	 - Log out of the current session
+* [dbxcli ls](dbxcli_ls.md)	 - List files and folders
+* [dbxcli mkdir](dbxcli_mkdir.md)	 - Create a new directory
+* [dbxcli mv](dbxcli_mv.md)	 - Move files
+* [dbxcli put](dbxcli_put.md)	 - Upload files or directories
+* [dbxcli restore](dbxcli_restore.md)	 - Restore a file revision
+* [dbxcli revs](dbxcli_revs.md)	 - List file revisions
+* [dbxcli rm](dbxcli_rm.md)	 - Remove files or folders
+* [dbxcli search](dbxcli_search.md)	 - Search
+* [dbxcli share](dbxcli_share.md)	 - Sharing commands
+* [dbxcli share-link](dbxcli_share-link.md)	 - Shared link commands
+* [dbxcli team](dbxcli_team.md)	 - Team management commands
+* [dbxcli version](dbxcli_version.md)	 - Print version information
+

docs/commands/dbxcli_account.md

@@ -0,0 +1,35 @@
+<!-- Code generated by go run ./tools/gen-docs; DO NOT EDIT. -->
+
+## dbxcli account
+
+Display account information
+
+```
+dbxcli account [flags] [<account-id>]
+```
+
+### Examples
+
+```
+  dbxcli account
+  dbxcli account dbid:xxxx
+```
+
+### Options
+
+```
+  -h, --help   help for account
+```
+
+### Options inherited from parent commands
+
+```
+      --as-member string   Member ID to perform action as
+      --output string      Output format: text, json (default "text")
+  -v, --verbose            Enable verbose logging
+```
+
+### SEE ALSO
+
+* [dbxcli](dbxcli.md)	 - A command line tool for Dropbox users and team admins
+

docs/commands/dbxcli_completion.md

@@ -0,0 +1,38 @@
+<!-- Code generated by go run ./tools/gen-docs; DO NOT EDIT. -->
+
+## dbxcli completion
+
+Generate the autocompletion script for the specified shell
+
+### Synopsis
+
+Generate the autocompletion script for dbxcli for the specified shell.
+See each sub-command's help for details on how to use the generated script.
+
+
+```
+dbxcli completion [bash|zsh|fish|powershell] [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for completion
+```
+
+### Options inherited from parent commands
+
+```
+      --as-member string   Member ID to perform action as
+      --output string      Output format: text, json (default "text")
+  -v, --verbose            Enable verbose logging
+```
+
+### SEE ALSO
+
+* [dbxcli](dbxcli.md)	 - A command line tool for Dropbox users and team admins
+* [dbxcli completion bash](dbxcli_completion_bash.md)	 - Generate the autocompletion script for bash
+* [dbxcli completion fish](dbxcli_completion_fish.md)	 - Generate the autocompletion script for fish
+* [dbxcli completion powershell](dbxcli_completion_powershell.md)	 - Generate the autocompletion script for powershell
+* [dbxcli completion zsh](dbxcli_completion_zsh.md)	 - Generate the autocompletion script for zsh
+

docs/commands/dbxcli_completion_bash.md

@@ -0,0 +1,53 @@
+<!-- Code generated by go run ./tools/gen-docs; DO NOT EDIT. -->
+
+## dbxcli completion bash
+
+Generate the autocompletion script for bash
+
+### Synopsis
+
+Generate the autocompletion script for the bash shell.
+
+This script depends on the 'bash-completion' package.
+If it is not installed already, you can install it via your OS's package manager.
+
+To load completions in your current shell session:
+
+	source <(dbxcli completion bash)
+
+To load completions for every new session, execute once:
+
+#### Linux:
+
+	dbxcli completion bash > /etc/bash_completion.d/dbxcli
+
+#### macOS:
+
+	dbxcli completion bash > $(brew --prefix)/etc/bash_completion.d/dbxcli
+
+You will need to start a new shell for this setup to take effect.
+
+
+```
+dbxcli completion bash
+```
+
+### Options
+
+```
+  -h, --help              help for bash
+      --no-descriptions   disable completion descriptions
+```
+
+### Options inherited from parent commands
+
+```
+      --as-member string   Member ID to perform action as
+      --output string      Output format: text, json (default "text")
+  -v, --verbose            Enable verbose logging
+```
+
+### SEE ALSO
+
+* [dbxcli completion](dbxcli_completion.md)	 - Generate the autocompletion script for the specified shell
+

docs/commands/dbxcli_completion_fish.md

@@ -0,0 +1,44 @@
+<!-- Code generated by go run ./tools/gen-docs; DO NOT EDIT. -->
+
+## dbxcli completion fish
+
+Generate the autocompletion script for fish
+
+### Synopsis
+
+Generate the autocompletion script for the fish shell.
+
+To load completions in your current shell session:
+
+	dbxcli completion fish | source
+
+To load completions for every new session, execute once:
+
+	dbxcli completion fish > ~/.config/fish/completions/dbxcli.fish
+
+You will need to start a new shell for this setup to take effect.
+
+
+```
+dbxcli completion fish [flags]
+```
+
+### Options
+
+```
+  -h, --help              help for fish
+      --no-descriptions   disable completion descriptions
+```
+
+### Options inherited from parent commands
+
+```
+      --as-member string   Member ID to perform action as
+      --output string      Output format: text, json (default "text")
+  -v, --verbose            Enable verbose logging
+```
+
+### SEE ALSO
+
+* [dbxcli completion](dbxcli_completion.md)	 - Generate the autocompletion script for the specified shell
+

docs/commands/dbxcli_completion_powershell.md

@@ -0,0 +1,41 @@
+<!-- Code generated by go run ./tools/gen-docs; DO NOT EDIT. -->
+
+## dbxcli completion powershell
+
+Generate the autocompletion script for powershell
+
+### Synopsis
+
+Generate the autocompletion script for powershell.
+
+To load completions in your current shell session:
+
+	dbxcli completion powershell | Out-String | Invoke-Expression
+
+To load completions for every new session, add the output of the above command
+to your powershell profile.
+
+
+```
+dbxcli completion powershell [flags]
+```
+
+### Options
+
+```
+  -h, --help              help for powershell
+      --no-descriptions   disable completion descriptions
+```
+
+### Options inherited from parent commands
+
+```
+      --as-member string   Member ID to perform action as
+      --output string      Output format: text, json (default "text")
+  -v, --verbose            Enable verbose logging
+```
+
+### SEE ALSO
+
+* [dbxcli completion](dbxcli_completion.md)	 - Generate the autocompletion script for the specified shell
+

docs/commands/dbxcli_completion_zsh.md

@@ -0,0 +1,55 @@
+<!-- Code generated by go run ./tools/gen-docs; DO NOT EDIT. -->
+
+## dbxcli completion zsh
+
+Generate the autocompletion script for zsh
+
+### Synopsis
+
+Generate the autocompletion script for the zsh shell.
+
+If shell completion is not already enabled in your environment you will need
+to enable it.  You can execute the following once:
+
+	echo "autoload -U compinit; compinit" >> ~/.zshrc
+
+To load completions in your current shell session:
+
+	source <(dbxcli completion zsh)
+
+To load completions for every new session, execute once:
+
+#### Linux:
+
+	dbxcli completion zsh > "${fpath[1]}/_dbxcli"
+
+#### macOS:
+
+	dbxcli completion zsh > $(brew --prefix)/share/zsh/site-functions/_dbxcli
+
+You will need to start a new shell for this setup to take effect.
+
+
+```
+dbxcli completion zsh [flags]
+```
+
+### Options
+
+```
+  -h, --help              help for zsh
+      --no-descriptions   disable completion descriptions
+```
+
+### Options inherited from parent commands
+
+```
+      --as-member string   Member ID to perform action as
+      --output string      Output format: text, json (default "text")
+  -v, --verbose            Enable verbose logging
+```
+
+### SEE ALSO
+
+* [dbxcli completion](dbxcli_completion.md)	 - Generate the autocompletion script for the specified shell
+

docs/commands/dbxcli_cp.md

@@ -0,0 +1,28 @@
+<!-- Code generated by go run ./tools/gen-docs; DO NOT EDIT. -->
+
+## dbxcli cp
+
+Copy a file or folder to a different location in the user's Dropbox. If the source path is a folder all its contents will be copied.
+
+```
+dbxcli cp [flags] <source> [more sources] <target>
+```
+
+### Options
+
+```
+  -h, --help   help for cp
+```
+
+### Options inherited from parent commands
+
+```
+      --as-member string   Member ID to perform action as
+      --output string      Output format: text, json (default "text")
+  -v, --verbose            Enable verbose logging
+```
+
+### SEE ALSO
+
+* [dbxcli](dbxcli.md)	 - A command line tool for Dropbox users and team admins
+