apunkt/ktx
1
0
Fork 0
mirror of https://github.com/Kaelio/ktx.git synced 2026-07-01 08:59:39 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: improve CLI flags table readability (#323)

Browse source 
* docs(readme): improve CLI flags table readability

* feat: add more details

* docs(cli-reference): keep table default markers consistent

Revert the "no default" markers for --target and --no-input from em
dash back to the plain hyphen used in every other CLI-reference table,
and drop the code-font styling on the descriptive "ktx project dir"
default so it reads as text rather than a literal value.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

---------

Co-authored-by: Luca Martial <lucamrtl@gmail.com>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
Bittu kumar 2026-06-29 04:38:47 +05:30 • committed by GitHub
parent b0dca62c0e
commit 50afcae9f4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 9 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs-site/content/docs/cli-reference/ktx-setup.mdx
View file

@ -29,10 +29,18 @@ below.
| `--agents` | Install agent configuration and rules only | `false` | | `--agents` | Install agent configuration and rules only | `false` |
| `--target <target>` | Agent target: `claude-code`, `claude-desktop`, `codex`, `cursor`, `opencode`, or `universal` | - | | `--target <target>` | Agent target: `claude-code`, `claude-desktop`, `codex`, `cursor`, `opencode`, or `universal` | - |
| `--global` | Install agent integration into the global target scope for `claude-code` or `codex` | `false` | | `--global` | Install agent integration into the global target scope for `claude-code` or `codex` | `false` |
| `--install-dir <path>` | Directory to install project-scoped agent config into. Defaults to the ktx project directory; resolved against the current directory and created if missing. Use it to install `.claude/`, `.mcp.json`, and rules where you open your agent (e.g. `--install-dir .`). Mutually exclusive with `--global` and `--local` | ktx project dir | | `--install-dir <path>` | Install project-scoped agent configuration | ktx project dir |
| `--yes` | Accept project creation and runtime install defaults where setup asks for confirmation | `false` | | `--yes` | Accept project creation and runtime install defaults where setup asks for confirmation | `false` |
| `--no-input` | Disable interactive terminal input | - | | `--no-input` | Disable interactive terminal input | - |
> **`--install-dir <path>`**
>
> Installs project-scoped agent configuration into the specified directory.
> The path is resolved against the current directory and created if it doesn't
> exist. Use it to install `.claude/`, `.mcp.json`, and rules where you open
> your agent (for example, `--install-dir .`). This option is mutually exclusive
> with `--global` and `--local`.
Use the global `--project-dir <path>` option when setup should target a Use the global `--project-dir <path>` option when setup should target a
specific directory. specific directory.