If your organization uses Jira, you don't have to choose between corporate compliance and a fast developer experience. The Kanbus Jira Sync allows you to safely pull issues down to your local project/issues/ directory as JSON files, enabling you to use the fast Kanbus CLI and UI for your daily work.

Setup and Configuration

First, you need to tell Kanbus how to connect to your Jira instance. Add the jira configuration block to your .kanbus.yml:

Terminal

# .kanbus.yml
jira:
  url: https://yourcompany.atlassian.net
  project_key: AQA
  sync_direction: pull
  type_mappings:
    Story: story
    Bug: bug
    Task: task
    Workstream: epic

Next, ensure your credentials are set via environment variables (in your shell or a .env file):

Terminal

export JIRA_API_TOKEN=your-atlassian-api-token
export JIRA_USER_EMAIL=you@yourcompany.com

Usage Workflow

Once configured, you can invoke the pull command to fetch your issues:

Terminal

# Preview what will be pulled without writing files
kanbus jira pull --dry-run

# Execute the sync
kanbus jira pull

Issues will be safely written to your project/issues/ directory. Rerunning the command will update any existing issues (idempotent). You can view the newly synced issues instantly by running kanbus list.