diff --git a/docs/cli/generate.md b/docs/cli/generate.md deleted file mode 100644 index 7025033..0000000 --- a/docs/cli/generate.md +++ /dev/null @@ -1,12 +0,0 @@ -# `usage generate` - -- **Usage**: `usage generate ` -- **Aliases**: `g` -- **Source code**: [`cli/src/cli/generate.rs`](https://github.com/jdx/usage/blob/main/cli/src/cli/generate.rs) - -## Subcommands - -- [`usage generate completion [FLAGS] `](/generate/completion.md) -- [`usage generate fig [FLAGS]`](/generate/fig.md) -- [`usage generate json [-f --file ] [--spec ]`](/generate/json.md) -- [`usage generate markdown `](/generate/markdown.md) diff --git a/docs/cli/generate/completion.md b/docs/cli/generate/completion.md deleted file mode 100644 index 7a33c1b..0000000 --- a/docs/cli/generate/completion.md +++ /dev/null @@ -1,33 +0,0 @@ -# `usage generate completion` - -- **Usage**: `usage generate completion [FLAGS] ` -- **Aliases**: `c` -- **Source code**: [`cli/src/cli/generate/completion.rs`](https://github.com/jdx/usage/blob/main/cli/src/cli/generate/completion.rs) - -## Arguments - -### `` - -**Choices:** - -- `bash` -- `fish` -- `zsh` - -### `` - -The CLI which we're generates completions for - -## Flags - -### `--cache-key ` - -A cache key to use for storing the results of calling the CLI with --usage-cmd - -### `-f --file ` - -A .usage.kdl spec file to use for generating completions - -### `--usage-cmd ` - -A command which generates a usage spec e.g.: `mycli --usage` or `mycli completion usage` Defaults to "$bin --usage" diff --git a/docs/cli/generate/fig.md b/docs/cli/generate/fig.md deleted file mode 100644 index b2dbbb3..0000000 --- a/docs/cli/generate/fig.md +++ /dev/null @@ -1,18 +0,0 @@ -# `usage generate fig` - -- **Usage**: `usage generate fig [FLAGS]` -- **Source code**: [`cli/src/cli/generate/fig.rs`](https://github.com/jdx/usage/blob/main/cli/src/cli/generate/fig.rs) - -## Flags - -### `-f --file ` - -A usage spec taken in as a file - -### `--spec ` - -raw string spec input - -### `--out-file ` - -File on where to save the generated Fig spec diff --git a/docs/cli/generate/json.md b/docs/cli/generate/json.md deleted file mode 100644 index fa8bd19..0000000 --- a/docs/cli/generate/json.md +++ /dev/null @@ -1,16 +0,0 @@ -# `usage generate json` - -- **Usage**: `usage generate json [-f --file ] [--spec ]` -- **Source code**: [`cli/src/cli/generate/json.rs`](https://github.com/jdx/usage/blob/main/cli/src/cli/generate/json.rs) - -Outputs a usage spec in json format - -## Flags - -### `-f --file ` - -A usage spec taken in as a file - -### `--spec ` - -raw string spec input diff --git a/docs/cli/generate/markdown.md b/docs/cli/generate/markdown.md deleted file mode 100644 index 364e8c3..0000000 --- a/docs/cli/generate/markdown.md +++ /dev/null @@ -1,29 +0,0 @@ -# `usage generate markdown` - -- **Usage**: `usage generate markdown ` -- **Aliases**: `md` -- **Source code**: [`cli/src/cli/generate/markdown.rs`](https://github.com/jdx/usage/blob/main/cli/src/cli/generate/markdown.rs) - -## Flags - -### `-f --file ` - -A usage spec taken in as a file - -### `-m --multi` - -Render each subcommand as a separate markdown file - -### `--url-prefix ` - -Prefix to add to all URLs - -### `--html-encode` - -Escape HTML in markdown - -### `--out-dir ` - -Output markdown files to this directory - -### `--out-file ` diff --git a/docs/cli/reference/commands.json b/docs/cli/reference/commands.json index 5f686d4..0579ff6 100644 --- a/docs/cli/reference/commands.json +++ b/docs/cli/reference/commands.json @@ -6,7 +6,9 @@ "usage": "[--usage-spec] [COMPLETIONS] ", "subcommands": { "bash": { - "full_cmd": ["bash"], + "full_cmd": [ + "bash" + ], "usage": "bash [-h] [--help]