Skip to main content

Lightweight UiPlan kit with MCP plan tools and scaffolding

Project description

UiPlan Light Kit

Lightweight distribution of UiPlan planning tools and helper files.

Install and initialize

uvx --from uiplan uiplan init --ai cursor

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

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 for the version bump, clean-room test, and publish steps.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

uiplan-0.2.0.tar.gz (119.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

uiplan-0.2.0-py3-none-any.whl (137.6 kB view details)

Uploaded Python 3

File details

Details for the file uiplan-0.2.0.tar.gz.

File metadata

  • Download URL: uiplan-0.2.0.tar.gz
  • Upload date:
  • Size: 119.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for uiplan-0.2.0.tar.gz
Algorithm Hash digest
SHA256 053bbce27a34e81d7ebbc71eb250da76f951424fe819f59f1660d2cffcf590e5
MD5 7219824ea761a4cd02b9a83cb19dde79
BLAKE2b-256 91809d8be0a3cf1263def5b4d0144945e71821db9ca47903d00ef2d52dd982f5

See more details on using hashes here.

File details

Details for the file uiplan-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: uiplan-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 137.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for uiplan-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0d0657fb24c9225e9f37e1e28b4ce24db985e1f784405acd122e1ecd370d52b3
MD5 526e56e0f08da3d593db07794b9e9ac8
BLAKE2b-256 a7be786b8d11ab969e88ed906691a969477e1706f27a6bac7aac006dc1e6ba37

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page