Skip to content

docs: shell completion install instructions (E4) #27

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
lostmartian merged 1 commit into from
Aug 26, 2026
Merged

docs: shell completion install instructions (E4) #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,12 @@ Or using `uv`:
uv add agent-trajectory-diff
```

Enable tab-completion for the CLI (bash/zsh/fish/powershell):
```bash
agentdiff --install-completion
```
> Tip: for a global `agentdiff` command without activating a venv, use `uv tool install agent-trajectory-diff` — then completion works anywhere.

## Quickstart

### 0. No trace yet? Record one.
Expand Down
6 changes: 6 additions & 0 deletions website/docs/01-Getting Started/02-Quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,12 @@ directory for runnable end-to-end examples.

## Next steps

Tip: enable tab-completion for the CLI:

```bash
agentdiff --install-completion
```

- **Reading the Report** - what the metrics mean.
- **Regression Gates** - thresholds.
- **Ingestion Adapters** - formats you can load.
Loading