Document the autter doctor setup validation command - #8
Merged
Conversation
The CLI gained `autter doctor` (autter-cli #51): end-to-end setup validation with a fix line per failed check, exit code 1 on failure, and a `--json` report. Update the docs to make it the first diagnostic step: - Troubleshooting: lead with `autter doctor` and describe what it checks; keep `autter debug` as the full support report to share - Command reference: add the doctor row, clarify the debug row - Install: verify the installation with doctor instead of debug - Performance FAQs and agent pages (Cursor, GitHub Copilot, Windsurf): point setup verification at doctor Generated-By: PostHog Desktop Task-Id: c84ac9ce-31cc-4e70-8451-62857be00f1c
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Documents the new
autter doctorcommand shipped in autter-cli #51: end-to-end setup validation with a fix line for every failed check, exit0/1semantics, and a--jsonreport.Changes
cli/troubleshooting.mdx— leads withautter doctorand adds a "Validate the setup withautter doctor" section describing the checks in user-facing terms (Git version and config, repository filters, background service and Git event capture, a real checkpoint round-trip, coding-agent integration status, login state and platform reachability).autter debugstays as the full support report to review before sharing.cli/command-reference.mdx— adds theautter doctor [--json]row under Configuration and maintenance and clarifies theautter debugrow ("full support diagnostics report") to distinguish the two.cli/install.mdx— "Verify the installation" now usesautter doctor(it validates end-to-end, including a test checkpoint) instead ofautter debug.cli/performance-faqs.mdx— the self-check bullet and "When to investigate further" block point at doctor.cli/cursor.mdx,cli/copilot.mdx,cli/windsurf.mdx— post-install verification blocks useautter doctor; Windsurf's "What you get" bullet updated to "setup validation".No navigation, page, or link changes, so
docs.jsonis untouched.Notes
mint validate/mint broken-linkswere not run locally (Mintlify CLI is not installed on this machine); changes are content-only with no new links or pages.Created with PostHog Desktop