Metadata-Version: 2.5
Name: colenio-jira-cli
Version: 0.5.0
Summary: Modular Jira CLI tool for issue listing, filtering, and management
Project-URL: Homepage, https://github.com/colenio/jira-cli
Project-URL: Repository, https://github.com/colenio/jira-cli
Project-URL: Issues, https://github.com/colenio/jira-cli/issues
Author-email: Colenio <dev@colenio.com>
License-Expression: MIT
License-File: LICENSE
Requires-Python: >=3.11
Requires-Dist: click>=8.1.0
Requires-Dist: jira>=3.8.0
Requires-Dist: pydantic>=2.0.0
Requires-Dist: python-dotenv>=1.0.0
Requires-Dist: rich>=13.0.0
Requires-Dist: tabulate>=0.9.0
Requires-Dist: textual>=0.40.0
Provides-Extra: dev
Requires-Dist: black>=24.0.0; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.24.0; extra == 'dev'
Requires-Dist: pytest>=8.0.0; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-material>=9.5.0; extra == 'docs'
Requires-Dist: mkdocs>=1.6.0; extra == 'docs'
Requires-Dist: mkdocstrings[python]>=0.26.0; extra == 'docs'
Provides-Extra: local-dev
Requires-Dist: pylint>=3.2.0; extra == 'local-dev'
Requires-Dist: radon>=6.0.1; extra == 'local-dev'
Requires-Dist: ruff>=0.2.0; extra == 'local-dev'
Description-Content-Type: text/markdown

<!-- markdownlint-disable MD041 -->

[![CI](https://github.com/colenio/jira-cli/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/colenio/jira-cli/actions/workflows/ci.yml)
[![PyPI version](https://img.shields.io/pypi/v/colenio-jira-cli.svg)](https://pypi.org/project/colenio-jira-cli/)

# Jira CLI

**Think github-cli but for Jira.**

> Modular, class-based Jira command-line tool for issue listing, searching, and management.

There's a CLI (`jira issue ...`) and an interactive TUI (`jira tui --project PROJ`). Both are self-explanatory via `--help` / the in-app `?` help — see **[docs/features.md](docs/features.md)** for the full feature overview and TUI keyboard shortcuts.

## Installation

```powershell
# Editable install for local development
uv tool install --editable .
jira --help
```

```bash
# Remote/published, via uvx
uvx --from colenio-jira-cli jira-cli issue list --project PROJ
```

The PyPI/package name is `colenio-jira-cli`; the installed commands are `jira` and `jira-cli` (both run the same CLI). See [docs/distribution.md](docs/distribution.md) for other install options (pip, venv).

For screenshots, screencasts, or trying the TUI without Jira credentials, use synthetic demo data:

```bash
jira tui --demo
```

## Screenshots

The default issue table is optimized for quick triage: type, key, summary, status, assignee,
and priority stay visible while the detail pane follows the current selection.

![Jira CLI demo issue table](docs/img/tui/01-issues-table.png)

The board view groups the same issue source by workflow status, with Backlog on the left and
done states on the right.

![Jira CLI demo board view](docs/img/tui/02-issues-board.png)

## Setup

Create a `.env` or `local.env` file in your working directory (auto-discovered in CWD or parent directories):

```bash
# Required
JIRA_URL=https://company.atlassian.net
JIRA_EMAIL=user@example.com
JIRA_API_TOKEN=your_api_token_here

# Optional
JIRA_PROJECT=PROJ      # Default project for list/find/tui
```

Get your API token from Jira Cloud: Account Settings → Security → Create API Token.

## Development

```bash
uv sync --extra dev --extra local-dev
uv run pytest
uv run black jira_cli
uv run ruff check jira_cli
uv run jira-cli-qa   # runs ruff + radon + pylint
```

## Documentation Site

```bash
uv sync --extra docs
uv run jira-cli-docs        # strict MkDocs build
uv run jira-cli-docs-serve  # local preview
```

The docs are built with MkDocs Material and mkdocstrings. API pages render Python docstrings directly from `jira_cli`.

## Additional Docs

- [docs/features.md](docs/features.md) — feature overview + TUI keyboard shortcuts
- [docs/architecture.md](docs/architecture.md)
- [docs/distribution.md](docs/distribution.md)

## License

MIT
