{"_id":"@awareness.market/setup","_rev":"2-823d70d40df3f43b13cb86f6e3b579f8","name":"@awareness.market/setup","dist-tags":{"latest":"0.4.14"},"versions":{"0.4.13":{"name":"@awareness.market/setup","version":"0.4.13","keywords":["awareness","memory","mcp","ide","setup","claude","cursor","windsurf","cline","copilot","github-copilot","codex"],"license":"MIT","_id":"@awareness.market/setup@0.4.13","maintainers":[{"name":"everestan","email":"everest9812@gmail.com"}],"homepage":"https://github.com/everest-an/Awareness-SDK#readme","bugs":{"url":"https://github.com/everest-an/Awareness-SDK/issues"},"bin":{"awareness-setup":"src/cli.mjs"},"dist":{"shasum":"f90efbcb7afe854fbd512bd2b7e77c8e0e64d316","tarball":"https://registry.npmjs.org/@awareness.market/setup/-/setup-0.4.13.tgz","fileCount":7,"integrity":"sha512-1tfYQ57TvgHWwe3AneCA/RzGGHonp8mH3nfDhsNNgvvcN3QgFA4qwp1aCalC++/ZpXYWq+2PKyZBDwJ82e3qbQ==","signatures":[{"sig":"MEYCIQC7x8TZMyP3BGT//8WIXKJrSjcqU+0qtNdFnxjlaoDjYwIhANfiU0MMy6kfsQhST6GSgQZfo38qHaOzjHMHgRcZHB7n","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":126213},"type":"module","engines":{"node":">=16"},"gitHead":"64421ce693ca09cbf681d7fc52de36d9b4d27938","scripts":{"test":"node --test tests/*.test.cjs","ship-gate":"npm run ship-gate:L1 && npm run ship-gate:L2 && npm run ship-gate:L3","ship-gate:L1":"node -e \"const fs=require('fs'),cp=require('child_process');const walk=(d,out=[])=>{for(const e of fs.readdirSync(d,{withFileTypes:true})){const p=d+'/'+e.name;e.isDirectory()?walk(p,out):/\\.(m?js|cjs)$/.test(e.name)&&out.push(p)}return out};const files=walk('src');files.forEach(f=>cp.execSync('node -c '+f));console.log('L1 syntax OK ('+files.length+' files)')\"","ship-gate:L2":"npm run test","ship-gate:L3":"echo 'L3 chaos: headless-auth timeout/5xx covered in tests/cli.test.cjs (headless-auth-* suites)'","prepublishOnly":"npm run ship-gate"},"_npmUser":{"name":"everestan","email":"everest9812@gmail.com"},"repository":{"url":"git+https://github.com/everest-an/Awareness-SDK.git","type":"git","directory":"setup-cli"},"_npmVersion":"11.6.2","description":"CLI tool to inject Awareness Memory workflow rules into IDE config files","directories":{},"_nodeVersion":"24.12.0","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/setup_0.4.13_1783841476801_0.02686245194666781","host":"s3://npm-registry-packages-npm-production"}},"0.4.14":{"name":"@awareness.market/setup","version":"0.4.14","description":"CLI tool to inject Awareness Memory workflow rules into IDE config files","bin":{"awareness-setup":"src/cli.mjs"},"type":"module","keywords":["awareness","memory","mcp","ide","setup","claude","cursor","windsurf","cline","copilot","github-copilot","codex"],"license":"MIT","publishConfig":{"access":"public"},"repository":{"type":"git","url":"git+https://github.com/everest-an/Awareness-SDK.git"},"engines":{"node":">=16"},"scripts":{"test":"node --test tests/*.test.cjs","ship-gate:L1":"node -e \"const fs=require('fs'),cp=require('child_process');const walk=(d,out=[])=>{for(const e of fs.readdirSync(d,{withFileTypes:true})){const p=d+'/'+e.name;e.isDirectory()?walk(p,out):/\\.(m?js|cjs)$/.test(e.name)&&out.push(p)}return out};const files=walk('src');files.forEach(f=>cp.execSync('node -c '+f));console.log('L1 syntax OK ('+files.length+' files)')\"","ship-gate:L2":"npm run test","ship-gate:L3":"echo 'L3 chaos: headless-auth timeout/5xx covered in tests/cli.test.cjs (headless-auth-* suites)'","ship-gate":"npm run ship-gate:L1 && npm run ship-gate:L2 && npm run ship-gate:L3","prepublishOnly":"npm run ship-gate"},"bugs":{"url":"https://github.com/everest-an/Awareness-SDK/issues"},"homepage":"https://awareness.market","gitHead":"8d5621ecca317f348673a8b3b4b5be2a45252c9e","_id":"@awareness.market/setup@0.4.14","_nodeVersion":"24.12.0","_npmVersion":"11.6.2","dist":{"integrity":"sha512-3/Fs/ddV0x4pzhkVeaBTcTzMRkbjPC8aGC3bGC7xgjNKY+SBWP7ODBnWVQ8LLvQkH9gaOSwaQy5bRfWJrIm2sQ==","shasum":"7dc9c0e2dfa732dc7012cb56d63c913222289698","tarball":"https://registry.npmjs.org/@awareness.market/setup/-/setup-0.4.14.tgz","fileCount":7,"unpackedSize":128297,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQC5k36hxWCo1o3qdnRqO9Nbk7Zj+dwxhQCDUCvFTB5gIAIgX18Z5VCycgk61PKgzRG5mU711Z1wEm/fpZawpxQ2NMA="}]},"_npmUser":{"name":"everestan","email":"everest9812@gmail.com"},"directories":{},"maintainers":[{"name":"everestan","email":"everest9812@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/setup_0.4.14_1787865131768_0.07254584098052241"},"_hasShrinkwrap":false}},"time":{"created":"2026-07-12T07:31:16.603Z","modified":"2026-08-27T21:12:12.114Z","0.4.13":"2026-07-12T07:31:16.938Z","0.4.14":"2026-08-27T21:12:11.906Z"},"bugs":{"url":"https://github.com/everest-an/Awareness-SDK/issues"},"license":"MIT","homepage":"https://awareness.market","keywords":["awareness","memory","mcp","ide","setup","claude","cursor","windsurf","cline","copilot","github-copilot","codex"],"repository":{"type":"git","url":"git+https://github.com/everest-an/Awareness-SDK.git"},"description":"CLI tool to inject Awareness Memory workflow rules into IDE config files","maintainers":[{"name":"everestan","email":"everest9812@gmail.com"}],"readme":"# @awareness.market/setup\n\n[![npm](https://img.shields.io/npm/v/@awareness.market/setup?color=22c55e)](https://www.npmjs.com/package/@awareness.market/setup) [![Discord](https://img.shields.io/badge/Discord-Join%20Community-5865F2?style=flat&logo=discord&logoColor=white)](https://discord.com/invite/nMDrT538Qa)\n\n**One command to give your AI agent persistent memory. 13+ IDEs supported.**\n\n```bash\nnpx @awareness.market/setup\n```\n\nAuto-detects your IDE, starts a local memory daemon, injects workflow rules, and configures MCP — all in one command. No account needed. Works offline.\n\n---\n\n## How It Works\n\n```\nnpx @awareness.market/setup\n    │\n    ├── Detects IDE (Cursor? Claude Code? Windsurf? ...)\n    ├── Starts local daemon (localhost:37800)\n    ├── Writes workflow rules (teaches agent when to recall/record)\n    ├── Writes MCP config (connects agent to memory daemon)\n    └── Done ✅ — your agent now has persistent memory\n```\n\n## Modes\n\n### Local Mode (Default)\n\n```bash\nnpx @awareness.market/setup\n```\n\n- Starts a local daemon on `localhost:37800`\n- Memories stored as Markdown files in `.awareness/`\n- No account, no cloud, no API key needed\n- Works offline\n\n### Cloud Mode\n\n```bash\nnpx @awareness.market/setup --cloud\n```\n\n- Opens browser for device-auth login\n- Select or create a memory entity\n- Enables cloud sync (semantic search, team collaboration, memory marketplace)\n- Local daemon still runs — cloud is a sync layer, not a replacement\n\n## Supported IDEs\n\n| IDE | Rules File | MCP Config |\n|-----|-----------|------------|\n| **Cursor** | `.cursor/rules/awareness.mdc` | `.cursor/mcp.json` |\n| **Claude Code** | `CLAUDE.md` | `.mcp.json` |\n| **Windsurf** | `.windsurfrules` | `~/.codeium/windsurf/mcp_config.json` |\n| **Cline** | `.clinerules` | UI-based (copy-paste) |\n| **GitHub Copilot** | `.github/copilot-instructions.md` | `.vscode/mcp.json` |\n| **Codex CLI** | `AGENTS.md` | `.codex/config.toml` |\n| **Kiro** | `.kiro/steering/awareness.md` | `.kiro/settings/mcp.json` |\n| **Trae** | `.trae/rules/awareness.md` | `.trae/mcp.json` |\n| **Zed** | `.rules` | `~/.config/zed/settings.json` |\n| **JetBrains (Junie)** | `.junie/guidelines.md` | `.junie/mcp/mcp.json` |\n| **Augment** | `.augment/rules/awareness.md` | UI-based (copy-paste) |\n| **AntiGravity (Jules)** | `.antigravity/rules.md` | `~/.gemini/antigravity/mcp_config.json` |\n| **OpenClaw** | Plugin-based | `~/.openclaw/openclaw.json` |\n\n## All Options\n\n```\nnpx @awareness.market/setup                 Local mode (default)\nnpx @awareness.market/setup --cloud         Cloud mode (login + sync)\nnpx @awareness.market/setup --ide cursor    Force specific IDE\nnpx @awareness.market/setup --no-auth       Rules only, no MCP config\nnpx @awareness.market/setup --dry-run       Preview without writing\nnpx @awareness.market/setup --force         Overwrite managed files\nnpx @awareness.market/setup --list          Show supported IDEs\nnpx @awareness.market/setup --logout        Clear saved credentials\nnpx @awareness.market/setup --api-base <url>  Custom API URL\n```\n\n### Manual Cloud Config\n\n```bash\nnpx @awareness.market/setup --mcp-url <url> --api-key <key> --memory-id <id>\n```\n\n## Non-Interactive Mode\n\nWhen run without a TTY (e.g., from an AI agent via Bash), the CLI auto-selects all detected IDEs and defaults to English embedding model. No prompts.\n\n## Embedding Language\n\nDuring interactive setup, you can choose:\n\n```\nSearch language:\n  1. English only  (23 MB, faster)      ← default\n  2. All languages (118 MB, 中文/日本語/한국어...)\n```\n\n## What It Writes\n\n### Workflow Rules\n\nInjected into your IDE's rules file (e.g., `CLAUDE.md`, `.cursor/rules/awareness.mdc`). Teaches your AI agent to:\n- Call `awareness_init` at session start\n- Call `awareness_recall` before making decisions\n- Call `awareness_record` after every code change\n\n### MCP Config\n\nConnects your IDE to the memory daemon:\n\n```json\n{\n  \"mcpServers\": {\n    \"awareness-memory\": {\n      \"url\": \"http://localhost:37800/mcp\"\n    }\n  }\n}\n```\n\n## Related Packages\n\n| Package | Description |\n|---------|-------------|\n| [`@awareness.market/local`](https://www.npmjs.com/package/@awareness.market/local) | Local daemon that this CLI starts |\n| [`@awareness-sdk/memory-cloud`](https://www.npmjs.com/package/@awareness-sdk/memory-cloud) | TypeScript SDK with interceptors |\n| [`awareness-memory-cloud`](https://pypi.org/project/awareness-memory-cloud/) | Python SDK with interceptors |\n| [`@awareness.market/openclaw-memory`](https://www.npmjs.com/package/@awareness.market/openclaw-memory) | OpenClaw plugin |\n\n## What makes Awareness different\n\nMost memory systems pick one extraction strategy. Awareness combines them:\n\n- **Hybrid retrieval by default** — BM25 full-text + vector cosine + knowledge-graph 1-hop expansion, fused with Reciprocal Rank Fusion. 96.0% R@5 on LongMemEval, zero LLM calls on the retrieval side.\n- **Salience-aware extraction** (v0.4.7+) — the client's LLM self-scores every card on `novelty` / `durability` / `specificity`; cards below 0.4 on novelty or durability are dropped server-side. Framework metadata is filtered before extraction runs, so raw logs never leak into your knowledge base.\n- **Project isolation** — `X-Awareness-Project-Dir` header scopes memory per project.\n- **Zero-LLM backend** — all extraction runs on the client's LLM. No inference costs pass through to you.\n- **One memory, many clients** — same daemon reachable via Claude Code / Cursor / Windsurf / OpenClaw / plain MCP.\n\nSee [`docs/analysis/MEMPALACE_COMPARISON_2026-04-17.md`](https://github.com/everest-an/Awareness/blob/main/docs/analysis/MEMPALACE_COMPARISON_2026-04-17.md) for the honest side-by-side against MemPalace (96.6% R@5 via raw verbatim storage).\n\n## License\n\nApache 2.0\n","readmeFilename":"README.md"}