Skip to content

feat: document the setup command in the complete CLI reference #645

Open

Description

@WUWTest

What problem are you trying to solve?

DOCUMENTATION.md is presented as the complete CLI command reference, but its command reference starts with read commands and omits testsprite setup. Users currently have to piece together setup behavior and flags from the README and --help, especially for non-interactive authentication, --skip-if-configured, dry runs, profiles, and agent selection.

Verified against commit a18d37c.

Proposed solution

Add a focused Setup (setup) section to DOCUMENTATION.md and its table of contents. Cover interactive and non-interactive examples, credential-source precedence, idempotent reruns, profiles, agent-install flags, dry-run behavior, and success output.

PR #644 contains the documentation-only implementation.

Alternatives considered

Expanding the README further would make the overview too detailed, while relying only on testsprite setup --help leaves the complete browsable reference incomplete. A dedicated section keeps the README concise and the reference complete.

Scope check

  • This request is about the CLI itself (commands, flags, output, ergonomics), not server-side product behavior.
  • I have searched existing issues and this is not a duplicate.

Activity

  1. WUWTest commented on Oct 22, 2026

    @WUWTest
    Author

    /assign

    The docs-only implementation is ready in #644.

  2. testsprite-hob commented on Oct 22, 2026

    @testsprite-hob

    Thanks for the interest, @WUWTest! This issue hasn't been accepted for implementation yet — see the triage comment (a maintainer will label it accepted once it is). Feel free to check back, or ping us on Discord if it's been quiet.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestneeds-triageNew issue/PR awaiting first triage

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions