Skip to content

Latest commit

 

History

History
33 lines (22 loc) · 2.52 KB

File metadata and controls

33 lines (22 loc) · 2.52 KB

PHARN CLI documentation

pharn installs PHARN — an audit-grade methodology for 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 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 mirrors whichever layout upstream ships. Today that is the pharn layout: most surfaces move under pharn/, while THREAT-MODEL.md, LIMITS.md, and .claude/ stay at the project root. The legacy flat layout keeps everything at the root; an install records which one it used in pharn.config.json.

The CLI version (0.5.0) 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
  • update — re-fetch installed capabilities at the latest skills version
  • list — list installed archetypes + capabilities
  • status — read-only version + local-drift audit; --strict exits 1 on any outdated/modified/missing/unreadable file, and neither status nor list is ever blocked by another pharn run's lock

Reference

Other

  • 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
  • Releasing — maintainer release steps and Trusted Publishing