integral-mind 0.1.0

package/README.md

@@ -0,0 +1,52 @@
+# integral-mind
+
+CLI for [Integral Mind](https://github.com/nutter96/Integral-Mind) — push sessions, text, files, and URLs into your self-hosted knowledge base, search it, and inspect it over HTTPS. A thin HTTP client: no database, no parsers, one dependency.
+
+## Install
+
+```bash
+npm install -g integral-mind
+```
+
+Requires Node 20+. Installs two identical bins: `im` and `integral-mind`. Works on Linux, macOS, and Windows (the `sync repo` connector additionally needs `git` on PATH).
+
+## Quickstart
+
+```bash
+im config set url https://your-instance.example.com
+im config set token imk_...   # create one in the webapp: Settings → MCP tokens
+
+im push text "First captured note"
+im search "captured"
+```
+
+Environment variables `INTEGRAL_MIND_URL` and `INTEGRAL_MIND_TOKEN` override the config file, so headless/CI use needs no file at all.
+
+## Commands
+
+```text
+im config set <url|token> <value>   Store connection settings
+im config show                      Show effective config and its sources
+im push session [options]           Push a session envelope (redacted by default)
+im push text|file|url|youtube ...   Capture content
+im search <query> [options]         Hybrid search (--type --after --before --code --sessions)
+im sync <connector> [options]       Delta-sync a machine-local source (mempalace, obsidian, repo)
+im recent / im stats                Recently ingested sources / corpus statistics
+im projects|sources|tokens ...      Admin operations (admin token)
+im hooks install claude             Auto-push Claude Code sessions at session end
+im docs                             Print the full manual
+```
+
+Run `im docs` for the canonical manual, or `im docs --drop-in` for an AGENTS.md block you can paste into a repo.
+
+## Notes for Windows
+
+The config file lives at `~/.config/integral-mind/config.json` on every platform (that is `C:\Users\you\.config\integral-mind\` on Windows). On POSIX systems it is written mode `0600` because it holds a bearer token; on Windows the default location inherits your profile directory's per-user ACL instead. If you point `INTEGRAL_MIND_CONFIG_DIR` somewhere outside your profile on Windows, securing that directory is up to you — the CLI does not inspect ACLs.
+
+## Exit codes
+
+`0` success · `1` runtime failure · `2` usage error · `3` auth failure · `4` not found · `5` validation rejected
+
+## License
+
+MIT