Skip to content

Commit 10c054c

Browse files
authored
Merge branch 'main' into feat/issue-24-25-dry-run
2 parents 4774389 + b3c56db commit 10c054c

3 files changed

Lines changed: 36 additions & 3 deletions

File tree

.github/CODEOWNERS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# All files require FZ2000 approval
2+
* @FZ2000

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,14 @@ apc configure
9393

9494
## Command Reference
9595

96+
### CLI Basics
97+
98+
```bash
99+
# Check the installed version
100+
apc --version
101+
# apc, version 0.1.1
102+
```
103+
96104
### Core Workflow
97105

98106
| Command | Description |
@@ -117,7 +125,7 @@ apc configure
117125
| `--all` | Apply to all detected tools without prompting |
118126
| `--no-memory` | Skip memory entries |
119127
| `--override-mcp` | Replace existing MCP servers instead of merging |
120-
| `--dry-run` | Show what would be applied without writing |
128+
| `--dry-run` | Show files that would be written without writing |
121129
| `--yes`, `-y` | Skip confirmation prompts |
122130

123131
### Skills
@@ -142,7 +150,6 @@ apc configure
142150
| Flag | Description |
143151
|------|-------------|
144152
| `--skill`, `-s` | Skill name(s) to install (repeatable, or `'*'` for all) |
145-
| `--target`, `-t` | Target tool(s) to install to (repeatable, or `'*'` for all detected) |
146153
| `--branch` | Git branch to fetch from (default: `main`) |
147154
| `--list` | List available skills without installing |
148155
| `--yes`, `-y` | Skip confirmation prompts |
@@ -260,6 +267,23 @@ apc configure --provider custom --base-url "http://localhost:11434/v1" \
260267

261268
**Supported LLM providers:** Anthropic, OpenAI, Google Gemini, Qwen (Alibaba), GLM (Zhipu), MiniMax, Kimi (Moonshot), and any OpenAI-compatible or Anthropic-compatible endpoint.
262269

270+
## Shell Completion
271+
272+
APC is built on [Click](https://click.palletsprojects.com/) which has built-in shell completion support.
273+
274+
```bash
275+
# Bash — add to ~/.bashrc
276+
echo 'eval "$(_APC_COMPLETE=bash_source apc)"' >> ~/.bashrc
277+
278+
# Zsh — add to ~/.zshrc
279+
echo 'eval "$(_APC_COMPLETE=zsh_source apc)"' >> ~/.zshrc
280+
281+
# Fish — add to ~/.config/fish/completions/apc.fish
282+
echo 'eval (env _APC_COMPLETE=fish_source apc)' >> ~/.config/fish/completions/apc.fish
283+
```
284+
285+
Reload your shell (`source ~/.bashrc` / `source ~/.zshrc`) after adding the line.
286+
263287
## Development
264288

265289
```bash

src/main.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,16 @@
1919
warning,
2020
)
2121

22+
try:
23+
from importlib.metadata import version as _pkg_version
24+
25+
_apc_version = _pkg_version("apc-cli")
26+
except Exception:
27+
_apc_version = "0.1.1"
28+
2229

2330
@click.group()
24-
@click.version_option(version="0.1.1", prog_name="apc")
31+
@click.version_option(version=_apc_version, prog_name="apc")
2532
def cli():
2633
"""apc — AI Personal Context manager.
2734

0 commit comments

Comments
 (0)