testItRight
ENDE
Documentation

Test Scribe Documentation

Install the extension, connect an AI backend, and start turning JIRA tickets into test cases. Ollama users must apply the one-time CORS fix below.

Install from Chrome Web Store

Four AI Backends

Pick whichever fits your privacy, speed, and cost needs — you can switch anytime from the popup.

1 · Ollama

Local · Recommended

Runs entirely on your machine (e.g. Qwen2.5-Coder). No data leaves your network, no API costs.

2 · Google Gemini

Cloud

Fast cloud generation using your Gemini API key.

3 · Groq Cloud

Cloud

Ultra-fast cloud inference using Llama 3, DeepSeek, or Mixtral models.

4 · Custom OpenAI

Local / Cloud

Connect LM Studio, local hosts, or gateways (DeepSeek Cloud, OpenRouter) via the standard OpenAI REST spec.

Install the Extension

Test Scribe works on Chrome (or any Chromium browser) with a JIRA Cloud instance and one AI backend — local or cloud.

  1. Open the Test Scribe listing on the Chrome Web Store and click “Add to Chrome”.
  2. Confirm with “Add extension” in the browser prompt.
  3. Click the puzzle-piece Extensions icon in the Chrome toolbar and pin Test Scribe (the pen icon) for one-click access.
  4. Open a JIRA ticket, click the Test Scribe icon, then open Settings to connect an AI backend (see the guides below).

NotePrefer to run from source? Clone the repo, open chrome://extensions, enable Developer mode, and use “Load unpacked” to load the extension folder.

Setup: Ollama (Local AI — Recommended)

  1. Download and install Ollama from ollama.com.
  2. Pull the recommended model (optimised for structured output — produces better Gherkin and test tables than general-purpose models):
    ollama pull qwen2.5-coder
  3. Click the Test Scribe icon → Settings.
  4. Select Ollama (Local) and set the host URL (default: http://localhost:11434).
  5. Click Refresh next to the Model dropdown, select qwen2.5-coder, then Save.

NoteOllama blocks Chrome-extension requests by default — apply the CORS fix below before generating.

Fix the Ollama CORS Error (Required for Ollama)

Chrome extensions send requests with a special Origin header that Ollama blocks by default, returning a 403 error. Run the command for your OS once, then restart Ollama.

macOS

launchctl setenv OLLAMA_ORIGINS "*"

Then quit and restart Ollama from the menu bar app.

Linux (systemd)

sudo systemctl edit ollama.service

Add inside the file:

[Service]
Environment="OLLAMA_ORIGINS=*"

Then reload and restart:

sudo systemctl daemon-reload && sudo systemctl restart ollama

Windows (PowerShell)

[System.Environment]::SetEnvironmentVariable("OLLAMA_ORIGINS", "*", "User")

Then quit and restart Ollama from the system tray.

Setup: Gemini (Cloud AI)

  1. Get a free API key at aistudio.google.com/app/apikey.
  2. Click the Test Scribe icon → Settings.
  3. Select Gemini (Cloud), paste your API key, then Save.

Test Scribe automatically selects the best available Gemini Flash model.

Setup: Groq (Cloud AI)

  1. Generate an API key on the Groq Console (console.groq.com/keys).
  2. Click the Test Scribe icon → Settings.
  3. Select Groq (Cloud), paste your API key, click Refresh, choose your preferred model, then Save.

Setup: Custom OpenAI

  1. Click the Test Scribe icon → Settings.
  2. Select Custom OpenAI.
  3. Enter your Host URL (e.g. http://localhost:1234/v1 for LM Studio).
  4. Enter an API key if your custom server requires one.
  5. Click Refresh, select your model from the dropdown, then Save.

Xray Integration (Optional)

  1. In JIRA: go to Apps → Xray → API Keys, create a key pair, and copy the Client ID and Secret.
  2. Click the Test Scribe icon → Settings → Xray Integration.
  3. Enter your credentials, click Test to verify, then Save.

Generating Test Cases

  1. Open a JIRA ticket in your browser — any Cloud instance whose URL path contains /browse/ (e.g. https://your-domain.atlassian.net/browse/TS-101).
  2. Click the Test Scribe icon. It reads the ticket title and description automatically.
  3. Choose a generator tab — Gherkin Prompt (Cucumber BDD) or Manual Prompt (step tables).
  4. Click Generate Test Cases and review the results.

Per-test actions

  • Copy — copy the Gherkin or manual steps to your clipboard.
  • Edit — adjust any step inline in the editable text areas.
  • Create JIRA / Xray Test — push the test to JIRA as a task linked to the source ticket, or import it into Xray Cloud.

Context Enrichment

Test Scribe can read related ticket hierarchies so the AI generates steps that match your domain vocabulary.

Epic / Story context

Auto-scans for parent issues and appends their descriptions to the prompt.

Interactive context panel

Discovered parent relations appear as a checklist between the title and the prompt editor, so you control exactly what gets attached.

Enrichment settings

Choose whether the parent ticket is included by default, or hide the context panel from the popup.

Review & Merge — Step Consistency & Sync

Keep your Gherkin vocabulary consistent across tickets. Test Scribe syncs your existing step library from Xray and reuses it when generating and merging new scenarios.

Sync your Xray step library

  1. Connect Xray first (see Xray Integration above) so Test Scribe has your Client ID and Secret.
  2. Open Settings → Integration and trigger a Sync.
  3. Test Scribe scans every Test issue in your selected JIRA projects, filters for Cucumber (Gherkin) tests, extracts their scenario steps, and stores them locally in the extension. Manual tests are skipped to keep the library focused on reusable BDD steps.

How the synced library is used

Fuzzy step matching

Generated steps are compared against the synced library using Jaccard similarity. Close matches are highlighted so you can normalize slight wording differences.

Step autocomplete

Start typing in the step editor to get suggestions from your synced step dictionary.

Prompt context injection

Test Scribe finds existing steps similar to the ticket’s title and description and adds them to the AI prompt, so the model reuses your vocabulary naturally.

Save & merge target

Candidate Test tickets are ranked by overall step similarity, and the best match is auto-selected to append new scenarios into.

Troubleshooting

403 Forbidden from Ollama

Set OLLAMA_ORIGINS to "*" — see the CORS section above.

Ollama unreachable

Start Ollama and check that the host URL in Settings matches your port.

No models found

Pull the recommended model:

ollama pull qwen2.5-coder

Gemini API key missing

Settings → Gemini tab → paste your key → Save.

Popup opens but shows no JIRA data

Navigate to a ticket URL first (e.g. /browse/PROJ-123).

Tests not appearing

Right-click the popup → Inspect → check the Console for errors.

Source Code & Full Documentation

Test Scribe is open source. Browse the code, open issues, and read the full documentation on GitHub.

View on GitHub