Skip to main content

Prompt pack manager to install AGENTS snippets and .agent templates (ExecPlan and more)

Project description

promptkitx

Prompt pack manager that drops AGENTS snippets and .agent templates into a repo. Ships with the ExecPlan pack and is ready to host more packs later.

Quick use (no install)

  • Python/uvx (PyPI): uvx promptkitx install execplan
  • Python/uvx (from GitHub tip): uvx --from git+https://github.com/mikewong23571/promptkit.git promptkit install execplan
  • Node/npx: npx promptkitx install execplan

Both commands are idempotent and cache their envs. Add -p /path/to/repo to target another repo and --force to overwrite existing files.

Install (optional)

  • Python: pip install promptkitx or pipx install promptkitx
  • Node: npm install -g promptkitx (or use npx per above)

Commands (Python & Node CLIs)

  • promptkit list [-p PATH] — show available built-in packs and installed packs in PATH (default .)
  • promptkit install <pack> [-p PATH] [--force] — install/update a pack (built-in: execplan)

Pack spec (v1)

Each pack lives under src/promptkit_builtin_packs/<name>/ and contains:

  • pack.json — metadata
    • name, version, description
    • agents_entry: relative path to the snippet inserted into AGENTS.md
    • files: array of { "source": "files/PLANS.md", "target": ".agent/PLANS.md" }
  • agents_snippet.md — the text dropped into AGENTS.md
  • files/ — tree of files copied to repo root respecting target paths

Install metadata is recorded in .agent/promptkit/registry.json (per repo). AGENTS.md is updated inside a managed block <!-- promptkit:start --> ... <!-- promptkit:end -->, so multiple packs stay tidy.

Built-in pack: execplan

  • Adds the ExecPlans rule to AGENTS.md.
  • Writes .agent/PLANS.md containing the full Codex ExecPlan spec (living-plan guidance, milestones, validation, etc.).

Road to PyPI & npm

This repo is structured to publish both:

  • PyPI: package name promptkit exposes the Python CLI (promptkit). Works with uvx promptkit ... once published.
  • npm: package promptkit exposes the Node CLI (promptkit). Works with npx promptkit ....

Development notes

  • Python package data lives in src/promptkit_builtin_packs/ and is included via MANIFEST.in.
  • Node CLI reads the same pack data from src/promptkit_builtin_packs/ to stay in sync.
  • Quality tools:
    • Make (recommended): make lint, make format, make typecheck, or make all (runs lint+typecheck). Requires uvx available and npm install for JS dev deps.
    • Python direct: uvx ruff check ., uvx black ., uvx mypy src (deps in optional-dependencies.dev).
    • Node direct: npm run lint, npm run format, npm run typecheck.

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

promptkitx-0.1.1.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

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

promptkitx-0.1.1-py3-none-any.whl (13.8 kB view details)

Uploaded Python 3

File details

Details for the file promptkitx-0.1.1.tar.gz.

File metadata

  • Download URL: promptkitx-0.1.1.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for promptkitx-0.1.1.tar.gz
Algorithm Hash digest
SHA256 1940eb2a3fe1464938764aea3dd6f8494e00192cf80383a1c9236f45548ac18c
MD5 f4de95dfced4e2f94357a5a01cf9df1b
BLAKE2b-256 335aaa713048529b21090ad975d099a93fe7b7e1b7dc2248a5459f6b2f923dd5

See more details on using hashes here.

File details

Details for the file promptkitx-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: promptkitx-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 13.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for promptkitx-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8aba5ecb2cd754266c58c39bb93da7f53da203aff3395377133a3931fd647aa2
MD5 2247c363eea829465c28c3493b77fa19
BLAKE2b-256 308eabba6dd3b29c3600f8d042455190cbcca282940afca7abb182df95fd1d8a

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