Getting Started with the Certyn CLI

The Certyn CLI puts your entire QA workflow in the terminal. Run quality gates, triage failures, ask the AI advisor questions, and manage test cases — all without leaving your editor.

Install

One command on macOS or Linux:

curl -fsSL https://certyn.io/install | bash

On Windows (PowerShell):

iex "& { $(iwr -useb https://certyn.io/install.ps1) }"

Verify it worked:

certyn --version
certyn doctor

Authenticate

For local development, use browser-based login:

certyn login

This opens Auth0's device flow in your browser. Once authenticated, your session is stored securely in the OS keychain.

For CI/CD, use an API key instead:

export CERTYN_API_KEY=sk-...

Run Your First Quality Gate

The core command is certyn run. It triggers a test process and waits for results:

certyn run smoke --project my-app --environment staging

You'll see real-time progress:

▶ Process: smoke · environment: staging
  ✓ Run created              ok        2s
  ✓ 5 executions completed   ok       45s
  ✓ 0 failed                 ok       45s
✓ Run passed · 45s

The CLI exits with code 0 for pass and 1 for failure — perfect for CI gates.

Key Commands

Run quality gates

certyn run smoke --project my-app --environment staging
certyn run regression --project my-app --environment production

Ask the AI advisor

Get project-aware answers about your test results, flaky tests, or what to test next:

certyn ask "Why did the smoke run fail?" --project my-app
certyn ask "Which tests are flaky this week?" --project my-app

Diagnose failures

When a test fails, dig into the execution details:

certyn diagnose --project my-app <execution-id>

This shows the full agent conversation, tool calls, and where things went wrong.

Manage test cases

certyn tests list --project my-app
certyn tests overview --project my-app
certyn tests flaky --project my-app --threshold 0.20

Triage issues

certyn issues list --project my-app --activity attention --severity critical
certyn issues retest --project my-app <issue-id>

Profiles

Organize your configuration by environment:

certyn config set --profile dev --api-url https://api.certyn.io --project my-app
certyn config set --profile staging --project my-app --environment staging
certyn config use dev

Switch between profiles to target different projects or environments without retyping flags.

JSON Output

Add --json to any command for machine-readable output:

certyn run smoke --project my-app --environment staging --json

The JSON output includes full diagnostics when runs fail — useful for automated analysis or piping into other tools.

Exit Codes

Code	Meaning
0	Success / gate passed
1	Gate failed or cancelled
2	Usage or config error
3	Auth / permission error
5	Timeout

Tips

• Use certyn doctor to verify your setup and connectivity
• Set CERTYN_PROJECT as an environment variable to skip --project on every command
• Pipe --json output to jq for custom reporting
• Use certyn ask as part of your debugging workflow — it has access to your project's full test history