Metadata-Version: 2.4
Name: uiplan
Version: 0.2.0
Summary: Lightweight UiPlan kit with MCP plan tools and scaffolding
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: mcp>=1.0.0
Requires-Dist: pyyaml>=6.0.2
Requires-Dist: typer>=0.15.1
Requires-Dist: rich>=13.9.4
Requires-Dist: httpx>=0.28.1

# UiPlan Light Kit

Lightweight distribution of UiPlan planning tools and helper files.

## Install and initialize

```powershell
uvx --from uiplan uiplan init --ai cursor
```

For immediate local use from this repository (before publish):

```powershell
uv run --project packages/uiplan-kit uiplan init --here --ai cursor --engine
```

Options:

- `--ai cursor|claude|copilot|all` selects command/skill wrappers to scaffold.
- `--engine` (default) writes `.cursor/mcp.json` entry for `uiplan-mcp`.
- `--static` scaffolds docs/templates only, without MCP server wiring.
- `--from-release <tag>` pulls assets from `uiplan-kit-<tag>.zip`.
- `--force` overwrites existing scaffolded files.

## Commands

- `uiplan init [PATH]`
- `uiplan check`
- `uiplan version`
- `uiplan-mcp` (stdio MCP server exposing `uipath_plan_*` tools)

## What gets installed

- `templates/uiplan/`
- `docs/uiplan/`
- `docs/plans/constitution.md` (seeded if missing)
- `.cursor/skills/uiplan*/SKILL.md` (for Cursor mode)
- optional `.claude/commands/` and `.github/copilot/` wrappers

## Uninstall

Delete scaffolded files and remove `uiplan` server from `.cursor/mcp.json`.

## Releasing a new version

See [`RELEASING.md`](RELEASING.md) for the version bump, clean-room test, and
publish steps.
