@cosmicstack/mercury-agent 1.1.7 → 1.1.11

package/README.md

@@ -11,7 +11,7 @@
 </p>
 
 <p align="center">
-  Remembers what matters. Asks before it acts. Runs 24/7 from CLI or Telegram. 31 built-in tools, extensible skills, SQLite-backed Second Brain memory.
+  Remembers what matters. Asks before it acts. Runs 24/7 from CLI, Telegram, or Web. 31 built-in tools, Kanban boards, extensible skills, SQLite-backed Second Brain memory.
 </p>
 
 <p align="center">
@@ -21,7 +21,7 @@
 </p>
 
 <p align="center">
-  <strong>🔖 Current Stable: v1.1.6</strong>
+  <strong>🔖 Current Stable: v1.1.9</strong>
 </p>
 
 <p align="center">
@@ -32,11 +32,25 @@
 
 ## Quick Start
 
+**One-liner install (no Node.js required)** — downloads the latest standalone binary for your OS:
+
+```bash
+# macOS / Linux
+curl -fsSL https://mercuryagent.sh/install.sh | sh
+```
+
+```powershell
+# Windows
+irm https://mercuryagent.sh/install.ps1 | iex
+```
+
+Or via npm if you already have Node.js 20+:
+
 ```bash
 npx @cosmicstack/mercury-agent
 ```
 
-Or install globally:
+Or install the npm package globally:
 
 ```bash
 npm i -g @cosmicstack/mercury-agent
@@ -179,11 +193,79 @@ Type these during a conversation — they don't consume API tokens. Work on both
 | **Scheduler** | `schedule_task`, `list_scheduled_tasks`, `cancel_scheduled_task` |
 | **System** | `budget_status` |
 
+## Installing Skills
+
+Mercury can pull community-contributed skills from the registry at
+**[skills.mercuryagent.sh](https://skills.mercuryagent.sh)** (126+ skills, no auth required).
+
+```bash
+mercury skills search prompt                  # search the registry
+mercury skills browse ai-ml                   # browse by category
+mercury skills view ai-ml/prompt-engineering  # render SKILL.md in the terminal
+mercury skills view ai-ml/prompt-engineering --web   # open the registry page
+mercury skills install ai-ml/prompt-engineering      # install to ~/.mercury/skills/
+mercury skills list                           # show installed skills
+mercury skills update                         # refresh all installed skills
+mercury skills remove ai-ml/prompt-engineering
+mercury skills doctor                         # check install root + registry
+```
+
+Installed skills land at `~/.mercury/skills/<category>/<slug>/SKILL.md` and are
+picked up by the agent on the next boot — they're treated identically to
+built-in skills.
+
+> **Review before you ship.** Skills are community-contributed and unaudited.
+> Run `mercury skills view <id>` before installing.
+
+Overrides: `--registry <url>` (or `MERCURY_SKILLS_REGISTRY`) for self-hosted
+registries, `MERCURY_SKILLS_INSTALL_ROOT` for an alternate install path,
+`--json` for machine-readable output.
+
+**Also installable from:**
+
+- **Web dashboard** — `http://127.0.0.1:6174/skills` has a registry installer (paste `category/slug`) and a URL installer side by side.
+- **Telegram** — `/skills`, `/skills search <q>`, `/skills view <id>`, `/skills install <id>` (admin-only). Every result includes the registry URL so you can review before installing.
+
+See the [Skills reference](https://mercuryagent.sh/docs/reference/skills) for the full command surface, frontmatter spec, and API endpoints.
+
+## Web Dashboard
+
+Mercury includes a built-in web UI at `http://127.0.0.1:6174`:
+
+```bash
+mercury doctor   # Enable web during setup
+```
+
+Or set in `~/.mercury/mercury.yaml`:
+
+```yaml
+web:
+  enabled: true
+  port: 6174
+```
+
+Features: Chat with SSE streaming, Kanban boards, Second Brain visualization, Workspace IDE, provider/skill/permission/schedule management, usage tracking, dark/light theme.
+
+Default credentials: `mercury` / `Mercury@123`. Binds to localhost only.
+
+## Kanban Boards
+
+Persistent task boards with agent execution. Create boards, add cards, and let Mercury process them autonomously.
+
+- **Cards** — title, description, status (todo/doing/done/blocked), priority, labels, comments, attachments, dependencies
+- **Smart execution** — Mercury processes cards sequentially, updating status and leaving result comments
+- **Cascade execution** — process dependent cards in dependency order
+- **Token budget** — per-card token tracking with auto-pause when exhausted
+- **Storage** — SQLite with per-board context, variables, and instructions
+
+Access via Web Dashboard or API (`/api/boards/*`).
+
 ## Channels
 
 | Channel | Features |
 |---------|----------|
 | **CLI** | Ink TUI, startup permission mode picker, interactive permission prompts (arrow keys + Enter; Y/N/A shortcuts), progress views (balanced/detailed), real-time streaming |
+| **Web** | React SPA dashboard, chat with SSE streaming, Kanban boards, Second Brain visualization, Workspace IDE, dark/light theme |
 | **Telegram** | HTML formatting, editable streaming messages, file uploads, typing indicators, multi-user access with admin/member roles |
 
 ### Workspace/Coding Shortcuts (CLI)
@@ -254,6 +336,7 @@ All runtime data lives in `~/.mercury/` — not in your project directory.
 | `~/.mercury/memory/second-brain/` | Structured memory database (SQLite + FTS5) |
 | `~/.mercury/daemon.pid` | Background process PID |
 | `~/.mercury/daemon.log` | Daemon mode logs |
+| `~/.mercury/boards.db` | Kanban boards database (SQLite) |
 
 ## Provider Fallback
 
@@ -282,6 +365,57 @@ When a provider fails, Mercury automatically tries the next one. It remembers th
 - **Daemon manager** — Background spawn + PID file + watchdog crash recovery
 - **System services** — macOS LaunchAgent, Linux systemd, Windows Task Scheduler
 
+## Build From Source
+
+You can build Mercury yourself from source — either the standard Node bundle (for `npm link` / local development) or a **standalone executable** that bundles the entire runtime, so end-users don't need Node.js installed at all.
+
+### Prerequisites
+
+- **Node.js ≥ 20** (for the build toolchain)
+- **[Bun](https://bun.sh) ≥ 1.3** (only required for standalone binaries; install with `curl -fsSL https://bun.sh/install | bash`)
+
+### Standard build (ESM bundle)
+
+```bash
+git clone https://github.com/cosmicstack-labs/mercury-agent.git
+cd mercury-agent
+npm install
+npm run build           # builds dist/ via tsup + post-build (UI, static assets)
+npm start               # node dist/index.js
+```
+
+### Standalone executable (no Node.js required for end users)
+
+Mercury can be compiled into a single self-contained binary using `bun build --compile`. The resulting file embeds the Bun runtime and the full Mercury bundle.
+
+```bash
+npm run build:bin            # host platform only
+npm run build:bin:all        # all 5 targets (macOS arm64/x64, Linux x64/arm64, Windows x64)
+npm run build:bin:force      # rebuild (overwrite existing binary for the same version)
+npm run build:bin:all:force  # rebuild all targets
+```
+
+Output is **versioned** so older builds are never overwritten:
+
+```
+release/
+├── latest                       → symlink to most-recent version
+├── v1.1.9/
+│   ├── mercury-macos-arm64
+│   ├── mercury-macos-x64
+│   ├── mercury-linux-x64
+│   ├── mercury-linux-arm64
+│   ├── mercury-win-x64.exe
+│   └── checksums.txt            (SHA-256 for every binary)
+└── v1.2.0/ …
+```
+
+The version is read from `package.json` — bump it before building to produce a fresh folder. Re-running for the same version skips already-built targets unless `--force` is passed.
+
+**Cross-compilation**: Bun produces binaries for every target from a single host. Native modules (`better-sqlite3`) can't cross-compile, but Mercury gracefully falls back to `sql.js` (pure JS + wasm) so the cross-compiled binaries still work end-to-end.
+
+**macOS Gatekeeper**: unsigned binaries trigger a warning on first launch. For distribution, sign with `codesign --sign "Developer ID" release/v<version>/mercury-macos-arm64` and notarize.
+
 ## License
 
 MIT © [Cosmic Stack](https://github.com/cosmicstack-labs)