Skip to content

docs: add Tusk Review to README and CLI overview #227

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
sohankshirsagar merged 1 commit into from
Apr 24, 2026
Merged

docs: add Tusk Review to README and CLI overview #227

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
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@
> [!IMPORTANT]
> Previously used `tusk-drift-cli`? This repo has moved to `tusk-cli`, and older installed CLI versions may not auto-update across the rename. Please reinstall using the current install instructions below.

The Tusk CLI provides tools for automated testing workflows. It supports two products:
The Tusk CLI provides tools for automated testing workflows. It supports three products:

- **[Tusk Drift](docs/drift/)** - Live traffic record/replay as API tests
- **[Tusk Review](docs/review/)** - AI code review on your local working tree
- **[Tusk Unit](docs/unit/)** - Automated unit tests

## Tusk Drift — API Record/Replay Testing
Expand All @@ -34,6 +35,18 @@ tusk drift run --cloud # Run against Tusk Drift Cloud

[Get started with Tusk Drift →](docs/drift/)

## Tusk Review — AI Code Review

Run Tusk's AI code review against your local working tree — including uncommitted and untracked changes — before you push or open a pull request. Results print to your terminal; nothing is posted to GitHub or GitLab.

```bash
tusk review run # Review current working tree
tusk review run --no-poll # Submit and exit with run id
tusk review status <run-id> --watch # Check a previously submitted run
```

[Get started with Tusk Review →](docs/review/)

## Tusk Unit — Automated Unit Tests

View, review, and apply unit tests from Tusk directly from your terminal or automation pipeline.
Expand Down
4 changes: 3 additions & 1 deletion cmd/short_docs/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# Tusk CLI

The Tusk CLI provides tools for automated testing workflows across two products:
The Tusk CLI provides tools for automated testing workflows across three products:

- **Tusk Drift** records real API traffic and replays it as deterministic API tests locally or in CI/CD.
- **Tusk Review** runs Tusk's AI code review against your local working tree before you push.
- **Tusk Unit** lets you inspect, review, and apply unit tests generated by Tusk.

## Common starting points

- `tusk drift setup` to configure Tusk Drift for a service
- `tusk drift run` to replay recorded traces
- `tusk review run` to review your local working tree
- `tusk unit latest-run` to inspect the latest unit test generation run for your branch
- `tusk auth login` to authenticate with Tusk Cloud

Expand Down
Loading