Skip to content

docs: update manual authentication commands - #342

Open
xujiantop-crypto wants to merge 1 commit into
TestSprite:mainfrom
xujiantop-crypto:docs/update-manual-auth-commands
Open

docs: update manual authentication commands#342
xujiantop-crypto wants to merge 1 commit into
TestSprite:mainfrom
xujiantop-crypto:docs/update-manual-auth-commands

Conversation

@xujiantop-crypto

@xujiantop-crypto xujiantop-crypto commented Sep 12, 2026

Copy link
Copy Markdown

What does this PR do?

Updates the manual authentication walkthrough to use the current, visible CLI commands:

  • testsprite setup --no-agent configures credentials without installing an agent skill.
  • testsprite auth status verifies the active identity and profile.

This keeps the manual, step-by-step flow intact while avoiding hidden deprecated aliases and their deprecation notices.

Related issue

N/A - documentation-only correction; the contribution guide does not require an issue for doc fixes.

Type of change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that changes existing behavior)
  • Documentation only
  • Build / CI / chore

Checklist

  • PR targets the main branch.
  • Commits follow Conventional Commits.
  • npm run lint and npm run format:check pass.
  • npm run typecheck passes.
  • npm test is not required because runtime behavior is unchanged.
  • New behavior tests are not applicable because runtime behavior is unchanged.
  • No secrets, API keys, internal endpoints, or personal data are included.
  • User-facing changes are reflected in DOCUMENTATION.md.

Notes for reviewers

npm run lint completes with zero errors; its existing warnings are unrelated to this documentation-only change. npm run format:check and npm run typecheck pass.

Summary by CodeRabbit

  • Documentation
    • Updated authentication setup instructions to use the current setup commands.
    • Added the --no-agent option to environment-based setup guidance.
    • Renamed the authentication verification command to testsprite auth status.

@coderabbitai

coderabbitai Bot commented Sep 12, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 9da180a9-5834-4a75-9ba2-e558eac7fa6d

📥 Commits

Reviewing files that changed from the base of the PR and between 125872f and 66523b2.

📒 Files selected for processing (1)
  • DOCUMENTATION.md

Included review availability: Your plan provides up to 8 included reviews per hour; 7 remain after this review.


Walkthrough

The authentication documentation now uses testsprite setup --no-agent, adds --no-agent to environment-based setup, and uses testsprite auth status for verification.

Changes

Authentication documentation

Layer / File(s) Summary
Update authentication command examples
DOCUMENTATION.md
The documentation replaces the interactive configuration command, updates the environment-based setup command, and renames the verification command.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 66523

The authentication walkthrough now documents the current supported commands with no merge-blocking risk identified.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the documentation change to the manual authentication commands.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant