memroot 0.1.0-alpha.0

package/README.md

@@ -0,0 +1,32 @@
+# Memroot
+
+Install native Memroot plugins for Claude Code, Codex, and Grok:
+
+```sh
+npx memroot setup
+```
+
+Requires Node.js 22 or later on macOS or Linux and an installed agent CLI with native plugin support. The interactive setup detects agent CLIs, lets you select agents, and previews the user-scope installation. Cancel before confirming to leave your files unchanged.
+
+**This is an installer alpha.** The plugins provide integration status and static startup guidance. Cloud sign-in, memory retrieval, session capture, and extraction are not available in this release. Installing a plugin does not connect cloud memory. No credentials or transcripts are collected or uploaded.
+
+For scripts:
+
+```sh
+npx memroot setup --agent codex --yes
+npx memroot setup --agent claude --agent grok --yes
+npx memroot setup --agent codex --yes --dry-run
+npx memroot doctor
+```
+
+Agent values are `claude`, `codex`, and `grok`. `--agent` can be repeated. `--yes` requires explicit agents. `--dry-run` prints planned commands without running an agent CLI or writing files.
+
+Plugin files live under `$XDG_DATA_HOME/memroot`, defaulting to `~/.local/share/memroot`, independently of the npm cache. Setup delegates registration and installation to each agent's native plugin manager and keeps a separate success receipt for each agent. It preserves unrelated config and refuses conflicting marketplaces, modified managed files, and disabled installed plugins. Repeating setup verifies files and repairs a missing native installation. Native enablement and hook execution trust stay under the agent's control. Grok setup uses its native `--trust` flag to authorize the selected local Memroot plugin; this alpha has no Grok lifecycle hooks.
+
+`doctor` checks managed file integrity and native plugin presence. Restart your coding agent after setup. Use the installed Memroot status skill to inspect release capabilities.
+
+If an agent command fails, update that agent and inspect its `plugin --help`. Native plugin managers may partially register a marketplace before installation fails; setup writes no success receipt for that attempt. Retry after resolving the native error. Installation is serialized by a lock; after an interrupted process, verify no setup is running before removing the `.setup-lock` directory named by the error.
+
+To remove the integration, use the agent's native plugin manager. This release deliberately does not remove native config or managed files automatically. Windows installation is not supported in this alpha.
+
+[Memroot](https://memroot.dev)