Skip to main content

Use the CLI

Use this guide to install and authenticate the Tarnished CLI.

Install the CLI

Recommended path:

uv tool install tarnished-cli

Homebrew convenience path:

brew tap markoonakic/tap
brew install tarnished-cli

Authenticate

Create or rotate an API key in the Tarnished web app first, then initialize the CLI locally:

tarnished auth init --api-key 'your-api-key'

Verify the local setup:

tarnished auth doctor
tarnished auth whoami

Current command areas

The CLI currently includes command groups for:

  • auth
  • admin
  • applications
  • job leads
  • profile
  • statuses
  • round types
  • rounds
  • user settings
  • preferences
  • export
  • import
  • dashboard
  • analytics

Important behavior

The CLI is intentionally API-key-first.

It does not manage remote API keys on your behalf. The web app remains the source of truth for API key creation, rotation, and revocation.