Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion cli/command-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ Run `autter help` for the command list installed on your machine.
| `autter config set <key> <value>` | Set a value |
| `autter config --add <key> <value>` | Add an array item or object entry |
| `autter config unset <key>` | Remove a value and restore its default |
| `autter debug` | Print support diagnostics |
| `autter doctor [--json]` | Validate the setup end-to-end; exits non-zero when a check fails |
| `autter debug` | Print the full support diagnostics report |
| `autter bg status` | Check the background service |
| `autter bg restart` | Restart the background service |
| `autter bg tail -f` | Follow background-service logs |
Expand Down
2 changes: 1 addition & 1 deletion cli/copilot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Autter works with GitHub Copilot by recording the edits Copilot makes and attach
## After installation

```bash
autter debug
autter doctor
autter stats HEAD
autter blame src/services/review.ts
```
Expand Down
2 changes: 1 addition & 1 deletion cli/cursor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Autter works with Cursor by recording checkpoints around the edits Cursor makes
## Verify the result

```bash
autter debug
autter doctor
autter status
autter stats HEAD
```
Expand Down
4 changes: 2 additions & 2 deletions cli/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -93,12 +93,12 @@ The installer asks whether you want local-only or connected mode.

```bash
autter --version
autter debug
autter doctor
autter whoami
```

- `autter --version` prints the installed version.
- `autter debug` checks the installation and integrations.
- `autter doctor` validates the installation end-to-end, including a test checkpoint, and prints a fix for every failed check.
- `autter whoami` shows whether the CLI is connected.

## Verify an agent integration
Expand Down
4 changes: 2 additions & 2 deletions cli/performance-faqs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ If something feels slow, check the specific command first:
- `autter status` inspects the current working tree
- `autter stats` walks commit history for the range you give it
- `autter blame` reads attribution for one file
- `autter debug` checks the installation and integrations
- `autter doctor` runs end-to-end setup checks, so a few seconds is expected

## What runs locally

Expand Down Expand Up @@ -55,7 +55,7 @@ Use narrower ranges and specific files when you can. That gives you the same ans
If Autter feels unusually slow, run:

```bash
autter debug
autter doctor
autter bg status
```

Expand Down
24 changes: 21 additions & 3 deletions cli/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,28 @@ description: "Diagnose missing attribution, background-service issues, login fai
icon: "wrench"
---

Start with Autter's built-in diagnostics:
Start with Autter's built-in setup validation:

```bash
autter doctor
```

## Validate the setup with `autter doctor`

`autter doctor` checks the installation end-to-end and prints a fix line for every failed check. It verifies:

- The Git version and the Autter configuration file
- The repository filters that decide whether the current repository is tracked
- The background service and its Git event capture
- A real checkpoint round-trip, from checkpoint through commit to line-level attribution
- Integration status for the coding agents detected on the machine
- Login state, plus platform reachability in connected mode

The command exits `0` when no check fails and `1` otherwise, so you can use it in scripts. Add `--json` for a machine-readable report.

If every check passes but something still looks wrong, gather more context:

```bash
autter debug
autter bg status
autter whoami
autter config
Expand Down Expand Up @@ -101,7 +119,7 @@ autter config set telemetry_oss off

## Get support diagnostics

Run `autter debug` and review the output before sharing it. Remove repository paths, identities, tokens, and other sensitive values.
Run `autter doctor` first and apply the fixes it prints. When you need a full report to share, run `autter debug` and review the output before sharing it. Remove repository paths, identities, tokens, and other sensitive values.

<Card title="Open a GitHub issue" icon="github" href="https://github.com/Autter-dev/autter-cli/issues">
Report reproducible open source CLI problems.
Expand Down
4 changes: 2 additions & 2 deletions cli/windsurf.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Autter works with Windsurf by capturing the agent's edits as checkpoints and wri
- Automatic authorship tracking for Windsurf edits
- `autter blame` for file-level review
- `autter stats` for commit and range summaries
- `autter debug` when you need setup diagnostics
- `autter doctor` when you need setup validation

## Set up Windsurf

Expand All @@ -37,7 +37,7 @@ Autter works with Windsurf by capturing the agent's edits as checkpoints and wri
## Verify the flow

```bash
autter debug
autter doctor
autter stats HEAD
autter blame src/service.ts
```
Expand Down