issue-flow 0.2.2__tar.gz → 0.3.0__tar.gz

issue_flow-0.3.0/PKG-INFO

@@ -0,0 +1,279 @@
+Metadata-Version: 2.4
+Name: issue-flow
+Version: 0.3.0
+Summary: Agents should behave. Let them follow the issue flow.
+Keywords: cursor,ai,agents,issue-tracking,workflow
+Author: jepegit
+Author-email: jepegit <jepe@ife.no>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: python-dotenv>=1.2.2
+Requires-Dist: rich>=14.3.3
+Requires-Dist: typer>=0.24.1
+Requires-Python: >=3.13
+Project-URL: Homepage, https://github.com/jepegit/issue-flow
+Project-URL: Repository, https://github.com/jepegit/issue-flow
+Project-URL: Issues, https://github.com/jepegit/issue-flow/issues
+Description-Content-Type: text/markdown
+
+# issue-flow
+
+Agents should behave. Let them follow the issue flow.
+
+**issue-flow** scaffolds a lightweight issue-tracking workflow into your project so that Cursor AI agents can pick up GitHub issues, plan work, and land PRs in a consistent way.
+
+## What it does
+
+Running `issue-flow init` in your project root creates:
+
+```text
+your-project/
+  .issueflows/
+    00-tools/                # Helper scripts for agents
+    01-current-issues/       # Active issue markdown files
+    02-partly-solved-issues/ # Parked / in-progress issues
+    03-solved-issues/        # Completed issues archive
+  .cursor/
+    commands/
+      iflow.md               # /iflow — smart dispatcher (quick start)
+      issue-init.md          # /issue-init — fetch a GitHub issue locally
+      issue-plan.md          # /issue-plan — write issue<N>_plan.md and confirm
+      issue-start.md         # /issue-start — implement the plan
+      issue-pause.md         # /issue-pause — park work in 02-partly-solved-issues/
+      issue-close.md         # /issue-close — test, commit, push, PR
+      issue-cleanup.md       # /issue-cleanup — post-merge branch hygiene
+      issue-yolo.md          # /issue-yolo — all-in-one for small, low-risk issues
+      build.md               # /build — rebuild the graphify knowledge graph (optional)
+    skills/                  # Optional Agent Skills (explicit / @ invoke)
+      issueflow-iflow/SKILL.md
+      issueflow-issue-init/SKILL.md
+      issueflow-issue-plan/SKILL.md
+      issueflow-issue-start/SKILL.md
+      issueflow-issue-pause/SKILL.md
+      issueflow-issue-close/SKILL.md
+      issueflow-issue-cleanup/SKILL.md
+      issueflow-issue-yolo/SKILL.md
+      issueflow-version-bump/SKILL.md
+      issueflow-history-update/SKILL.md
+      issueflow-build/SKILL.md
+    rules/
+      issueflow-rules.mdc    # Always-on Cursor rule for the workflow
+  docs/
+    cursor-issue-workflow.md # Human-readable overview of the workflow
+```
+
+The Cursor slash commands give agents a repeatable flow. The linear path is:
+
+1. `/issue-init 42` — pulls GitHub issue #42 into `.issueflows/01-current-issues/` and archives older issues.
+2. `/issue-plan` — drafts `issue<N>_plan.md` (Goal / Constraints / Approach / Files to touch / Test strategy / Open questions) and stops for your confirmation.
+3. `/issue-start` — reads the confirmed plan and implements it. If no plan file exists, it offers to run `/issue-plan` first, proceed without a plan, or abort.
+4. `/issue-close` — runs tests, optionally bumps version with `uv version --bump`, appends a `HISTORY.md` entry (or promotes `[Unreleased]` to a new release section on a bump), updates status files, commits, pushes, and opens a PR.
+5. `/issue-cleanup` — after the PR merges, switches to the default branch, fast-forwards, prunes, and deletes the merged local branch.
+
+Plus a few off-path commands:
+
+- `/iflow` — **quick start**: inspects the current issue's state and dispatches to the right linear step automatically. A branch-derived number (`42-fix-login` → `N=42`) is authoritative, so `/iflow` works from a fresh branch too.
+- `/issue-pause` — park the current issue in `02-partly-solved-issues/` with a **Remaining work** note; optional WIP commit + switch back to the default branch.
+- `/issue-yolo` — all-in-one chain (`init → plan → start → close`) for small, low-risk issues, with up-front safeguards (refuses on the default branch, refuses with dirty unrelated changes, requires passing tests, single consolidated confirm).
+
+The matching **Agent Skills** (under `.cursor/skills/`) carry the same workflows for on-demand use with `/issueflow-iflow`, `/issueflow-issue-init`, `/issueflow-issue-plan`, `/issueflow-issue-start`, `/issueflow-issue-pause`, `/issueflow-issue-close`, `/issueflow-issue-cleanup`, `/issueflow-issue-yolo`, `@issueflow-version-bump` when you need only the bump steps, or `@issueflow-history-update` when you need only the changelog update (see [Cursor Agent Skills](https://cursor.com/docs/context/skills)).
+
+## Prerequisites
+
+issue-flow itself is a small Python CLI, but the **scaffolded slash commands
+it writes into your project shell out to a few external tools**. If they are
+missing, the slash commands will fail at runtime — so `issue-flow init` now
+checks for them up front and prints install hints before it does anything.
+
+Required:
+
+- **[Git](https://git-scm.com/downloads)** — used by every slash command for
+  branch, fetch, status, commit, and push operations. Almost certainly already
+  installed if you're here, but the check covers it for completeness.
+- **[GitHub CLI (`gh`)](https://cli.github.com/)** — used by `/issue-init` to
+  fetch issues, by `/issue-close` to open PRs, and by `/issue-cleanup` to check
+  PR merge status. After installing, run `gh auth login` once to authenticate.
+
+Recommended:
+
+- **[uv](https://docs.astral.sh/uv/)** — how issue-flow itself is meant to be
+  installed, and how this repo manages its own Python environment.
+
+Quick install pointers for `gh`:
+
+| Platform | Command |
+|---|---|
+| macOS (Homebrew) | `brew install gh` |
+| Windows (winget) | `winget install --id GitHub.cli -e` |
+| Linux (Debian/Ubuntu) | `sudo apt install gh` (or see [cli.github.com](https://cli.github.com/) for the official repo) |
+
+If a dependency is missing, `issue-flow init` prints the installation hints
+and asks whether to continue anyway. You can bypass the prompt in automation
+with `issue-flow init --skip-dep-check` (the same flag is available on
+`issue-flow update`), and the prompt is also auto-skipped when stdin is not
+a TTY (e.g. CI pipelines).
+
+### Optional: graphify integration
+
+issue-flow has a lightweight integration with [graphify](https://graphify.net)
+(PyPI: `graphifyy`, CLI: `graphify`) — a tool that turns the project into a
+queryable knowledge graph that AI assistants can read instead of grepping
+through files. The integration is **opt-in by installing `graphifyy` as its
+own tool** (the same way you installed issue-flow): there is no flag, no
+`.env` switch, no extras to remember. Detection is purely PATH-based.
+
+What `issue-flow` does when `graphify` is on PATH:
+
+- `issue-flow init` and `issue-flow update` run `graphify cursor install` so
+  the graphify Cursor skill is registered alongside the issue-flow scaffold.
+  If graphify is not installed, both commands just print install hints and
+  continue — they never block.
+- A new slash command `/build` (and matching `/issueflow-build` skill) wraps
+  `issue-flow build`, which forwards every argument to the `graphify` CLI
+  verbatim (`--update`, `--no-viz`, `--mode deep`, `--watch`, …).
+- The scaffolded rules and `/issue-start` mention `graphify-out/GRAPH_REPORT.md`
+  as a recommended pre-read when the file exists. `/build` is **off-path** —
+  `/iflow` never auto-dispatches to it.
+
+To enable, install graphify as its own standalone tool:
+
+```bash
+uv tool install graphifyy   # recommended
+# or
+pipx install graphifyy
+# or
+pip install graphifyy
+```
+
+> **Why not an `issue-flow[graphify]` extra (or `uv tool install issue-flow --with graphifyy`)?**
+> `uv tool install` only puts the **host package's** entry-point scripts on
+> PATH. An extra (or `--with graphifyy`) pulls graphifyy into issue-flow's
+> venv but leaves the `graphify` CLI invisible to the shell, so `/build`
+> and `graphify cursor install` would still fail. Installing graphify as
+> its own tool puts a real `graphify` shim on PATH and matches how we
+> treat `git` / `gh`.
+
+> **Just installed graphifyy and `issue-flow init` says it's still missing?**
+> uv prints `~/.local/bin is not on your PATH` after the first
+> `uv tool install`. Run `uv tool update-shell` (refreshes shell rc files),
+> then **restart your shell and Cursor** so the new PATH takes effect.
+> issue-flow's missing-CLI hint also detects this case and tells you the
+> exact directory to add.
+
+After installing, run `issue-flow update` once so the graphify Cursor skill
+gets registered.
+
+## Installation
+
+Requires Python 3.13+ and [uv](https://docs.astral.sh/uv/).
+
+```bash
+uv tool install issue-flow
+```
+
+Or add it as a dev dependency to your project:
+
+```bash
+uv add --dev issue-flow
+```
+
+## Quick start
+
+```bash
+cd your-project
+issue-flow init
+```
+
+That's it. Open the project in Cursor and start with `/iflow` (or step through `/issue-init`, `/issue-plan`, `/issue-start`, `/issue-close`, `/issue-cleanup` explicitly).
+
+## Usage
+
+```
+issue-flow init [PROJECT_DIR] [--force] [--skip-dep-check]
+issue-flow update [PROJECT_DIR] [--skip-dep-check]
+issue-flow build [PROJECT_DIR] [-- ...graphify args]
+```
+
+### `issue-flow init`
+
+| Argument / Option | Description |
+|---|---|
+| `PROJECT_DIR` | Project root directory. Defaults to `.` (current directory). |
+| `--force`, `-f` | Overwrite generated Cursor commands, rules, and workflow doc instead of skipping them. |
+| `--skip-dep-check` | Skip the external-CLI dependency check (`git`, `gh`) and the confirmation prompt that follows if anything is missing. Useful in automation. |
+
+Running `init` again without `--force` is safe: generated scaffold files that already exist are skipped, and **issue markdown under `.issueflows/` is never touched** by `init` or `update`. When the CLI detects an existing scaffold, it reminds you about `update` and `--force`.
+
+### `issue-flow update`
+
+| Argument / Option | Description |
+|---|---|
+| `PROJECT_DIR` | Project root directory. Defaults to `.` (current directory). |
+| `--skip-dep-check` | Skip the external-CLI dependency check (`git`, `gh`) and the confirmation prompt that follows if anything is missing. |
+
+Use `update` after upgrading the **issue-flow** package to refresh the packaged slash commands, Cursor rule, and `docs/cursor-issue-workflow.md` from the version you have installed. This **overwrites** those generated files (unlike a plain second `init`). It still does not modify arbitrary files under `.issueflows/` (for example your `issue*_original.md` / `issue*_status.md` files), and it creates any **new** `.issueflows/` subdirectories required by the current package.
+
+### `issue-flow build`
+
+| Argument / Option | Description |
+|---|---|
+| `PROJECT_DIR` | Project root directory to scan with graphify. Defaults to `.`. |
+| `...graphify args` | Any extra arguments are forwarded **verbatim** to the `graphify` CLI (`--update`, `--no-viz`, `--mode deep`, `--watch`, …). |
+
+`build` requires `graphifyy` to be installed (`uv tool install graphifyy`). When the `graphify` CLI is missing, the command prints install hints and exits with code `2`. Outputs land in `graphify-out/` (`graph.html`, `GRAPH_REPORT.md`, `graph.json`).
+
+### When to use which
+
+| Goal | Command |
+|---|---|
+| First-time setup, or add missing files only | `issue-flow init` |
+| Pull newer templates after `uv tool upgrade issue-flow` (or similar) | `issue-flow update` |
+| Replace generated scaffolds without upgrading logic | `issue-flow init --force` |
+| Rebuild the graphify knowledge graph | `issue-flow build` |
+
+## Configuration
+
+issue-flow reads a `.env` file from the project root (via python-dotenv). The following environment variables are supported:
+
+| Variable | Default | Description |
+|---|---|---|
+| `ISSUEFLOW_DIR` | `.issueflows` | Name of the issue-tracking directory. |
+| `ISSUEFLOW_AGENT_DIR` | `.cursor` | Name of the agent/IDE config directory (currently `.cursor`). |
+| `ISSUEFLOW_DOCS_DIR` | `docs` | Where to write the workflow documentation file. |
+| `ISSUEFLOW_HISTORY_FILE` | `HISTORY.md` | Changelog file that `/issue-close` updates (set to e.g. `CHANGELOG.md` for different conventions). |
+
+## Development
+
+```bash
+git clone https://github.com/jepegit/issue-flow.git
+cd issue-flow
+uv sync
+
+# Run tests
+uv run pytest
+
+# Lint
+uv run ruff check src/ tests/
+```
+
+## Changelog
+
+See [HISTORY.md](HISTORY.md) for release notes.
+
+## Future plans
+
+- **Multi-tool support** — generate config for other AI coding tools (Claude Code, Windsurf, etc.) in addition to Cursor.
+- **`issue-flow status`** — show a dashboard of current, partly-solved, and solved issues.
+- **Custom templates** — let users supply their own Jinja2 templates to tailor slash commands and rules to their team's conventions.
+- **Git hook integration** — optionally move issue files on commit based on status markers.
+- **GitHub Actions workflow** — ship a reusable action that syncs issue state between `.issueflows/` and GitHub issue labels/milestones.
+
+## License
+
+This project is released under the MIT License. See the full text in the repository: [LICENSE](https://github.com/jepegit/issue-flow/blob/main/LICENSE).

issue_flow-0.3.0/README.md

@@ -0,0 +1,255 @@
+# issue-flow
+
+Agents should behave. Let them follow the issue flow.
+
+**issue-flow** scaffolds a lightweight issue-tracking workflow into your project so that Cursor AI agents can pick up GitHub issues, plan work, and land PRs in a consistent way.
+
+## What it does
+
+Running `issue-flow init` in your project root creates:
+
+```text
+your-project/
+  .issueflows/
+    00-tools/                # Helper scripts for agents
+    01-current-issues/       # Active issue markdown files
+    02-partly-solved-issues/ # Parked / in-progress issues
+    03-solved-issues/        # Completed issues archive
+  .cursor/
+    commands/
+      iflow.md               # /iflow — smart dispatcher (quick start)
+      issue-init.md          # /issue-init — fetch a GitHub issue locally
+      issue-plan.md          # /issue-plan — write issue<N>_plan.md and confirm
+      issue-start.md         # /issue-start — implement the plan
+      issue-pause.md         # /issue-pause — park work in 02-partly-solved-issues/
+      issue-close.md         # /issue-close — test, commit, push, PR
+      issue-cleanup.md       # /issue-cleanup — post-merge branch hygiene
+      issue-yolo.md          # /issue-yolo — all-in-one for small, low-risk issues
+      build.md               # /build — rebuild the graphify knowledge graph (optional)
+    skills/                  # Optional Agent Skills (explicit / @ invoke)
+      issueflow-iflow/SKILL.md
+      issueflow-issue-init/SKILL.md
+      issueflow-issue-plan/SKILL.md
+      issueflow-issue-start/SKILL.md
+      issueflow-issue-pause/SKILL.md
+      issueflow-issue-close/SKILL.md
+      issueflow-issue-cleanup/SKILL.md
+      issueflow-issue-yolo/SKILL.md
+      issueflow-version-bump/SKILL.md
+      issueflow-history-update/SKILL.md
+      issueflow-build/SKILL.md
+    rules/
+      issueflow-rules.mdc    # Always-on Cursor rule for the workflow
+  docs/
+    cursor-issue-workflow.md # Human-readable overview of the workflow
+```
+
+The Cursor slash commands give agents a repeatable flow. The linear path is:
+
+1. `/issue-init 42` — pulls GitHub issue #42 into `.issueflows/01-current-issues/` and archives older issues.
+2. `/issue-plan` — drafts `issue<N>_plan.md` (Goal / Constraints / Approach / Files to touch / Test strategy / Open questions) and stops for your confirmation.
+3. `/issue-start` — reads the confirmed plan and implements it. If no plan file exists, it offers to run `/issue-plan` first, proceed without a plan, or abort.
+4. `/issue-close` — runs tests, optionally bumps version with `uv version --bump`, appends a `HISTORY.md` entry (or promotes `[Unreleased]` to a new release section on a bump), updates status files, commits, pushes, and opens a PR.
+5. `/issue-cleanup` — after the PR merges, switches to the default branch, fast-forwards, prunes, and deletes the merged local branch.
+
+Plus a few off-path commands:
+
+- `/iflow` — **quick start**: inspects the current issue's state and dispatches to the right linear step automatically. A branch-derived number (`42-fix-login` → `N=42`) is authoritative, so `/iflow` works from a fresh branch too.
+- `/issue-pause` — park the current issue in `02-partly-solved-issues/` with a **Remaining work** note; optional WIP commit + switch back to the default branch.
+- `/issue-yolo` — all-in-one chain (`init → plan → start → close`) for small, low-risk issues, with up-front safeguards (refuses on the default branch, refuses with dirty unrelated changes, requires passing tests, single consolidated confirm).
+
+The matching **Agent Skills** (under `.cursor/skills/`) carry the same workflows for on-demand use with `/issueflow-iflow`, `/issueflow-issue-init`, `/issueflow-issue-plan`, `/issueflow-issue-start`, `/issueflow-issue-pause`, `/issueflow-issue-close`, `/issueflow-issue-cleanup`, `/issueflow-issue-yolo`, `@issueflow-version-bump` when you need only the bump steps, or `@issueflow-history-update` when you need only the changelog update (see [Cursor Agent Skills](https://cursor.com/docs/context/skills)).
+
+## Prerequisites
+
+issue-flow itself is a small Python CLI, but the **scaffolded slash commands
+it writes into your project shell out to a few external tools**. If they are
+missing, the slash commands will fail at runtime — so `issue-flow init` now
+checks for them up front and prints install hints before it does anything.
+
+Required:
+
+- **[Git](https://git-scm.com/downloads)** — used by every slash command for
+  branch, fetch, status, commit, and push operations. Almost certainly already
+  installed if you're here, but the check covers it for completeness.
+- **[GitHub CLI (`gh`)](https://cli.github.com/)** — used by `/issue-init` to
+  fetch issues, by `/issue-close` to open PRs, and by `/issue-cleanup` to check
+  PR merge status. After installing, run `gh auth login` once to authenticate.
+
+Recommended:
+
+- **[uv](https://docs.astral.sh/uv/)** — how issue-flow itself is meant to be
+  installed, and how this repo manages its own Python environment.
+
+Quick install pointers for `gh`:
+
+| Platform | Command |
+|---|---|
+| macOS (Homebrew) | `brew install gh` |
+| Windows (winget) | `winget install --id GitHub.cli -e` |
+| Linux (Debian/Ubuntu) | `sudo apt install gh` (or see [cli.github.com](https://cli.github.com/) for the official repo) |
+
+If a dependency is missing, `issue-flow init` prints the installation hints
+and asks whether to continue anyway. You can bypass the prompt in automation
+with `issue-flow init --skip-dep-check` (the same flag is available on
+`issue-flow update`), and the prompt is also auto-skipped when stdin is not
+a TTY (e.g. CI pipelines).
+
+### Optional: graphify integration
+
+issue-flow has a lightweight integration with [graphify](https://graphify.net)
+(PyPI: `graphifyy`, CLI: `graphify`) — a tool that turns the project into a
+queryable knowledge graph that AI assistants can read instead of grepping
+through files. The integration is **opt-in by installing `graphifyy` as its
+own tool** (the same way you installed issue-flow): there is no flag, no
+`.env` switch, no extras to remember. Detection is purely PATH-based.
+
+What `issue-flow` does when `graphify` is on PATH:
+
+- `issue-flow init` and `issue-flow update` run `graphify cursor install` so
+  the graphify Cursor skill is registered alongside the issue-flow scaffold.
+  If graphify is not installed, both commands just print install hints and
+  continue — they never block.
+- A new slash command `/build` (and matching `/issueflow-build` skill) wraps
+  `issue-flow build`, which forwards every argument to the `graphify` CLI
+  verbatim (`--update`, `--no-viz`, `--mode deep`, `--watch`, …).
+- The scaffolded rules and `/issue-start` mention `graphify-out/GRAPH_REPORT.md`
+  as a recommended pre-read when the file exists. `/build` is **off-path** —
+  `/iflow` never auto-dispatches to it.
+
+To enable, install graphify as its own standalone tool:
+
+```bash
+uv tool install graphifyy   # recommended
+# or
+pipx install graphifyy
+# or
+pip install graphifyy
+```
+
+> **Why not an `issue-flow[graphify]` extra (or `uv tool install issue-flow --with graphifyy`)?**
+> `uv tool install` only puts the **host package's** entry-point scripts on
+> PATH. An extra (or `--with graphifyy`) pulls graphifyy into issue-flow's
+> venv but leaves the `graphify` CLI invisible to the shell, so `/build`
+> and `graphify cursor install` would still fail. Installing graphify as
+> its own tool puts a real `graphify` shim on PATH and matches how we
+> treat `git` / `gh`.
+
+> **Just installed graphifyy and `issue-flow init` says it's still missing?**
+> uv prints `~/.local/bin is not on your PATH` after the first
+> `uv tool install`. Run `uv tool update-shell` (refreshes shell rc files),
+> then **restart your shell and Cursor** so the new PATH takes effect.
+> issue-flow's missing-CLI hint also detects this case and tells you the
+> exact directory to add.
+
+After installing, run `issue-flow update` once so the graphify Cursor skill
+gets registered.
+
+## Installation
+
+Requires Python 3.13+ and [uv](https://docs.astral.sh/uv/).
+
+```bash
+uv tool install issue-flow
+```
+
+Or add it as a dev dependency to your project:
+
+```bash
+uv add --dev issue-flow
+```
+
+## Quick start
+
+```bash
+cd your-project
+issue-flow init
+```
+
+That's it. Open the project in Cursor and start with `/iflow` (or step through `/issue-init`, `/issue-plan`, `/issue-start`, `/issue-close`, `/issue-cleanup` explicitly).
+
+## Usage
+
+```
+issue-flow init [PROJECT_DIR] [--force] [--skip-dep-check]
+issue-flow update [PROJECT_DIR] [--skip-dep-check]
+issue-flow build [PROJECT_DIR] [-- ...graphify args]
+```
+
+### `issue-flow init`
+
+| Argument / Option | Description |
+|---|---|
+| `PROJECT_DIR` | Project root directory. Defaults to `.` (current directory). |
+| `--force`, `-f` | Overwrite generated Cursor commands, rules, and workflow doc instead of skipping them. |
+| `--skip-dep-check` | Skip the external-CLI dependency check (`git`, `gh`) and the confirmation prompt that follows if anything is missing. Useful in automation. |
+
+Running `init` again without `--force` is safe: generated scaffold files that already exist are skipped, and **issue markdown under `.issueflows/` is never touched** by `init` or `update`. When the CLI detects an existing scaffold, it reminds you about `update` and `--force`.
+
+### `issue-flow update`
+
+| Argument / Option | Description |
+|---|---|
+| `PROJECT_DIR` | Project root directory. Defaults to `.` (current directory). |
+| `--skip-dep-check` | Skip the external-CLI dependency check (`git`, `gh`) and the confirmation prompt that follows if anything is missing. |
+
+Use `update` after upgrading the **issue-flow** package to refresh the packaged slash commands, Cursor rule, and `docs/cursor-issue-workflow.md` from the version you have installed. This **overwrites** those generated files (unlike a plain second `init`). It still does not modify arbitrary files under `.issueflows/` (for example your `issue*_original.md` / `issue*_status.md` files), and it creates any **new** `.issueflows/` subdirectories required by the current package.
+
+### `issue-flow build`
+
+| Argument / Option | Description |
+|---|---|
+| `PROJECT_DIR` | Project root directory to scan with graphify. Defaults to `.`. |
+| `...graphify args` | Any extra arguments are forwarded **verbatim** to the `graphify` CLI (`--update`, `--no-viz`, `--mode deep`, `--watch`, …). |
+
+`build` requires `graphifyy` to be installed (`uv tool install graphifyy`). When the `graphify` CLI is missing, the command prints install hints and exits with code `2`. Outputs land in `graphify-out/` (`graph.html`, `GRAPH_REPORT.md`, `graph.json`).
+
+### When to use which
+
+| Goal | Command |
+|---|---|
+| First-time setup, or add missing files only | `issue-flow init` |
+| Pull newer templates after `uv tool upgrade issue-flow` (or similar) | `issue-flow update` |
+| Replace generated scaffolds without upgrading logic | `issue-flow init --force` |
+| Rebuild the graphify knowledge graph | `issue-flow build` |
+
+## Configuration
+
+issue-flow reads a `.env` file from the project root (via python-dotenv). The following environment variables are supported:
+
+| Variable | Default | Description |
+|---|---|---|
+| `ISSUEFLOW_DIR` | `.issueflows` | Name of the issue-tracking directory. |
+| `ISSUEFLOW_AGENT_DIR` | `.cursor` | Name of the agent/IDE config directory (currently `.cursor`). |
+| `ISSUEFLOW_DOCS_DIR` | `docs` | Where to write the workflow documentation file. |
+| `ISSUEFLOW_HISTORY_FILE` | `HISTORY.md` | Changelog file that `/issue-close` updates (set to e.g. `CHANGELOG.md` for different conventions). |
+
+## Development
+
+```bash
+git clone https://github.com/jepegit/issue-flow.git
+cd issue-flow
+uv sync
+
+# Run tests
+uv run pytest
+
+# Lint
+uv run ruff check src/ tests/
+```
+
+## Changelog
+
+See [HISTORY.md](HISTORY.md) for release notes.
+
+## Future plans
+
+- **Multi-tool support** — generate config for other AI coding tools (Claude Code, Windsurf, etc.) in addition to Cursor.
+- **`issue-flow status`** — show a dashboard of current, partly-solved, and solved issues.
+- **Custom templates** — let users supply their own Jinja2 templates to tailor slash commands and rules to their team's conventions.
+- **Git hook integration** — optionally move issue files on commit based on status markers.
+- **GitHub Actions workflow** — ship a reusable action that syncs issue state between `.issueflows/` and GitHub issue labels/milestones.
+
+## License
+
+This project is released under the MIT License. See the full text in the repository: [LICENSE](https://github.com/jepegit/issue-flow/blob/main/LICENSE).

{issue_flow-0.2.2 → issue_flow-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "issue-flow"
-version = "0.2.2"
+version = "0.3.0"
 description = "Agents should behave. Let them follow the issue flow."
 readme = "README.md"
 license = "MIT"

issue_flow-0.3.0/src/issue_flow/cli.py

@@ -0,0 +1,114 @@
+"""Command-line interface for issue-flow."""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+import typer
+from rich.console import Console
+
+app = typer.Typer(
+    name="issue-flow",
+    add_completion=False,
+)
+
+_console = Console()
+
+
+@app.callback()
+def _callback() -> None:
+    """Agents should behave. Let them follow the issue flow."""
+
+
+@app.command()
+def init(
+    project_dir: Path = typer.Argument(
+        default=Path("."),
+        help="Project root directory (defaults to current directory).",
+        exists=True,
+        file_okay=False,
+        resolve_path=True,
+    ),
+    force: bool = typer.Option(
+        False,
+        "--force",
+        "-f",
+        help="Overwrite existing files without asking.",
+    ),
+    skip_dep_check: bool = typer.Option(
+        False,
+        "--skip-dep-check",
+        help=(
+            "Skip the external-CLI dependency check (git, gh) and the "
+            "confirmation prompt that follows if anything is missing."
+        ),
+    ),
+) -> None:
+    """Scaffold issue-flow directories and Cursor config files in a project."""
+    from issue_flow.init import run_init
+
+    run_init(
+        project_root=project_dir, force=force, skip_dep_check=skip_dep_check
+    )
+
+
+@app.command()
+def update(
+    project_dir: Path = typer.Argument(
+        default=Path("."),
+        help="Project root directory (defaults to current directory).",
+        exists=True,
+        file_okay=False,
+        resolve_path=True,
+    ),
+    skip_dep_check: bool = typer.Option(
+        False,
+        "--skip-dep-check",
+        help=(
+            "Skip the external-CLI dependency check (git, gh) and the "
+            "confirmation prompt that follows if anything is missing."
+        ),
+    ),
+) -> None:
+    """Refresh packaged Cursor commands, rules, and workflow doc from this package."""
+    from issue_flow.init import run_update
+
+    run_update(project_root=project_dir, skip_dep_check=skip_dep_check)
+
+
+@app.command(
+    context_settings={
+        "allow_extra_args": True,
+        "ignore_unknown_options": True,
+    },
+)
+def build(
+    ctx: typer.Context,
+    project_dir: Path = typer.Argument(
+        default=Path("."),
+        help=(
+            "Project root directory to scan with graphify. "
+            "Defaults to the current directory."
+        ),
+        exists=True,
+        file_okay=False,
+        resolve_path=True,
+    ),
+) -> None:
+    """Rebuild the graphify knowledge graph for the project.
+
+    Forwards every extra argument to the ``graphify`` CLI verbatim, so
+    flags like ``--update``, ``--no-viz``, ``--mode deep``, or
+    ``--watch`` pass straight through. Requires ``graphify`` to be on
+    ``PATH`` (install with ``uv tool install graphifyy``).
+    """
+    from issue_flow.graphify import run_build
+
+    exit_code = run_build(project_dir, ctx.args, _console)
+    if exit_code != 0:
+        raise typer.Exit(code=exit_code)
+
+
+def main() -> None:
+    """Entry point for the `issue-flow` console script."""
+    app()