@remnic/cli 1.0.2 → 1.0.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Joshua Warren
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,77 @@
+# @remnic/cli
+
+CLI for Remnic memory -- init, query, daemon management, connectors, curation, and more.
+
+Part of [Remnic](https://github.com/joshuaswarren/remnic), the universal memory layer for AI agents.
+
+## Install
+
+```bash
+npm install -g @remnic/cli
+```
+
+This installs the `remnic` command (and a legacy `engram` forwarder).
+
+## Quick start
+
+```bash
+remnic init                     # Create remnic.config.json
+export OPENAI_API_KEY=sk-...
+export REMNIC_AUTH_TOKEN=$(openssl rand -hex 32)
+remnic daemon start             # Start background server
+remnic status                   # Verify it's running
+remnic query "hello" --explain  # Test query with tier breakdown
+```
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `remnic init` | Create a config file |
+| `remnic daemon start/stop/status` | Manage the background server |
+| `remnic query <text>` | Search memories |
+| `remnic doctor` | Diagnose configuration issues |
+| `remnic connectors install <name>` | Connect Claude Code, Codex CLI, Replit, etc. |
+| `remnic curate` | Interactive memory curation |
+| `remnic dedup` | Find and merge duplicate memories |
+| `remnic sync` | Diff-aware sync with external sources |
+| `remnic spaces` | Manage memory namespaces |
+| `remnic bench list` | List published benchmark packs |
+| `remnic bench run` | Run one or more published benchmark packs |
+
+Run `remnic --help` for the full command list.
+
+## Benchmarks
+
+The phase-1 benchmark surface is exposed through `remnic bench`, with `remnic benchmark`
+kept as a compatibility alias.
+
+```bash
+remnic bench list
+remnic bench run --quick longmemeval
+remnic bench run longmemeval --dataset-dir ~/datasets/longmemeval
+remnic benchmark run --quick longmemeval
+```
+
+`--quick` uses the lightweight benchmark path with a single-item limit so you can
+smoke-test the harness without running a full benchmark pass. When a benchmark
+ships a bundled smoke fixture, `--quick` uses that tracked fixture by default;
+full runs need a real benchmark dataset. In a repo checkout the CLI will use
+`evals/datasets/<benchmark>` automatically; in packaged installs pass
+`--dataset-dir <path>` explicitly.
+
+## Connecting agents
+
+Once the daemon is running, connect any supported agent:
+
+```bash
+remnic connectors install claude-code   # Claude Code (hooks + MCP)
+remnic connectors install codex-cli     # Codex CLI (hooks + MCP)
+remnic connectors install replit        # Replit (MCP only)
+```
+
+All agents share the same memory store.
+
+## License
+
+MIT