How Gherkin Studio works

Editor

• Open any Jira issue and find the Scenarios panel. Use Start from template for a first scenario.
• Suggestions: after Given, When, Then, And or But, steps already used in the project appear. Press Tab to accept, or pick one with the arrow keys and press Enter.
• Errors show under the editor in plain English. Click Line N to jump there. Scenarios with errors can be saved but are never pushed to Git.
• Format tables aligns every table. Doc strings are never touched.
• Save with the button or Ctrl/⌘+S. If a colleague saved in the meantime, we tell you instead of overwriting their work.
• All Gherkin languages work: start the text with # language: fr (or any other code).

Git sync

• Project admins connect a repository in Project settings → Gherkin Studio.
• Press Sync with Git in the Scenarios panel. If only one side changed, it's copied to the other. If both changed, you see a line-by-line comparison and choose Keep Jira version, Keep Git version or Use the editor text.
• If Git changes again while you're deciding, we show you the new version instead of overwriting it.
• Changing the repository, branch or folder starts fresh: the first sync on each story never overwrites without asking.

Test results

• Any tool that writes Cucumber JSON works (cucumber-js, Cucumber-JVM, Reqnroll/SpecFlow plugins, behave converters, and others).
• A scenario belongs to a story through an @KEY-123 tag on the scenario or feature, or a file named KEY-123.feature.
• A story shows failing if any of its scenarios failed, passing if all passed, and not run otherwise.
• The endpoint answers with updated, unknownIssues and unmappedScenarios to help you debug tags.

AI drafts

• Off by default. A Jira admin turns it on in Apps → Gherkin Studio and adds an Anthropic API key.
• When someone clicks AI draft, the story's key, summary, description, existing scenarios and common step wording are sent to Anthropic. Nothing is sent while the setting is off.
• The draft is shown first. You add it or discard it.

Permissions

Migrating from another app? Follow the migration guide.