{"_id":"@aathan807/rw-design","_rev":"2-72d9e15ec49bcaa4d10972de1482b14a","name":"@aathan807/rw-design","dist-tags":{"latest":"1.1.1"},"versions":{"1.0.0":{"name":"@aathan807/rw-design","version":"1.0.0","keywords":["design","cli","randomwalk","design-intelligence"],"author":{"name":"aathan807"},"license":"ISC","_id":"@aathan807/rw-design@1.0.0","maintainers":[{"name":"aathan807","email":"aathan807@gmail.com"}],"bin":{"rw-design":"index.js"},"dist":{"shasum":"eba11d9301299de295d0cc0bbdfaee6879537d71","tarball":"https://registry.npmjs.org/@aathan807/rw-design/-/rw-design-1.0.0.tgz","fileCount":15,"integrity":"sha512-LRkFdD2m3ZAurv4v83O5B/WCYl0NeE8Jlg0JTvRryN8I2yBcjojNT+ZjFFl3C2LoY10VFQMg4lErMsWIp2/YNw==","signatures":[{"sig":"MEQCIEzxhsEKOdc+P2wsYEBUbnpSy9PZT/B0ynoUWzD1zadNAiBdYJrcpNBn1XfQDTmTs0nIk90OQnHzzpkjVsbGrWY/PQ==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":31041},"main":"index.js","engines":{"node":">=18"},"gitHead":"f3d3e45ca88318691feb9a8ddcedc53feadc3241","scripts":{"test":"node --check index.js"},"_npmUser":{"name":"aathan807","email":"aathan807@gmail.com"},"_npmVersion":"10.9.2","description":"RandomWalk Design Intelligence CLI — installs versioned design knowledge into any project.","directories":{},"_nodeVersion":"22.14.0","dependencies":{"inquirer":"^14.0.2"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/rw-design_1.0.0_1784008679256_0.25983321713139684","host":"s3://npm-registry-packages-npm-production"}},"1.1.1":{"name":"@aathan807/rw-design","version":"1.1.1","description":"RandomWalk Design Intelligence CLI — installs versioned design knowledge into any project.","bin":{"rw-design":"index.js"},"main":"index.js","engines":{"node":">=18"},"publishConfig":{"access":"public"},"scripts":{"test":"node --check index.js"},"keywords":["design","cli","randomwalk","design-intelligence"],"author":{"name":"aathan807"},"license":"ISC","dependencies":{"inquirer":"^14.0.2"},"_id":"@aathan807/rw-design@1.1.1","gitHead":"41f916e1df866174d4caed43e597a8d3b18d540a","_nodeVersion":"22.14.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-/W7jVlx2d50m8GTRNfq9YP9AO54uuW9lH8GqYI5mlB0wLPBWvI9PeMKz/ska26Yk02ysiaL2hTXRc1KXblk30w==","shasum":"a2452d6b83754f5e26b72eb7b8c9c7be81f9cc7a","tarball":"https://registry.npmjs.org/@aathan807/rw-design/-/rw-design-1.1.1.tgz","fileCount":16,"unpackedSize":40499,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIF8eeqlqSvHe+kAoGFyJA1SXCEe8IGs8dt8oTWuF7FdaAiA09BfCH4B6hy3xV0g5tFuZvUD9eSSBwV1/xu9OYNE8kA=="}]},"_npmUser":{"name":"aathan807","email":"aathan807@gmail.com"},"directories":{},"maintainers":[{"name":"aathan807","email":"aathan807@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/rw-design_1.1.1_1787045010649_0.6992203340067975"},"_hasShrinkwrap":false}},"time":{"created":"2026-07-14T05:57:59.078Z","modified":"2026-08-18T09:23:31.015Z","1.0.0":"2026-07-14T05:57:59.394Z","1.1.1":"2026-08-18T09:23:30.803Z"},"author":{"name":"aathan807"},"license":"ISC","keywords":["design","cli","randomwalk","design-intelligence"],"description":"RandomWalk Design Intelligence CLI — installs versioned design knowledge into any project.","maintainers":[{"name":"aathan807","email":"aathan807@gmail.com"}],"readme":"# rw-design — RandomWalk Design Intelligence CLI\n\nInstalls versioned design knowledge (brand rules, tokens, components, patterns, UX\nconventions) from the private `rw-design-kb` GitHub repo into any project, as a\n`.design-intelligence/` folder that both humans and AI coding agents (Claude Code)\nread while building UI.\n\n```\nCentral KB (GitHub, private) → versioned → rw-design CLI → .design-intelligence/ in your project\n```\n\nnpm package: **`@aathan807/rw-design`** · Node **18+** required.\n\n---\n\n## 1. One-time setup\n\n### a) Get access to the KB repo (do NOT borrow anyone's keys)\n\nThe CLI reads the private repo `AathanRW/rw-design-kb` via the GitHub API, so you\nneed **your own** GitHub token with read access:\n\n1. Ask the repo owner to add your GitHub account as a collaborator on\n   `rw-design-kb` (Read is enough).\n2. Create your own token: GitHub → **Settings → Developer settings →\n   Fine-grained personal access tokens → Generate new token** →\n   Repository access: *Only select repositories* → `rw-design-kb` →\n   Permissions: **Contents: Read-only**. Copy it once — it's shown only once.\n\n> **Never share tokens or SSH keys between people.** A token identifies *you*; a\n> shared one breaks auditability and is a security risk. Each person makes their\n> own in two minutes.\n\n### b) Set the token in your environment\n\n```powershell\n# PowerShell — current session\n$env:GITHUB_TOKEN = \"github_pat_XXXX\"\n\n# PowerShell — persist for future sessions\n[Environment]::SetEnvironmentVariable(\"GITHUB_TOKEN\", \"github_pat_XXXX\", \"User\")\n```\n\n```bash\n# macOS / Linux (add to ~/.bashrc or ~/.zshrc to persist)\nexport GITHUB_TOKEN=\"github_pat_XXXX\"\n```\n\n### c) Install the CLI\n\n```bash\nnpm install -g @aathan807/rw-design\nrw-design            # prints usage → you're good\n```\n\n(No global install? `npx @aathan807/rw-design init` works too.)\n\n## 2. Daily use\n\nRun these **from the root of the project** you're building:\n\n| Command | What it does |\n|---|---|\n| `rw-design init` | Interactive first-time install — picks your product and writes `.design-intelligence/` (incl. a consolidated `DESIGN.md` entry file) |\n| `rw-design check` | Tells you if the KB has a newer version than what's installed |\n| `rw-design update` | Re-fetches everything and bumps your local version |\n| `rw-design list` | Browse every knowledge file available in the KB (by id) |\n| `rw-design pull <id>` | Install a single knowledge file plus its dependencies (e.g. `rw-design pull brand.knudge`) |\n\nTypical first run in a project:\n\n```bash\ncd my-project\nrw-design init          # answer the prompts (product, etc.)\n# → .design-intelligence/ created with DESIGN.md + the knowledge for your product\n```\n\nThen just build — point your AI agent (or yourself) at\n`.design-intelligence/DESIGN.md`; it is the authoritative entry file (tokens, brand\nrules, and an index into everything else). Run `rw-design check` occasionally and\n`rw-design update` when the design team ships changes.\n\n## 3. Troubleshooting\n\n| Symptom | Fix |\n|---|---|\n| `GITHUB_TOKEN is not configured` | Set the env var (§1b) in the *same* terminal you run the CLI from; restart the terminal if you used the persistent method |\n| `Unable to authenticate with GitHub` | Token expired/typoed, or it doesn't include `rw-design-kb` with Contents: Read |\n| `permission denied or rate limited` (403) | You're not a collaborator on the KB repo yet — ask the owner |\n| `Knowledge file not found` (404) | The KB moved/renamed something — run `rw-design list` to see current ids, or ask the design team |\n\n## 4. For maintainers\n\n- KB source of truth: `github.com/AathanRW/rw-design-kb` (see its `CONTRIBUTING.md`).\n- The CLI's source repo/branch is configured in `src/config/source.js`.\n- Publish a new CLI version: bump `package.json` version → `npm publish` (package is public; the *knowledge* stays private behind the GitHub token).\n","readmeFilename":"README.md"}