Skip to content

Commit 37a5043

Browse files
committed
docs: add shell completion instructions to README
1 parent f0f4c33 commit 37a5043

1 file changed

Lines changed: 26 additions & 6 deletions

File tree

README.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -60,12 +60,32 @@ CAM offers a rich set of subcommands for advanced management.
6060

6161
### Main Commands
6262

63-
| Command | Description |
64-
| :--- | :--- |
65-
| `cam launch` | Open the interactive menu or launch specific tools directly (e.g., `cam launch claude`). |
66-
| `cam doctor` | specific Run diagnostic checks on your environment, API keys, and configuration. |
67-
| `cam version` | Display the current version of CAM. |
68-
| `cam upgrade` | Update underlying tools (like `claude-engineer`, `aider`, etc.) to their latest versions. |
63+
| Command | Alias | Description |
64+
| :--- | :--- | :--- |
65+
| `cam launch` | `l` | Open the interactive menu or launch specific tools directly (e.g., `cam l claude`). |
66+
| `cam doctor` | `d` | Run diagnostic checks on your environment, API keys, and configuration. |
67+
| `cam version` | `v` | Display the current version of CAM. |
68+
| `cam upgrade` | `u` | Update underlying tools (like `claude-engineer`, `aider`, etc.) to their latest versions. |
69+
| `cam install` | `i` | Alias for `upgrade`. Installs or updates tools. |
70+
| `cam uninstall` | `un` | Uninstall CLI tools and optionally backup/remove their configuration files. |
71+
| `cam config` | `cf` | Manage configuration files. Use `cam config list` to see all config paths. |
72+
| `cam completion` | `c` | Generate shell completion scripts for Bash or Zsh. |
73+
74+
### Shell Completion
75+
76+
Enable tab completion for `cam` commands in your shell.
77+
78+
**Bash:**
79+
```bash
80+
# Add to ~/.bashrc
81+
source <(cam completion bash)
82+
```
83+
84+
**Zsh:**
85+
```zsh
86+
# Add to ~/.zshrc
87+
source <(cam completion zsh)
88+
```
6989

7090
### Prompt Management (`cam prompt`)
7191

0 commit comments

Comments
 (0)