@vefimov/crew 1.0.1 → 1.0.2

package/README.md

@@ -4,18 +4,16 @@
 
 # Crew
 
-**Your AI colleagues, at home.**
+Your AI colleagues, at home.
 
-A lightweight, local-first workspace where persistent AI agents live.
-They remember everything, work with your files, and talk to you in the browser, the terminal and Telegram.
+A local-first workspace for AI agents that stick around. They remember what you tell them, can work with files in folders you share, and answer in the browser, the terminal or Telegram.
 
 [![npm](https://img.shields.io/npm/v/@vefimov/crew?color=8b5cf6&label=npm)](https://www.npmjs.com/package/@vefimov/crew)
 [![CI](https://img.shields.io/github/actions/workflow/status/valyefimov/crew/ci.yml?branch=main&label=ci)](https://github.com/valyefimov/crew/actions)
 [![License: MIT](https://img.shields.io/badge/license-MIT-22d3ee)](https://github.com/valyefimov/crew/blob/main/LICENSE)
 [![Node](https://img.shields.io/badge/node-%E2%89%A522.13-8b5cf6)](https://github.com/valyefimov/crew/blob/main/.nvmrc)
-[![Local first](https://img.shields.io/badge/local--first-100%25-22d3ee)](#why-crew)
 
-[**Docs**](https://valyefimov.github.io/crew/) ·
+[Docs](https://valyefimov.github.io/crew/) ·
 [Русский](https://valyefimov.github.io/crew/ru/) ·
 [Українська](https://valyefimov.github.io/crew/uk/) ·
 [Roadmap](https://valyefimov.github.io/crew/guide/roadmap)
@@ -30,7 +28,7 @@ npx @vefimov/crew
   <img src="https://raw.githubusercontent.com/valyefimov/crew/main/media/demo.gif" alt="Crew demo" width="860" />
 </a>
 
-**▶ Watch the 90-second demo with voice-over:**
+The full 90-second demo with voice-over:
 [English](https://valyefimov.github.io/crew/media/demo.mp4) ·
 [Русский](https://valyefimov.github.io/crew/media/demo-ru.mp4) ·
 [Українська](https://valyefimov.github.io/crew/media/demo-uk.mp4)
@@ -39,34 +37,35 @@ npx @vefimov/crew
 
 ---
 
-## Why Crew
+## What it is
 
-Most "AI assistants" are a chat box that forgets you the moment you close the tab. Crew is the opposite: a small team of **persistent colleagues** that live on your machine.
+Most AI assistants forget you when you close the tab. Crew keeps a small team of agents on your own machine instead. Each one has a name, a role, a personality and its own long-term memory, so a conversation can pick up where it stopped last week.
 
-|   |   |
-|---|---|
-| 🏠 **Local-first** | Runs on [Ollama](https://ollama.com) (or any OpenAI-compatible server). One SQLite file. No cloud, no accounts, no telemetry. |
-| 🧠 **Real memory** | Each agent keeps long-term facts, decisions and preferences. Hybrid full-text + vector search, auto-extracted after every chat. |
-| 🎭 **Characters** | Name, role, personality, instructions, even a different model per agent. Start from templates: backend dev, designer, PM, writer, coach. |
-| 📁 **Your files** | Share a folder read-only or read-write. Agents list, read and write files — symlink- and `../`-proof. |
-| ✈️ **Telegram** | Paste a bot token, pair with a one-time code, chat with your crew from your phone. Memory is shared with the web UI. |
-| 🌍 **Three languages** | UI and docs in English, Русский and Українська. |
-| ⚡ **One command** | Web UI, CLI, REST + WebSocket API and a background worker — all in a single `npx`. |
+It runs on [Ollama](https://ollama.com) or any OpenAI-compatible server. State lives in one SQLite file, and nothing is sent anywhere unless you use Telegram or point Crew at a remote provider.
+
+What you get:
+
+- Agents with a role, a personality, instructions and, if you want, their own model. Five templates to start from: backend developer, frontend developer, product manager, writer, coach.
+- Long-term memory for each agent. It is stored in SQLite, searched with full text and vectors, and filled in automatically after every chat.
+- Shared folders, read-only or read-write. An agent can list, read and write files inside them and nowhere else.
+- A web UI, a CLI and a Telegram bot. All three talk to the same agents and share the same memory.
+- A REST and WebSocket API and a background task queue.
+- An interface and docs in English, Russian and Ukrainian.
 
 ## Screenshots
 
 <table>
   <tr>
-    <td width="50%"><img src="https://raw.githubusercontent.com/valyefimov/crew/main/media/dashboard.png" alt="Dashboard — who's doing what" /><br /><sub><b>Dashboard</b> — who's doing what, live</sub></td>
-    <td width="50%"><img src="https://raw.githubusercontent.com/valyefimov/crew/main/media/chat-memory.png" alt="Chat with memory panel" /><br /><sub><b>Chat + memory</b> — browse and edit what an agent remembers</sub></td>
+    <td width="50%"><img src="https://raw.githubusercontent.com/valyefimov/crew/main/media/dashboard.png" alt="Dashboard" /><br /><sub>The dashboard shows what each agent is doing right now.</sub></td>
+    <td width="50%"><img src="https://raw.githubusercontent.com/valyefimov/crew/main/media/chat-memory.png" alt="Chat with memory panel" /><br /><sub>A chat with the memory panel open. You can search, add and delete memories.</sub></td>
   </tr>
   <tr>
-    <td width="50%"><img src="https://raw.githubusercontent.com/valyefimov/crew/main/media/files.png" alt="Agent reading files" /><br /><sub><b>Files</b> — shared folders and visible tool calls</sub></td>
-    <td width="50%"><img src="https://raw.githubusercontent.com/valyefimov/crew/main/media/new-agent.png" alt="New colleague dialog" /><br /><sub><b>Templates</b> — hire a new colleague in seconds</sub></td>
+    <td width="50%"><img src="https://raw.githubusercontent.com/valyefimov/crew/main/media/files.png" alt="Agent reading files" /><br /><sub>An agent reading a file from a shared folder. Tool calls show up in the chat.</sub></td>
+    <td width="50%"><img src="https://raw.githubusercontent.com/valyefimov/crew/main/media/new-agent.png" alt="New colleague dialog" /><br /><sub>Creating an agent from a template.</sub></td>
   </tr>
   <tr>
-    <td width="50%"><img src="https://raw.githubusercontent.com/valyefimov/crew/main/media/dashboard-ru.png" alt="Russian UI" /><br /><sub><b>Русский</b></sub></td>
-    <td width="50%"><img src="https://raw.githubusercontent.com/valyefimov/crew/main/media/dashboard-uk.png" alt="Ukrainian UI" /><br /><sub><b>Українська</b></sub></td>
+    <td width="50%"><img src="https://raw.githubusercontent.com/valyefimov/crew/main/media/dashboard-ru.png" alt="Russian UI" /><br /><sub>Russian interface</sub></td>
+    <td width="50%"><img src="https://raw.githubusercontent.com/valyefimov/crew/main/media/dashboard-uk.png" alt="Ukrainian UI" /><br /><sub>Ukrainian interface</sub></td>
   </tr>
 </table>
 
@@ -74,7 +73,7 @@ Most "AI assistants" are a chat box that forgets you the moment you close the ta
 
 ## Quick start
 
-You need **Node.js 22.13+** and **Ollama**:
+You need Node.js 22.13 or newer and Ollama:
 
 ```bash
 ollama pull qwen2.5:3b
@@ -83,10 +82,11 @@ ollama pull nomic-embed-text
 npx @vefimov/crew
 ```
 
-Open <http://localhost:3000>, hire your first colleague, say hi. Close the tab, come back tomorrow — they still know who you are.
+Open <http://localhost:3000>, create an agent and say hi. Close the tab and come back tomorrow. The agent still knows who you are.
+
+The same thing from the terminal:
 
 ```bash
-# or from the terminal
 npm i -g @vefimov/crew
 crew agent create Artem --template backend --folder ~/code/my-api
 crew chat Artem
@@ -94,7 +94,7 @@ crew doctor               # check your setup
 ```
 
 <details>
-<summary><b>Docker</b></summary>
+<summary>Docker</summary>
 
 ```bash
 docker compose -f docker/docker-compose.yml up
@@ -105,22 +105,24 @@ docker compose -f docker/docker-compose.yml exec ollama ollama pull nomic-embed-
 </details>
 
 <details>
-<summary><b>Telegram</b></summary>
+<summary>Telegram</summary>
+
+Create a bot with @BotFather, then:
 
 ```bash
-crew config set telegramToken 123456:ABC...   # from @BotFather
+crew config set telegramToken 123456:ABC...
 crew start
 # ✔ Telegram bot online — send /pair 482913 to it
 ```
 
-`/agents`, `/use <name>`, `/memory`, `/forget` — or just address someone: *"Lena, how does this look?"*
+The bot understands `/agents`, `/use <name>`, `/memory` and `/forget`. You can also address an agent by name in a message: "Lena, how does this look?"
 
 </details>
 
 <details>
-<summary><b>Use a different model provider</b></summary>
+<summary>Another model provider</summary>
 
-LM Studio, llama.cpp, vLLM, OpenRouter, OpenAI — anything OpenAI-compatible:
+LM Studio, llama.cpp, vLLM, OpenRouter and OpenAI all work, since they speak the same API:
 
 ```bash
 CREW_PROVIDER=openai OPENAI_BASE_URL=http://127.0.0.1:1234/v1 crew start
@@ -141,43 +143,46 @@ CREW_PROVIDER=openai OPENAI_BASE_URL=http://127.0.0.1:1234/v1 crew start
           background worker ──▶ memory extraction, embeddings
 ```
 
-- **No native dependencies** — uses Node's built-in `node:sqlite`, so `npx` just works.
-- **Hybrid memory in SQLite** — FTS5 (BM25) + cosine over embeddings, fused with reciprocal-rank fusion, nudged by importance and recency. Near-duplicates are skipped.
-- **Provider-agnostic** — a tiny `Provider` interface with streaming and tool calls.
-- **Safe files** — paths are resolved with `realpath` *before* the permission check; writes need an explicit `rw` grant.
+Crew uses Node's built-in `node:sqlite`, so there is nothing to compile and `npx` works anywhere Node 22.13 does.
+
+Memory search combines SQLite FTS5 (BM25) with cosine similarity over embeddings. The two rankings are merged with reciprocal-rank fusion and adjusted a little for importance and age. A new memory that is nearly identical to an existing one is skipped.
+
+Providers sit behind a small interface with streaming and tool calls, so adding another one is a short file.
+
+For files, Crew resolves every path with `realpath` before checking permissions, which stops `../` and symlink escapes. Writing needs an explicit `rw` grant.
 
-Read more in the [architecture docs](https://valyefimov.github.io/crew/guide/architecture).
+More in the [architecture docs](https://valyefimov.github.io/crew/guide/architecture).
 
 ## Repository
 
 ```
-apps/server      Hono — REST + WebSocket
-apps/web         React 19 · Vite · Tailwind v4
-packages/core    agent runtime, providers, tools, worker
-packages/memory  SQLite store, FTS5 + vectors, task queue
+apps/server        Hono: REST + WebSocket
+apps/web           React 19, Vite, Tailwind v4
+packages/core      agent runtime, providers, tools, worker
+packages/memory    SQLite store, FTS5 + vectors, task queue
 packages/channels  Telegram (grammY)
-cli              `crew` — published as @vefimov/crew
-docs             VitePress site (en · ru · uk)
+cli                the `crew` command, published as @vefimov/crew
+docs               VitePress site in English, Russian and Ukrainian
 ```
 
 ```bash
 git clone https://github.com/valyefimov/crew && cd crew
 pnpm install
-pnpm dev      # API :3001, web UI :5173
+pnpm dev      # API on :3001, web UI on :5173
 pnpm test
 ```
 
 ## Roadmap
 
-- [x] **v1.0** — agents, memory, web UI, files, Ollama, CLI, Telegram, background tasks
-- [ ] **v1.1** — local voice (Whisper.cpp + Piper/Kokoro), scheduled tasks, sandboxed commands
-- [ ] **v1.2** — Slack, multiple workspaces, agents talking to each other
-- [ ] **v2.0** — team mode, marketplace of characters and skills, PWA, plugins
+- [x] v1.0: agents, memory, web UI, files, Ollama, CLI, Telegram, background tasks
+- [ ] v1.1: local voice (Whisper.cpp and Piper or Kokoro), scheduled tasks, sandboxed commands
+- [ ] v1.2: Slack, multiple workspaces, agents talking to each other
+- [ ] v2.0: team mode, a marketplace of characters and skills, PWA, plugins
 
 ## Security
 
-Crew listens on `127.0.0.1` by default and its API has **no authentication**. Don't expose it to the internet without a reverse proxy that adds auth.
+Crew listens on `127.0.0.1` by default, and its API has no authentication. If you expose it beyond your machine, put a reverse proxy with auth in front of it.
 
 ## License
 
-[MIT](https://github.com/valyefimov/crew/blob/main/LICENSE) © Valentyn Yefimov
+[MIT](https://github.com/valyefimov/crew/blob/main/LICENSE), © Valentyn Yefimov

package/dist/crew.js

@@ -1356,7 +1356,7 @@ import { serveStatic } from "@hono/node-server/serve-static";
 import { createNodeWebSocket } from "@hono/node-ws";
 
 // ../apps/server/src/version.ts
-var VERSION = "1.0.1";
+var VERSION = "1.0.2";
 
 // ../apps/server/src/app.ts
 var SECRET_KEYS = /* @__PURE__ */ new Set(["openaiApiKey", "telegramToken"]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vefimov/crew",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "A lightweight local-first workspace for your persistent AI colleagues. Memory, files, Telegram — one command.",
   "type": "module",
   "license": "MIT",