Installation

spectryn can be installed using several methods. Choose the one that best fits your workflow.

Prerequisites

• Python 3.10 or higher
• Jira Cloud account with API access

Package Managers

pip (Recommended)

pip install spectryn

pipx (Isolated Environment)

pipx installs Python CLI tools in isolated environments:

pipx install spectryn

Homebrew (macOS/Linux)

brew tap adriandarian/spectra https://github.com/adriandarian/spectra
brew install spectra

Chocolatey (Windows)

choco install spectryn

Universal Linux Installer

curl -fsSL https://raw.githubusercontent.com/adriandarian/spectryn/main/packaging/packages/linux/install.sh | bash

Docker

Pull from Docker Hub

docker pull adrianthehactus/spectryn:latest

Run with Docker

docker run --rm \
  -e JIRA_URL=https://your-company.atlassian.net \
  -e JIRA_EMAIL=your.email@company.com \
  -e JIRA_API_TOKEN=your-api-token \
  -v $(pwd):/workspace \
  spectryn:latest \
  --markdown EPIC.md --epic PROJ-123

Docker Compose

For easier usage with persistent configuration:

# docker-compose.yml
services:
  spectryn:
    image: adrianthehactus/spectryn:latest
    env_file:
      - .env
    volumes:
      - .:/workspace
    working_dir: /workspace

# Run with Docker Compose
docker compose run --rm spectryn --markdown EPIC.md --epic PROJ-123

From Source

Clone the repository and install in development mode:

git clone https://github.com/adriandarian/spectryn.git
cd spectryn
pip install -e ".[dev]"

This installs spectryn in editable mode with development dependencies (pytest, mypy, ruff, etc.).

Verify Installation

Check that spectryn is installed correctly:

spectryn --version

Expected output:

spectryn version 1.0.0

Shell Completions

Enable tab completion for your shell:

Bash

eval "$(spectryn --completions bash)"

Zsh

eval "$(spectryn --completions zsh)"

Fish

spectryn --completions fish | source

See Shell Completions for permanent installation.

Jira API Token

You'll need a Jira API token to authenticate. Generate one at:

https://id.atlassian.com/manage-profile/security/api-tokens

Security Best Practice

Never commit your API token to version control. Use environment variables or a .env file (added to .gitignore).

Next Steps

• Quick Start Guide - Your first sync in 5 minutes
• Configuration - Set up config files and environment variables