Clayzo CLI

Request code reviews from your terminal. The Clayzo CLI integrates with your Clayzo workspace to let you request reviews without leaving your development environment.

Installation

From npm (recommended)

npm install -g @clayzo/cli

From source

cd cli
npm install
npm run build
npm link

Quick Start

1. Login to Clayzo

   clayzo login

   This will display a 6-character code. Enter this code in the Clayzo app (web or desktop) to authenticate.

   The CLI will try to open the app automatically. If it doesn't, visit https://clayzo.app/cli-auth and enter the code manually.

2. Request a code review

   clayzo request-review

   This will:

   • Detect your current Git branch and repository
   • Show you a list of team members to select as reviewer
   • Send a review request that appears in their Clayzo inbox

Commands

Authentication

clayzo login

Authenticate with your Clayzo account using a device code. Works with both the web app and desktop app.

clayzo login

The CLI will display a 6-character code like ABC 123. Enter this code in:

• Desktop App: The app will open automatically (or visit Settings → CLI)
• Web App: Go to https://clayzo.app/cli-auth

Your credentials are stored securely in ~/.clayzo/.

clayzo logout

Clear stored credentials.

clayzo logout

clayzo whoami

Show current user and team information.

clayzo whoami

Review Requests

clayzo request-review (alias: clayzo rr)

Request a code review for your current branch.

# Interactive mode - prompts for reviewer
clayzo request-review

# Specify reviewer directly
clayzo request-review --reviewer "John Doe"
clayzo request-review -r [email protected]

# Specify branch (defaults to current branch)
clayzo request-review --branch feature/my-branch

# Add context message
clayzo request-review --message "Please focus on the API changes"

# Set priority (sev1-sev5, default: sev3)
clayzo request-review --priority sev2

# Combine options
clayzo rr -r "Jane" -m "Ready for final review" -p sev2

Options:

| Option | Alias | Description | |--------|-------|-------------| | --reviewer <name> | -r | Reviewer name, email, or GitHub username | | --branch <branch> | -b | Branch name (defaults to current Git branch) | | --message <msg> | -m | Context message for the reviewer | | --priority <level> | -p | Priority: sev1 (urgent) to sev5 (low), default: sev3 |

clayzo reviewers

List available reviewers in your current team.

clayzo reviewers

Team Management

clayzo teams

List all teams you belong to.

clayzo teams

clayzo switch-team [team]

Switch to a different team.

# Interactive selection
clayzo switch-team

# Switch by name or slug
clayzo switch-team "My Team"
clayzo switch-team my-team

Configuration

Configuration is stored in ~/.clayzo/config.json. You can also set environment variables:

| Variable | Description | |----------|-------------| | CLAYZO_CONVEX_URL | Override the Convex deployment URL | | CLAYZO_WEB_URL | Override the web app URL (for development) |

Examples

Typical Workflow

# Start your work on a feature branch
git checkout -b feature/new-api

# ... make your changes and commits ...
git add .
git commit -m "Add new API endpoints"

# Request a review when ready
clayzo rr -r "Jane" -m "New user API ready for review"

Quick Review Request

# One-liner with all options
clayzo rr -r john -m "ASAP please" -p sev1

Check Your Team

# See who's available
clayzo reviewers

# Output:
# Team: Acme Corp
# ─────────────────────────────────────────────────
#
# Owners
#   Jane Smith (you)
#     [email protected]
#
# Members
#   John Doe @johndoe
#     [email protected]
#   Alice Chen
#     [email protected]
#
# 2 reviewers available

Troubleshooting

"Not authenticated" error

Run clayzo login to authenticate.

"Not in a git repository" error

Make sure you're in a directory with a Git repository and it has a remote configured.

"No team selected" error

Run clayzo login again or clayzo switch-team to select a team.

Token expired

Run clayzo login to refresh your authentication.

Development

# Install dependencies
cd cli
npm install

# Build
npm run build

# Watch mode
npm run dev

# Link for local testing
npm link

# Now you can use `clayzo` command globally

Support

• Website: https://clayzo.app
• Documentation: https://docs.clayzo.app
• Issues: https://github.com/clayzo/codeagent/issues