Skip to content

Configuration

This document outlines the configuration settings and directory structure for the Jiragen project.

Directory Structure

Jiragen follows the XDG Base Directory specification for storing configuration and data files:

Unix-like Systems (Linux, macOS)

~/.config/jiragen/           # Configuration directory
└── config.ini              # Main configuration file

~/.local/share/jiragen/     # Data directory
├── vector_store/          # Vector database storage
└── jiragen.log           # Application logs

Windows

%APPDATA%\jiragen\          # Configuration directory
└── config.ini              # Main configuration file

%LOCALAPPDATA%\jiragen\     # Data directory
├── vector_store/          # Vector database storage
└── jiragen.log           # Application logs

Configuration File

The config.ini file contains three main sections:

JIRA Configuration

[JIRA]
url = https://your-domain.atlassian.net
username = your-email@example.com
api_token = your-api-token
default_project = PROJECT
default_assignee = username

LLM Configuration

[llm]
model = openai/gpt-4o
api_base = https://api.openai.com/v1
api_token = your-api-token
temperature = 0.7
max_tokens = 2000

Environment Variables

You can configure Jiragen using environment variables:

JIRA Settings

  • JIRAGEN_URL: The URL of the JIRA instance
  • JIRAGEN_USERNAME: The username for JIRA authentication
  • JIRAGEN_API_TOKEN: The API token for accessing JIRA
  • JIRAGEN_DEFAULT_PROJECT: The default project key in JIRA
  • JIRAGEN_DEFAULT_ASSIGNEE: The default assignee for created issues

LLM Settings

  • JIRAGEN_LLM_MODEL: The LLM model to use
  • JIRAGEN_LLM_TEMPERATURE: Temperature setting for the LLM
  • JIRAGEN_LLM_MAX_TOKENS: Maximum tokens for LLM responses

Vector Store Settings

  • JIRAGEN_VECTOR_STORE_PATH: Custom path for vector store data

Directory Overrides

  • XDG_CONFIG_HOME: Override default config directory (Unix-like systems)
  • XDG_DATA_HOME: Override default data directory (Unix-like systems)
  • APPDATA: Override config directory (Windows)
  • LOCALAPPDATA: Override data directory (Windows)

Configuration Precedence

The configuration values are loaded in the following order (later values override earlier ones):

  1. Default values from config file
  2. Environment variables
  3. Command-line arguments (when applicable)

Initialization

When running jiragen init, you'll be prompted to configure all sections. You can: - Enter values manually - Press Enter to accept defaults - Use environment variables to pre-populate values

Example: 

$ jiragen init

JIRA Configuration:
JIRA URL (e.g., https://your-domain.atlassian.net):
Username (usually your email):
API Token:
Default Project Key:
Default Assignee:

LLM Configuration:
Model name (default: openai/gpt-4o):
Temperature (0.0-1.0, default: 0.7):
Maximum tokens (default: 2000):

you can also specify a config file path with the --config flag

$ jiragen generate --config /path/to/config.ini