Docs menu

Account

Account and tokens

Signing in

  • Personal accounts (Hobby, Pro, and BYOK) sign in with GitHub, on the website and in the CLI.
  • Company accounts (Teams, BYOK Teams, Enterprise, and BYOK Enterprise) sign in with the work email their company invited. On the sign-in page, enter the address and then the 6-digit code KwikQA emails to it. A code works once, for 10 minutes, and stops working after 5 wrong tries. On the Enterprise plans, a company with single sign-on signs in through its identity provider instead: choose Continue with SSO.

npx kwikqa login shows a code and opens kwikqa.com/device in your browser with it filled in (0.5.0; earlier versions print the address), where you approve the code while signed in to the website. If you're in more than one team, you choose there which team the CLI counts for.

Overview

Shows your plan, this month's analyses and fixes against their limits and when they reset, your totals for each of the last 6 months, and your requests: when each ran, which model answered, whether it succeeded, and whether it counted. The requests are listed newest first, 10 to a page, back as far as the service keeps them (13 months), and can be narrowed to analyses or fixes, and to completed or failed requests. In a company account, the meters show the company's shared pool, and Your teams shows each of your teams' usage against its cap.

Company accounts

The team plans belong to a company account: an organization with its own admins, teams, and one usage pool. Everyone's CLI and CI tokens draw from the pool, and npx kwikqa status shows the company's plan and usage. To start one, open Start a company account, enter the company's name and your work email, and confirm the code; you become its first admin, and choose its plan in Billing. A company account that isn't paid for within 7 days is deleted.

Who can do what

CanAdminTeam managerMember
Use the plan from the CLI, CI, and dashboardYesYesYes
See usageEveryone'sTheir teams', by personTheir own, and their teams' totals
Invite people by work emailInto the company or any teamInto their teams, as membersNo
Add or remove people in a team, and make managersAny teamTheir teamsNo
Create CI tokensFor the company or any teamFor their teamsNo
Create teams and set capsYesNoNo
Suspend or restore people, and change rolesYesNoNo
Billing, plan, seats, renaming, and deleting the accountYesNoNo
Insights settings, and the audit log on Enterprise and BYOK EnterpriseYesNoNo

Admins work on the Organization page, whose tabs hold its people, invitations, teams, CI tokens, single sign-on, audit log, and settings; a long list there can be searched and filtered, such as people by role, status, or team. A team's managers open their team from Your teams on the Overview. An account always keeps at least one active admin. Membership needs no seat: a seat is an active committer, a person whose pull request ran KwikQA in CI during the month, so anyone who reads the dashboard or runs KwikQA locally can join. A company account has at most 500 people, counting pending invitations. Plans and usage explains seats.

Invitations

An invitation goes to a work email, with a role and, optionally, a team and a team role. The person signs in at the sign-in page with that address, and joins as invited. An invitation can be re-sent once an hour, and revoked until it's used. With single sign-on on, invitations stop: people join by signing in through it.

A company account holds up to 500 people and open invitations together; suspended people count until they're removed. At that size, a new invitation, or a first sign-in through single sign-on, is refused until an admin revokes an invitation or removes someone. Write to support@kwikqa.com if you need more.

Teams and caps

Every request counts for a team, through its token: a team's CI token counts for its team, and a CLI sign-in counts for the team chosen at kwikqa.com/device. Someone in one team counts for it automatically. A request through any other token counts for no team.

The pool is the company's, and a team without a cap simply draws on it. An admin can give a team a monthly cap on analyses, fixes, or both: a request that would pass the cap is refused with a message naming the team, and the team's managers, or the admins if it has none, get one email when it reaches 80%. Caps reset with the pool, at 00:00 UTC on the first day of each month. Deleting a team revokes its CI tokens; its people stay in the company, and its past requests stay in the company's history.

Suspending and leaving

A company manages its people's accounts, so only its admins remove someone. Suspending a person signs them out everywhere at once and revokes their own tokens; CI tokens they created for the company or a team keep working. An admin can restore them within 30 days, after which the account is erased. The audit log keeps their work email for the rest of its 400 days.

Result counts

From kwikqa 0.6.0, the CLI reports each analysis, fix, validation, and fix pull request to KwikQA as codes and counts, never test names or text; Data and privacy lists them. It's on by default. Anyone can turn it off for themselves on the Account page, and a company's admins for everyone on the Organization page's Settings tab.

Insights

Insights are off until an admin turns them on from the Insights page. While they're on, every CLI in the organization shares, after each command:

  • analyze: the name, file, and project (Playwright project or WebdriverIO browser) of each failing or flaky test, the test framework, and the result;
  • fix: the test being repaired, whether the patch was applied, declined, or abstained, and how many lines it changed;
  • validate: whether the repair held or was rolled back.

Nothing else: no evidence, source code, diffs, or error messages, and nothing at all from analyze --local. The Insights page shows everyone in the organization the flakiest tests, the fix history, the acceptance rate (patches applied out of those decided), and repair success (repairs that passed validation). Insights are kept for 13 months; an admin can turn them off, or delete everything shared, at any time.

CLI and CI tokens

Every npx kwikqa login creates a token named "CLI sign-in" with the date. For CI:

  • In a company account, create the token on the Organization page (admins) or a team's page (its managers). It belongs to the company or the team, not to a person, so it keeps working when people leave.
  • In a personal account, create it in Account.
  1. Enter a name that says where the token will live, such as "GitHub Actions", and create it.
  2. Copy the token. It is shown once; KwikQA stores only a hash.
  3. Provide it to the CLI as KWIKQA_TOKEN.

A CI token works where its plan allows: on one repository of your own a month for Pro and BYOK, and on organization repositories for Teams, BYOK Teams, Enterprise, and BYOK Enterprise. On Hobby, CI runs are analyzed locally once the paid plans open; until then, CI isn't limited by plan. Plan rules in CI has the details.

A person can hold up to 50 active tokens of their own, and a company up to 100 CI tokens; revoke one you no longer use to create another. The lists show when each token was created, last used, and expires. Revoke any token you no longer use; the CLI using it is signed out immediately. npx kwikqa logout revokes the token of the machine you run it on.

A token stops working after 90 days without use; each use moves that date. A company's admins can also cap how long any of its tokens lives, at 30, 90, 180, or 365 days from when it was created, on the Organization page's CI tokens tab; tokens older than a new cap stop working at once. An expired token gets "This KwikQA token has expired": sign in again with npx kwikqa login, or create a new CI token. A company's audit log records each CI token that expired.

Export your data

Download my data in Account gives you a JSON file with everything the service stores about you: your account, your organization role and teams, token names and dates, your request records, and the insights your CLI shared; for a personal account, also its monthly usage, monthly totals, and result counts. In a company account, those belong to the company, so a member's export leaves them out.

A company's admins can download everything KwikQA stores about the company account from the Organization page's Settings tab: its people, invitations, teams, CI tokens (never the tokens themselves), single sign-on, monthly usage and totals, requests by person and token, result counts, and, on the Enterprise plans, the audit log. Each download is recorded in the audit log.

Delete your account

Deleting a personal account cancels any subscription now (refunded as cancelling would be: in full within 14 days of the first payment, once in any 12 months, or an annual plan's unused months, as in the refund policy) and removes your account, tokens, sessions, usage, request records, and the CI repository and author records billed to it. Paddle keeps billing records as tax law requires. You can sign in again later to start a new free account.

In a company account, ask an admin to remove you. Admins can delete the whole company account from the Organization page: its subscription is cancelled the same way, and its people, teams, tokens, usage, and audit log are removed at once.