@swarmvaultai/cli 0.1.0 → 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 SwarmVault
+
+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

@@ -1,21 +1,103 @@
 # @swarmvaultai/cli
 
-SwarmVault CLI for local-first knowledge vault workflows.
+`@swarmvaultai/cli` is the globally installable entry point for SwarmVault.
+
+It gives you the `swarmvault` command for creating and operating a local-first LLM knowledge vault that compiles into markdown, graph data, and local search artifacts.
 
 ## Install
 
+SwarmVault requires Node `>=24`.
+
 ```bash
 npm install -g @swarmvaultai/cli
 ```
 
-## Commands
+Installed commands:
+
+- `swarmvault`
+- `vault` as a compatibility alias
+
+## First Run
 
 ```bash
+mkdir my-vault
+cd my-vault
 swarmvault init
-swarmvault ingest <path-or-url>
+swarmvault ingest ./notes.md
 swarmvault compile
-swarmvault query "What changed?" --save
-swarmvault lint
+swarmvault query "What themes keep recurring?" --save
 swarmvault graph serve
-swarmvault install --agent codex
 ```
+
+## Commands
+
+### `swarmvault init`
+
+Creates a new SwarmVault workspace in the current directory, including:
+
+- `raw/`
+- `wiki/`
+- `state/`
+- `agent/`
+- `swarmvault.config.json`
+
+### `swarmvault ingest <path-or-url>`
+
+Adds a local file or URL to the vault and records a manifest in `state/manifests/`.
+
+### `swarmvault compile`
+
+Compiles the current manifests into:
+
+- generated markdown in `wiki/`
+- structured graph data in `state/graph.json`
+- local search data in `state/search.sqlite`
+
+### `swarmvault query "<question>" [--save]`
+
+Queries the compiled vault. Use `--save` to write the result into `wiki/outputs/` so the answer becomes part of the vault.
+
+### `swarmvault lint`
+
+Runs anti-drift checks and other health checks against the current vault state.
+
+### `swarmvault graph serve`
+
+Starts the local graph UI backed by `state/graph.json`.
+
+### `swarmvault install --agent <codex|claude|cursor>`
+
+Writes agent-specific rules into the current project so your coding agent understands the SwarmVault directory contract and workflow.
+
+## Provider Configuration
+
+SwarmVault defaults to a local heuristic provider so the CLI can run without API keys, but real vaults should usually point at an actual model provider.
+
+Inside an existing `swarmvault.config.json`, your `providers` and `tasks` sections can look like this:
+
+```json
+{
+  "providers": {
+    "ollama-local": {
+      "type": "ollama",
+      "model": "qwen3:latest",
+      "baseUrl": "http://127.0.0.1:11434/v1",
+      "capabilities": ["chat", "structured", "vision", "local"]
+    }
+  },
+  "tasks": {
+    "compileProvider": "ollama-local",
+    "queryProvider": "ollama-local",
+    "lintProvider": "ollama-local",
+    "visionProvider": "ollama-local"
+  }
+}
+```
+
+Generic OpenAI-compatible APIs are also supported through config alone when the provider follows the same request shape closely enough.
+
+## Troubleshooting
+
+- If `graph serve` says the viewer build is missing, run `pnpm build` in the repository first
+- If a provider claims OpenAI compatibility but fails structured generation, declare only the capabilities it actually supports
+- Node 24 may emit an experimental warning for `node:sqlite`; this is expected in the current release

package/dist/index.js

@@ -13,7 +13,7 @@ import {
   startGraphServer
 } from "@swarmvaultai/engine";
 var program = new Command();
-program.name("swarmvault").description("SwarmVault is a local-first LLM wiki compiler with graph outputs and pluggable providers.").version("0.1.0");
+program.name("swarmvault").description("SwarmVault is a local-first LLM wiki compiler with graph outputs and pluggable providers.").version("0.1.2");
 program.command("init").description("Initialize a SwarmVault workspace in the current directory.").action(async () => {
   await initVault(process.cwd());
   process.stdout.write("Initialized SwarmVault workspace.\n");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swarmvaultai/cli",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Global CLI for SwarmVault.",
   "type": "module",
   "main": "dist/index.js",
@@ -8,6 +8,25 @@
   "files": [
     "dist"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/swarmclawai/swarmvault.git"
+  },
+  "homepage": "https://swarmvault.ai",
+  "bugs": {
+    "url": "https://github.com/swarmclawai/swarmvault/issues"
+  },
+  "keywords": [
+    "swarmvault",
+    "llm",
+    "knowledge-base",
+    "markdown",
+    "obsidian",
+    "graph",
+    "cli",
+    "local-first"
+  ],
+  "license": "MIT",
   "bin": {
     "swarmvault": "dist/index.js",
     "vault": "dist/index.js"
@@ -20,7 +39,7 @@
   },
   "dependencies": {
     "commander": "^14.0.1",
-    "@swarmvaultai/engine": "0.1.0"
+    "@swarmvaultai/engine": "0.1.2"
   },
   "devDependencies": {
     "@types/node": "^24.6.0",