vault-cortex 0.6.0 → 0.6.1

package/README.md

@@ -7,48 +7,62 @@ for your Obsidian vault in one command:
 npx vault-cortex@latest init
 ```
 
-Vault Cortex is a standalone, remote-capable MCP server for Obsidian vaults —
-Tools for hybrid search (FTS5 + vector + cross-encoder reranking, with
-tag/folder/property/date filters), notes, frontmatter, links, daily notes,
-Kanban-aware task management (query + complete/move/reprioritize, parsing Tasks-plugin emoji + Dataview inline-field formats), and
-a structured memory layer with topic recall (the current take plus the
-dated history behind it), plus guided prompts (orientation, memory
-review, daily review). It runs as a Docker
-container; this CLI scaffolds the config so you don't have to.
+Vault Cortex is a standalone, remote-capable MCP server that gives any AI
+agent hybrid search, task management, structured memory, and read/write
+access to your Obsidian vault — see the
+[full feature overview](https://github.com/aliasunder/vault-cortex#what-you-get).
+The server runs as a Docker container; this CLI scaffolds the config and
+manages the container so you don't have to.
 
-## What `init` does
+![npx vault-cortex init — the interactive setup wizard picks a mode, finds your vault, generates the config, and starts the server](https://raw.githubusercontent.com/aliasunder/vault-cortex/main/assets/demo-cli-init.gif)
+
+## Commands
+
+- [`init`](#init) — interactive setup: scaffold the config, generate the auth
+  token, start the server
+- [`upgrade`](#upgrade) — pull the latest image and re-create the container;
+  your data stays
+- [`get-sync-token`](#get-sync-token) — generate an Obsidian Sync auth token
+  for remote setups
+
+Run `npx vault-cortex <command> --help` for all flags.
+
+## init
+
+```bash
+npx vault-cortex@latest init
+```
+
+What it does:
 
 1. Asks how you want to run it:
    - **Local** — Docker on this machine, your vault folder bind-mounted
-   - **Remote** — a VPS with [Obsidian Sync](https://obsidian.md/sync), reachable from any device
+   - **Remote** — a VPS with [Obsidian Sync](https://obsidian.md/sync),
+     reachable from any device
 2. Generates a `.env` file with a securely generated `MCP_AUTH_TOKEN`
 3. Optionally starts the container and waits for the health check
 4. Prints your connection details — the MCP URL, your auth token, and how to
    connect your client
 
-Existing files are never overwritten without asking.
+Existing files are never overwritten without asking. During a remote setup,
+init offers to run [`get-sync-token`](#get-sync-token) for you when Docker is
+available.
 
-## Get Sync Token
+Flags:
 
-Generate an Obsidian Sync auth token without leaving the CLI:
+- `--mode local|remote` — skip the mode prompt
+- `--vault-path <path>` — absolute path to your vault (local mode)
+- `--dir <path>` — directory to write config files into (default
+  `./vault-cortex`)
+- `--yes` — non-interactive local setup with defaults; requires `--vault-path`
 
-```bash
-npx vault-cortex get-sync-token
-```
-
-The command opens the Obsidian login inside Docker. Once you've signed
-in, it captures your token and prints it — nothing to dig out of the
-login output. Use `--dir` to write the token straight into an existing
-`.env` instead:
+Non-interactive example:
 
 ```bash
-npx vault-cortex get-sync-token --dir ./vault-cortex
+npx vault-cortex@latest init --yes --vault-path /path/to/YourVault
 ```
 
-During `init --mode remote`, this flow is offered automatically when Docker
-is available.
-
-## Upgrade
+## upgrade
 
 Pull the latest image, re-create the container, and verify health:
 
@@ -60,27 +74,45 @@ Run it from the same directory where you ran `init` — it looks for your
 config in `./vault-cortex/.env` (pass `--dir <path>` if you scaffolded
 somewhere else).
 
-Your vault data, search index, and `.env` settings are preserved across
-upgrades — only the server image is replaced. Also applies `.env` changes
-(`docker restart` does not re-read env files).
+Safe by design:
+
+- Your vault data, search index, and `.env` settings are preserved across
+  upgrades — only the server image is replaced.
+- Any edits you've made to `.env` are applied on the way up (`docker restart`
+  alone does not re-read env files).
 
 Prefer Docker Compose? The CLI uses `docker run` for simplicity, but the
 [deploy guides](https://github.com/aliasunder/vault-cortex/blob/main/deploy/)
-include Compose files you can use directly.
+include Compose files you can use directly. If you set up with Compose, stick
+with Compose for updates too (`docker compose pull && docker compose up -d`)
+— the CLI and Compose manage the container independently.
 
-## Non-interactive
+## get-sync-token
+
+Generate an [Obsidian Sync](https://obsidian.md/sync) auth token — needed for
+remote setups — without leaving the CLI:
 
 ```bash
-npx vault-cortex@latest init --yes --vault-path /path/to/YourVault
+npx vault-cortex get-sync-token
 ```
 
-Flags: `--mode local|remote`, `--vault-path <path>`, `--dir <path>` (default
-`./vault-cortex`), `--yes`.
+The command opens the Obsidian login inside Docker. Once you've signed in, it
+captures your token and prints it — nothing to dig out of the login output.
+Use `--dir <path>` to write the token straight into an existing `.env`
+instead:
+
+```bash
+npx vault-cortex get-sync-token --dir ./vault-cortex
+```
+
+During `init --mode remote`, this flow is offered automatically when Docker
+is available.
 
 ## Requirements
 
 - Node.js >= 20.12 (only for this CLI — the server itself runs in Docker)
-- [Docker](https://docs.docker.com/get-docker/) (or any OCI-compatible runtime) to run the server
+- [Docker](https://docs.docker.com/get-docker/) (or any OCI-compatible
+  runtime, e.g. Podman) to run the server
 
 ## Docs
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vault-cortex",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "Set up a Vault Cortex MCP server for your Obsidian vault in one command: npx vault-cortex init",
   "license": "MIT",
   "type": "module",