Skip to main content

jira-creator

Build Status Python License Last Commit

Create JIRA issues (stories, bugs, epics, spikes, tasks) quickly using standardized templates and optional AI-enhanced descriptions.


⚡ Quick Start (Under 30 Seconds)

🔧 Step 1. Create Your Config File and Enable Autocomplete

Autocomplete enables you to quickly and efficiently use the JIRA command-line tool. Follow the below commands to set up autocomplete:

mkdir -p ~/.bashrc.d
cat <<EOF > ~/.bashrc.d/jira.sh
export JPAT="your_jira_personal_access_token"
export AI_PROVIDER=openai
export OPENAI_API_KEY=sk-...
export JIRA_URL="https://issues.redhat.com"
export PROJECT_KEY="AAP"
export AFFECTS_VERSION="aa-latest"
export COMPONENT_NAME="analytics-hcc-service"
export PRIORITY="Normal"
export JIRA_BOARD_ID=21125

# Enable autocomplete
eval "$(/usr/local/bin/rh-issue --_completion | sed 's/rh_jira.py/rh-issue/')"
EOF

source ~/.bashrc.d/jira.sh

This creates a symbolic link to the command-line tool wrapper, allowing you to use the tool from any location:

chmod +x jira_creator/rh-issue-wrapper.sh
sudo ln -s $(pwd)/jira_creator/rh-issue-wrapper.sh /usr/local/bin/rh-issue

🏃‍♀️ Step 3. Run It

Here's how to create a story issue:

rh-issue create story "Improve onboarding experience"

🧪 Usage & Commands

🆕 Create Issues

You can use the create command to make various kinds of issues:

rh-issue create bug "Fix login crash"
rh-issue create story "Refactor onboarding flow"
rh-issue create epic "Unify frontend UI" --edit
rh-issue create spike "Evaluate GraphQL support" --dry-run

The --edit flag opens the issue's description in your $EDITOR for editing, and --dry-run prints the payload without creating the issue.

🔀 Change Issue Type

You can alter the type of an existing issue with the change command:

rh-issue change AAP-12345 story

➡️ Migrate Issue

The migrate command allows you to move an issue to a different type:

rh-issue migrate AAP-54321 story

✏️ Edit Description

Use the edit command to modify the description of an issue:

rh-issue edit AAP-98765
rh-issue edit AAP-98765 --no-ai

The --no-ai flag lets you edit without AI assistance.

🧍 Unassign Issue

The unassign command removes the current assignee from an issue:

rh-issue unassign AAP-12345

📋 List Issues

The list command shows all issues, with optional filtering:

rh-issue list
rh-issue list --project AAP --component api --user jdoe

🏷️ Set Priority

Use the set-priority command to change the priority of an issue:

rh-issue set-priority AAP-123 High

📅 Sprint Management

The set-sprint, remove-sprint, and add-sprint commands help manage sprints:

rh-issue set-sprint AAP-456 1234
rh-issue remove-sprint AAP-456
rh-issue add-sprint AAP-456 "Sprint 33"

🚦 Set Status

The set-status command changes the status of an issue:

rh-issue set-status AAP-123 "In Progress"

🤖 AI Provider Support

You can plug in different AI providers by setting AI_PROVIDER. Here are some examples:

  • OpenAI:
export AI_PROVIDER=openai
export OPENAI_API_KEY=sk-...
export OPENAI_MODEL=gpt-4  # Optional
  • GPT4All:
pip install gpt4all
export AI_PROVIDER=gpt4all
  • InstructLab:
export AI_PROVIDER=instructlab
export INSTRUCTLAB_URL=http://localhost:11434/api/generate
export INSTRUCTLAB_MODEL=instructlab
  • BART:
export AI_PROVIDER=bart
export BART_URL=http://localhost:8000/bart
  • DeepSeek:
export AI_PROVIDER=deepseek
export DEEPSEEK_URL=http://localhost:8000/deepseek
  • Noop:
export AI_PROVIDER=noop

🛠 Dev Setup

pipenv install --dev

Testing & Linting

make test
make lint
make format  # auto-fix formatting

⚙️ How It Works

  • Loads field definitions from .tmpl files under templates/
  • Uses TemplateLoader to generate Markdown descriptions
  • Optionally applies AI cleanup for readability and structure
  • Sends to JIRA via REST API (or dry-runs it)

📜 License

This project is licensed under the Apache License.

Metadata

Release files for jira-creator 0.0.33

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jira-creator 0.0.33
File Size Uploaded Provenance Actions
jira_creator-0.0.33.tar.gz 53.6 kB Without provenance Details for jira_creator-0.0.33.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for jira-creator 0.0.33
File Interpreter ABI Platform Actions
jira_creator-0.0.33-py3-none-any.whl Python 3 none any Details for jira_creator-0.0.33-py3-none-any.whl

Total release size: 159.9 kB

Release files / jira_creator-0.0.33.tar.gz

Download URL jira_creator-0.0.33.tar.gz
Size 53.6 kB
Tags Source
SHA-256 checksum
How to use checksums
d64d5ec700fb224150b580dd1323e3e415419c65b4a90c9962b83e2ff3ae2318
BLAKE2b-256 checksum
How to use checksums
fa862456cb3d9844f48b0d58efa72700451ee8d42292eae81d144ce4c8f3b65d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.3

Release files / jira_creator-0.0.33-py3-none-any.whl

Download URL jira_creator-0.0.33-py3-none-any.whl
Size 106.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
01b9dc80ffb0a89bc6c47c664894dee067d9ed4e082930e012a7cd3ec002e240
BLAKE2b-256 checksum
How to use checksums
51283948936e9e44d64af46ce73decb0cec3113f767fb869b41d131f1a3e438f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.3

Security for jira-creator 0.0.33

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.33 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page