Skip to content

docs(#23,#26): README — apc --version, shell completion, doctor command #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
FZ2000 merged 6 commits into from
Mar 8, 2026
Merged

docs(#23,#26): README — apc --version, shell completion, doctor command #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
42d2969
docs(#20,#23,#26): README updates — version, shell completion, doctor
forge-fz2000 Mar 8, 2026
bf7b5a9
docs: remove apc doctor reference — command does not exist
forge-fz2000 Mar 8, 2026
ed2ed86
docs: remove --all-sources-mcp — flag does not exist in codebase
forge-fz2000 Mar 8, 2026
1d05937
docs: remove --target/-t from apc install docs (flag removed in #72)
forge-fz2000 Mar 8, 2026
12fc525
docs: remove --dry-run from collect (doesn't exist); drop uv.lock fro…
forge-fz2000 Mar 8, 2026
98462a2
Merge branch 'main' into docs/issue-20-23-26-readme-version-completion
FZ2000 Mar 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 26 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,14 @@ apc configure

## Command Reference

### CLI Basics

```bash
# Check the installed version
apc --version
# apc, version 0.1.1
```

### Core Workflow

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

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

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

## Shell Completion

APC is built on [Click](https://click.palletsprojects.com/) which has built-in shell completion support.

```bash
# Bash — add to ~/.bashrc
echo 'eval "$(_APC_COMPLETE=bash_source apc)"' >> ~/.bashrc

# Zsh — add to ~/.zshrc
echo 'eval "$(_APC_COMPLETE=zsh_source apc)"' >> ~/.zshrc

# Fish — add to ~/.config/fish/completions/apc.fish
echo 'eval (env _APC_COMPLETE=fish_source apc)' >> ~/.config/fish/completions/apc.fish
```

Reload your shell (`source ~/.bashrc` / `source ~/.zshrc`) after adding the line.

## Development

```bash
Expand Down
9 changes: 8 additions & 1 deletion src/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,16 @@
warning,
)

try:
from importlib.metadata import version as _pkg_version

_apc_version = _pkg_version("apc-cli")
except Exception:
_apc_version = "0.1.1"


@click.group()
@click.version_option(version="0.1.1", prog_name="apc")
@click.version_option(version=_apc_version, prog_name="apc")
def cli():
"""apc — AI Personal Context manager.

Expand Down