sentryqa

Initialization CLI for connecting SentryQA to an existing React + Vite + TypeScript project. It detects the package manager, installs @sentryqa/vite, and edits the configuration so you do not have to copy imports by hand.

Recommended Installation and Usage

You do not need to install it globally:

npx sentryqa init
npm run dev

To keep issues in Git:

npx sentryqa init --track-issues

By default, init creates .sentryqa/issues/ and adds only .sentryqa/issues/ to .gitignore, so the destination configuration can be shared. --ignore-issues is the legacy alias for the default behavior.

Destinations and Authentication

Destination settings are non-secret project configuration in .sentryqa/destinations.json. Issue files remain ignored; destination settings are intentionally shareable.

npx sentryqa destinations add github-main github --owner bitsentry --repo sentryqa
npx sentryqa destinations add jira-main jira --base-url https://example.atlassian.net --project-key SQA
npx sentryqa destinations add local-main local --path .sentryqa/issues
npx sentryqa destinations list
npx sentryqa destinations test github-main
npx sentryqa destinations remove github-main
npx sentryqa auth login github
npx sentryqa auth login jira
npx sentryqa auth status
npx sentryqa auth logout github
npx sentryqa issues push SQA-0001 --to local-main,jira-main

auth login prompts for credentials and never accepts tokens as normal arguments. Jira prompts for the account email and API token. macOS Keychain or Linux secret-tool is used when available. If neither is available, credentials are kept only in the current CLI process environment and are not written to project files. issues push is explicit, reads the authoritative Markdown issue, and can fan out to every configured destination or the names passed to --to. Successful exports are recorded in private .sentryqa/exports.json state so repeats do not create duplicates.

Publishing currently creates/tests GitHub and Jira Cloud issues only. It does not update, delete, synchronize, or retry remote issues, and no network request occurs from the browser/runtime.

What It Modifies

• Adds @sentryqa/vite to devDependencies using the detected package manager.
• Adds import { sentryQa } from '@sentryqa/vite' and sentryQa() to the only vite.config.* file found.
• Creates the .sentryqa/issues/ directory.
• Updates .gitignore to ignore issue files, unless --track-issues is used. The destination configuration is not ignored.

The CLI requires package.json, Vite, React, TypeScript, and exactly one Vite configuration file. It does not modify application code or enable SentryQA in production.

Relationship to the Packages

The CLI is the user entry point. During vite serve, the @sentryqa/vite plugin connects the runtime, React adapter, and @sentryqa/core models. You do not need to install those packages manually for the normal workflow.

When Not to Use It

Do not use it in projects that are not React + Vite + TypeScript projects, when you have multiple ambiguous Vite configurations, or when you need a custom runtime integration. In those cases, configure @sentryqa/vite or @sentryqa/runtime directly.