Docs menu

Using KwikQA

Commands

analyze

$ npx kwikqa analyze [--report <path>] [--local] [--yes]

Diagnoses the failures in a Playwright JSON report.

OptionEffect
--report <path>Read this report instead of looking in the default locations.
--localBuild the evidence summary on your machine only. Nothing is sent, and no account is needed.
--yesApprove the request preview without asking. Needed when there is no terminal, as in CI.

fix

$ npx kwikqa fix [--report <path>] [--propose-only] [--retry]

Proposes a repair for a test-support cause, shows the diff and validation commands, and applies the patch if you approve. It needs kwikqa.config.json and an interactive terminal, because a person approves every patch.

OptionEffect
--report <path>Repair from this report.
--propose-onlyStop after showing the proposal. Nothing is applied.
--retryAfter a failed validation, re-diagnose from the validation evidence and propose one revised patch. Free.

validate

$ npx kwikqa validate

Runs the validation plan you approved with the patch. If every required check passes, the patch is kept. Otherwise it is rolled back. It sends nothing and counts nothing.

Account commands

CommandWhat it does
npx kwikqa initPropose and write kwikqa.config.json, and offer to ignore .kwikqa/.
npx kwikqa loginSign in with GitHub's device flow.
npx kwikqa statusShow your plan, this month's usage, and when it resets.
npx kwikqa upgrade [plan]List plans, or get a checkout link for pro, team, byo, or byo-team. --annual bills yearly (two months free); --seats <n> sets seats on team plans (3 or more). If you already pay, it points you to Billing in the dashboard instead.
npx kwikqa billingOpen Paddle's customer portal to update your card or download invoices.
npx kwikqa logoutRevoke this machine's token and remove it.
npx kwikqa --versionPrint the version.

Environment variables

VariableUsed for
KWIKQA_TOKENA CLI or CI token, used instead of the stored sign-in. Create one in the dashboard.
OPENROUTER_API_KEYYour OpenRouter key, on the BYOK plans.
KWIKQA_DIAGNOSIS_MODEL, KWIKQA_REPAIR_MODELYour own model routes on the BYOK plans, as author/model@provider.
PLAYWRIGHT_JSON_OUTPUT_NAMEWhere to find the report, if set.
KWIKQA_CONFIG_DIRWhere the CLI keeps its sign-in. Defaults to ~/.config/kwikqa, or %APPDATA%\kwikqa on Windows.

Exit codes

CodeMeaning
0Success, or an informative result such as diagnosed or inconclusive.
1The repair or validation did not succeed: repair-failed, validation-unavailable, or operation-failed.
2Usage error: an unknown option, or a command that needs a terminal.
3Sign-in, plan, or usage-limit problem.