JiraGen: Automated JIRA Issue Generation
🚀 Overview
Jiragen is a CLI designed to automate the creation of JIRA Issues through the use of Large Language Models (LLMs). It is fully integrated with JIRA API and your Local codebase accelerating jira issue creation and enabling developers to focus on other aspects of their projects. Full documentation is available here.
📖 Table of Contents
- Key Features
- Quick Start
- Usage Examples
- Configuration Options
- Template Customization
- Contributing
- License
🌟 Key Features
- 🧠 Local LLM Integration: Leverages Ollama (via LiteLLM) for local text generation
- 🔍 Context-Aware Issues: Smart codebase analysis with vector store integration
- 🎯 Gitignore Support: Respects .gitignore patterns when indexing codebase
- ✨ Customizable Templates: Flexible issue templates for different needs
- 🔧 Smart Metadata Extraction: Automatic extraction of issue type, priority, and labels
- ⚙️ Interactive Workflow: Review and modify content before uploading
⚡ Quick Start
Installation
Install JiraGen and its dependencies:
pip install jiragen
Install & run Ollama to use your local LLM:
curl https://ollama.ai/install.sh | sh
ollama pull phi4 # Replace with your preferred model
or export your OpenAI API key:
export OPENAI_API_KEY="YOUR_API_KEY"
Basic Setup
# Initialize configuration
jiragen init
# Index your codebase (respects .gitignore)
jiragen add .
# Generate your first issue
jiragen generate "Implement user authentication"
🎯 Usage Examples
Codebase Indexing
# Add all files (respects .gitignore)
jiragen add .
# Add specific files or directories
jiragen add src/main.py
# Remove files
jiragen rm src/deprecated/
Issue Generation
# Basic generation
jiragen generate "Add dark mode support"
# With custom template and model
jiragen generate "API rate limiting" \
--template templates/feature.md \
--model ollama/codellama
# Generate and upload to JIRA
jiragen generate "Fix memory leak" --upload --yes
# Interactive editing
jiragen generate "OAuth integration" --editor
Status and Management
# View indexed files
jiragen status
jiragen status --compact
jiragen status --depth 2
# Fetch JIRA data
jiragen fetch --types epics tickets
# Restart vector store
jiragen restart
⚙️ Configuration Options
JiraGen can be configured through:
- Command-line arguments
- Configuration file (
~/.jiragen/config.ini) - Environment variables
# Python API configuration
LLMConfig(
model="llama2", # Ollama model to use
api_base="http://localhost:11434", # Ollama endpoint
max_tokens=2000,
temperature=0.7,
top_p=0.95,
)
📝 Template Customization
Create templates to match your organization's needs:
# {title}
## Description
{description}
## Acceptance Criteria
{acceptance_criteria}
## Technical Implementation
{implementation_details}
## Testing Strategy
- Unit Tests
- Integration Tests
- E2E Tests
🤝 Contributing
We ❤️ contributions! To contribute:
- Fork the repository
- Create a feature branch
- Submit a pull request with a detailed description
For more details, refer to our CONTRIBUTING.md.
📜 License
JiraGen is released under the MIT License.
Metadata
Release files for jiragen 0.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| jiragen-0.5.0.tar.gz | 81.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| jiragen-0.5.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 144.3 kB
Release files / jiragen-0.5.0.tar.gz
| Download URL | jiragen-0.5.0.tar.gz |
|---|---|
| Size | 81.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
41dea2e2d16306445ba360cfd5b9b660a466d4dfc1a955942582588d0dfee7e4
|
|
BLAKE2b-256 checksum How to use checksums |
71d31b632eb930c9d5c4f5494cca400d267d253e10abb00dfdb70507bcc4c6a1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.10.9
|
Release files / jiragen-0.5.0-py3-none-any.whl
| Download URL | jiragen-0.5.0-py3-none-any.whl |
|---|---|
| Size | 62.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b9c962a483f54e27859cbe2b8aa46c90ba5d54be366c0d152c1fcd5ede4eb005
|
|
BLAKE2b-256 checksum How to use checksums |
0fe836087a334d7d5423ca78d49f95355eafb72b48d9aadd0e69ff606eb5ce55
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.10.9
|