Metadata-Version: 2.4
Name: uiplan
Version: 0.3.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.

## Prerequisite: UiPath skills CLI

The UiPlan plan/implement flow routes through the official UiPath skills
(`uipath-planner`, `uipath-project-discovery-agent`, and specialist skills),
delivered by the `@uipath/cli` npm package. Install it once (needs
[Node.js](https://nodejs.org)):

```powershell
npm install -g @uipath/cli
uip skills install --agent cursor   # fetch the UiPath skill catalog (refresh: uip skills update)
```

`uiplan check` reports whether `node`, `npm`, and `uip` are available; `uiplan
init` warns if the UiPath CLI is missing. UiPlan grounding then **discovers the
installed skills dynamically** (from `.cursor/rules/` for Cursor or
`.claude/skills/` for Claude) and routes the generated plan only to skills that
actually exist.

## 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)

## Using it (after install)

`uiplan init` scaffolds files and registers the MCP server; it does not generate
a plan by itself. Reopen your editor so the `uiplan` MCP server in
`.cursor/mcp.json` is picked up, then drive the spec-kit-style lifecycle from
chat:

```text
/uiplan-constitution        project guardrails (once per repo)
/uiplan-ground <topic>      gather context
/uiplan-specify <title> --intent "<goal>"   (alias: /uiplan-spec)
/uiplan-clarify <slug>      resolve open questions
/uiplan-plan <slug>
/uiplan-tasks <slug>
/uiplan-analyze <slug>      cross-artifact consistency gate (read-only)
/uiplan-review <slug> all
/uiplan-implement <slug>    execution handoff (run analyze first)
```

Bundles are written to `.cursor/plans/<slug>/` as `spec.md`, `plan.md`, and
`tasks.md`. No PyPI login is needed to use the kit; tokens are only for
publishing (see `RELEASING.md`).

## 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.
