Quickstart

You'll need Node ≥ 22 and a GitHub account.

1. Claim a scope

Packs live under @scope/name. Sign in with GitHub and claim your scope on the hub — one scope per account, renameable later.

npx rulepack login

This opens your browser, you approve the session, and the CLI stores a token at ~/.rulepackrc.

2. Scaffold a pack

Run init in the project whose memories you want to share. It discovers existing agent files, asks which memories the pack should include, and writes a rulepack.json at the root.

npx rulepack init

{
  "name": "@ichi/nextjs",
  "version": "0.1.0",
  "license": "MIT",
  "visibility": "public",
  "memories": {
    "agents": "AGENTS.md",
    "claude": "CLAUDE.md",
    "cursor": ".cursor/rules/main.mdc"
  },
  "files": ["rulepack.json", "README.md", "LICENSE", "AGENTS.md", "CLAUDE.md", ".cursor/rules/**"]
}

3. Publish

Publishing packs the declared files into a tarball, validates the manifest, and uploads it. Versions are immutable — bump version for every release.

npx rulepack publish

4. Install anywhere

npx rulepack add @ichi/nextjs

The memory files land in the consumer project and the dependency is recorded in that project's rulepack.json.