Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 3.86 KB

README.md

File metadata and controls

41 lines (30 loc) · 3.86 KB

PHARN CLI documentation

pharn installs PHARN — a workflow for shipping features right with Claude Code — into your project. Run pharn init to detect your project's archetype(s) and install the applicable PHARN capabilities (grillers + lenses) from pharn-dev/pharn-oss, alongside the fixed product surfaces: the pharn-* commands and .cjs/.mjs hooks under .claude/, the contracts, pharn-core and floor checkers, four trusted docs, upstream's LICENSE copy, and the product-loop boundary contract at pharn/features/README.md. It then writes pharn.config.json and pharn.records.json.

The install copies what upstream's pharn-install.json declares, in the pharn layout: everything under pharn/ except .claude/ and the two JSON files at the project root. A pharn-oss older than 7.21.0 ships no pharn-install.json and is refused. The legacy flat layout (everything at the root) was removed in v0.21.0: a project still recorded at it is asked to re-run pharn init (support policy).

The CLI version (pharn --version) and the content version it installs (skillsVersion, from upstream's SKILLS_VERSION) are independent numbers — status and update are keyed to the latter.

Getting started

Commands

  • init — detect archetypes and install capabilities (the default command)
  • add — add a single capability to an existing project
  • remove (alias rm) — remove an installed capability from an existing project
  • uninstall — remove PHARN, deleting only the files pharn wrote and you did not change
  • update — re-fetch installed capabilities at the latest skills version
  • list — list installed archetypes + capabilities
  • status — read-only version + local-drift check; --strict exits 1 on an outdated install, a modified, missing or unreadable file, a surface upstream no longer ships, or an unwired hook (the full list), and neither status nor list is ever blocked by another pharn run's lock

Reference

  • pharn.config.json — config file schema and overwrite behavior
  • pharn.records.json — the per-file install hashes pharn update compares against
  • JSON output — the --json reports of init, update, status and list: keys, stability rule, real examples
  • What PHARN deletes — every path a pharn command deletes, the check behind each, and what is never deleted
  • update: less common situations — the executable unit, orphans, the models block, unreadable or missing files, and the other states most pharn update runs never meet
  • The project lock — pharn/.lock: who takes it, why, and when a stale one is broken
  • Support policy — which installs and pharn versions are supported, and what is being retired when

Other

  • Agent skills — the optional pharn-cli skill that runs these commands for you from Claude Code
  • Troubleshooting — common failures and PHARN_DEBUG
  • Roadmap — what's shipped and what's planned
  • Contributing — developing the CLI and keeping docs in sync
  • Contributor guide — quality gates, test map, and the security-sensitive modules
  • Architecture — how the commands and modules fit together, for maintainers
  • Releasing — maintainer release steps and Trusted Publishing