Skip to main content

JIRA ticket context manager for git workflows

Project description

jira-git-helper

A terminal-based JIRA ticket context manager for git workflows, invoked as jg.

Keeps the current JIRA ticket in your shell environment so that branch names, commit messages, and PR lookups are automatically prefixed — without you having to type the ticket key every time.

Installation

uv tool install jira-git-helper

Or with pipx:

pipx install jira-git-helper

Configuration

Run these once after installation:

jg config set server https://yourcompany.atlassian.net
jg config set email  you@yourcompany.com
jg config set token  <your-jira-api-token>

Optionally set a default JQL filter for the ticket picker (defaults to your assigned tickets):

jg config set jql "project = MYPROJECT AND assignee = currentUser() ORDER BY updated DESC"

Generate a JIRA API token at: https://id.atlassian.com/manage-profile/security/api-tokens

Shell hook

The hook lets jg set / jg clear update SJ_TICKET in your current shell, so each terminal can track a different ticket independently.

Fish:

# Add to ~/.config/fish/config.fish
eval (jg hook)

Bash / Zsh:

# Add to ~/.bashrc or ~/.zshrc
eval "$(jg hook --shell bash)"   # or --shell zsh

Tide prompt (fish)

jg setup

Then follow the printed instructions to add jg to your Tide prompt items.

Commands

Command Description
jg Show the current ticket
jg set [TICKET] Set ticket (interactive picker if no argument)
jg clear Clear the current ticket
jg info [TICKET] Show ticket details
jg open [TICKET] Open ticket in browser
jg branch [name] Switch to a ticket branch, or create one
jg add Interactive staging UI with inline commit
jg commit <message> Commit with ticket prefix
jg push Push branch and open linked PR
jg diff [TICKET] Diff an open/draft PR with gh
jg prs [TICKET] List all linked PRs
jg config get <key> Get a config value
jg config set <key> <value> Set a config value
jg config list List all config values
jg hook [--shell fish|bash|zsh] Print shell hook
jg setup Configure Tide prompt integration

Requirements

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jira_git_helper-0.1.0.tar.gz (20.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jira_git_helper-0.1.0-py3-none-any.whl (13.3 kB view details)

Uploaded Python 3

File details

Details for the file jira_git_helper-0.1.0.tar.gz.

File metadata

  • Download URL: jira_git_helper-0.1.0.tar.gz
  • Upload date:
  • Size: 20.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.3 {"installer":{"name":"uv","version":"0.10.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for jira_git_helper-0.1.0.tar.gz
Algorithm Hash digest
SHA256 01d8d14fd2cc6bde1f2534c117feb2c8b30b22639acd9794bfbff87bba444b15
MD5 cdda1937ceb9f57610fff47535bcbcfc
BLAKE2b-256 47ae8db89c6127f7e53f0b8c41e184d4cbc40d5e5d348b1a2e9be81fb7e153a3

See more details on using hashes here.

File details

Details for the file jira_git_helper-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: jira_git_helper-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 13.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.3 {"installer":{"name":"uv","version":"0.10.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for jira_git_helper-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a6d44ebe55beda03026645e5f09fc5f67999d611c0e8e20b90bb4ef65cf42b8d
MD5 bea954880b35970a30635bfa4d91bed1
BLAKE2b-256 bc132f40708170df3d3b65292aaf8475c17a497c0590980164506fe51ea5c966

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page