From 62d7c4c0e9b459a59258e0a64b63731ce6f0b1f3 Mon Sep 17 00:00:00 2001 From: Sohan Kshirsagar Date: Thu, 23 Apr 2026 17:40:30 -0700 Subject: [PATCH] docs: add Tusk Review to README and CLI overview --- README.md | 15 ++++++++++++++- cmd/short_docs/overview.md | 4 +++- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9174d55e..fc0b3626 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 --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. diff --git a/cmd/short_docs/overview.md b/cmd/short_docs/overview.md index feede5f9..2d75c1ff 100644 --- a/cmd/short_docs/overview.md +++ b/cmd/short_docs/overview.md @@ -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