vexi-cli 0.5.5 → 0.9.0

package/README.md

@@ -15,6 +15,7 @@ Bring your own key · Zero config · Multilingual · 100% local
 [![npm](https://img.shields.io/npm/v/vexi-cli?color=2979FF)](https://www.npmjs.com/package/vexi-cli)
 [![license](https://img.shields.io/badge/license-MIT-2979FF)](LICENSE)
 [![node](https://img.shields.io/badge/node-%E2%89%A518-2979FF)](package.json)
+[![website](https://img.shields.io/badge/website-vexi.pro-2979FF)](https://vexi.pro)
 
 **English** · [العربية](#-العربية) · [Español](#-español) · [Português](#-português) · [Français](#-français)
 
@@ -31,19 +32,89 @@ vexi
 
 That's it. No login, no signup, no server, no database. Everything runs locally.
 
+## Update
+
+```bash
+vexi update
+# or directly:
+npm install -g vexi-cli@latest
+```
+
+Vexi checks once a day whether a newer version is published on npm and prints a
+one-line notice at startup if one is available. To disable the check:
+
+```bash
+vexi --no-update-check          # skip for this run
+VEXI_NO_UPDATE_CHECK=1 vexi     # skip via environment variable
+```
+
+## Uninstall
+
+```bash
+vexi uninstall           # removes Vexi, keeps your ~/.vexi config
+vexi uninstall --purge   # also deletes ~/.vexi (config, keys, memory)
+```
+
+Or directly, without running Vexi:
+
+```bash
+npm uninstall -g vexi-cli
+rm -rf ~/.vexi           # optional -- removes config, keys, and memory
+```
+
+On Windows:
+
+```cmd
+npm uninstall -g vexi-cli
+rmdir /s /q %USERPROFILE%\.vexi
+```
+
 ## BYOK — Bring Your Own Key
 
 On first run, paste any API key. Vexi **auto-detects the provider** from the key format:
 
-| Key prefix          | Provider          |
-| ------------------- | ----------------- |
-| `sk-ant-...`        | Anthropic (Claude)|
-| `sk-or-...`         | OpenRouter        |
-| `gsk_...`           | Groq              |
-| `AIza...`           | Google Gemini     |
-| `sk-...` / `sk-proj-...` | OpenAI       |
+| Key prefix | Provider | Auto-detect? | Free tier? |
+| ---------- | -------- | ------------ | ---------- |
+| `sk-ant-...` | Anthropic (Claude) | ✅ | — |
+| `sk-or-...` | OpenRouter | ✅ | ✅ free models |
+| `gsk_...` | Groq | ✅ | ✅ free |
+| `AIza...` | Google Gemini | ✅ | ✅ free |
+| `csk-...` | Cerebras | ✅ | ✅ free |
+| `<32-hex>.<secret>` | Zhipu AI — GLM | ✅ | ✅ free |
+| `sk-proj-...` | OpenAI | ✅ | — |
+| `sk-...` *(classic)* | OpenAI / DeepSeek / Kimi — pick manually | manual select | DeepSeek ✅ / Kimi ✅ |
+| *(any)* | Qwen · Mistral · MiniMax | manual select | ✅ free |
+
+> **Tip:** If Vexi guesses the wrong provider, run `vexi config reset`, paste your key again, and pick from the list.
+
+Your key is stored **locally** in `~/.vexi/config.json` with owner-only file permissions (`chmod 600`).
+
+### <img src="assets/icons/gift.svg" width="20" height="20" alt=""/> Start for free — no credit card needed
+
+**International:**
+
+| Provider | Sign-up | Free model | Speed |
+| -------- | ------- | ---------- | ----- |
+| **Groq** | [console.groq.com](https://console.groq.com) | Llama 3.3 70B | ⚡⚡ very fast |
+| **Google Gemini** | [aistudio.google.com](https://aistudio.google.com) | Gemini 2.5 Flash | ⚡ fast |
+| **Cerebras** | [cloud.cerebras.ai](https://cloud.cerebras.ai) | Llama 3.3 70B | ⚡⚡⚡ fastest |
+| **OpenRouter** | [openrouter.ai](https://openrouter.ai) | many free models | varies |
 
-If detection is ambiguous, Vexi simply asks you to pick the provider. Your key is stored **locally** in `~/.vexi/config.json` with owner-only file permissions (`chmod 600`).
+**Chinese AI (all free tier, great quality):**
+
+| Provider | Sign-up | Free model | Notes |
+| -------- | ------- | ---------- | ----- |
+| **DeepSeek** | [platform.deepseek.com](https://platform.deepseek.com) | deepseek-chat (V3) | excellent coder |
+| **Zhipu AI — GLM** | [bigmodel.cn](https://bigmodel.cn) | glm-4-flash | auto-detected |
+| **Alibaba Qwen** | [dashscope.console.aliyun.com](https://dashscope.console.aliyun.com) | qwen-turbo | manual select |
+| **Kimi (Moonshot)** | [platform.moonshot.cn](https://platform.moonshot.cn) | moonshot-v1-8k | manual select |
+| **MiniMax** | [platform.minimaxi.com](https://platform.minimaxi.com) | MiniMax-Text-01 | manual select |
+
+To switch provider at any time:
+```bash
+vexi config reset   # wipe the stored key
+vexi                # restart — prompts for a new key
+```
 
 ## Multilingual
 
@@ -64,6 +135,8 @@ Vexi auto-detects your system language on first run.
 ```bash
 vexi                  # start a chat session in the current project
 vexi --lang es        # start in Spanish
+vexi -p "explain the auth flow"        # one-shot, non-interactive (scripts/CI)
+vexi -p "add a health endpoint" --yes  # same, but auto-run any shell commands proposed
 vexi config           # show config location + provider + model
 vexi config reset     # delete the stored API key
 vexi skill list       # show active skills
@@ -78,19 +151,32 @@ vexi mcp list               # manage external MCP servers
 vexi --mcp-server           # expose Vexi as an MCP server (stdio)
 vexi learn                  # learn your coding style from past sessions
 vexi learn --apply          # save it as a skill (injected in every session)
+vexi undo                   # revert the last AI file edit
+vexi redo                   # re-apply a reverted edit
+vexi history                # list recent AI file edits with timestamps
+vexi clean                  # clear old snapshots (.vexi/snapshots/)
+vexi setup                  # configure any OpenAI-compatible endpoint by URL
+vexi update                 # update Vexi to the latest version
+vexi uninstall              # uninstall Vexi (keeps ~/.vexi config)
+vexi uninstall --purge      # uninstall + delete ~/.vexi
 ```
 
 Inside the chat:
 
 ```
-/help    show available commands
-/model   switch model (e.g. /model gpt-4o)
-/memory  show compressed project memory
-/clear   clear conversation history
-/exit    quit
+/help     show available commands
+/model    switch model (e.g. /model gpt-4o)
+/memory   show compressed project memory
+/clear    clear conversation history
+/undo     revert last AI file edit
+/redo     re-apply last undone edit
+/history  list recent AI file edits
+/push     stage, commit and push to git
+/usage    token & cost estimate for this session
+/exit     quit
 ```
 
-## ⚙️ Multi-language build support
+## <img src="assets/icons/settings.svg" width="22" height="22" alt=""/> Multi-language build support
 
 Vexi can build and run projects in **any language** — not just JavaScript. When the AI suggests commands, it wraps them in a shell block, Vexi asks for confirmation, then executes them automatically and feeds the output back to the AI.
 
@@ -106,7 +192,7 @@ Vexi can build and run projects in **any language** — not just JavaScript. Whe
 
 The project scanner automatically detects `.py`, `.java`, `.c`, `.cpp`, `.rs`, `.go` files and tells the AI what language your project uses before the first message.
 
-## 🧠 Project memory — Context Compression Engine
+## <img src="assets/icons/brain-circuit.svg" width="22" height="22" alt=""/> Project memory — Context Compression Engine
 
 Most AI coding tools forget earlier decisions once the conversation gets long.
 Vexi doesn't delete old messages — it **compresses** them:
@@ -118,7 +204,7 @@ Vexi doesn't delete old messages — it **compresses** them:
   your decisions **across sessions**, even in large projects.
 - Inspect it anytime with `/memory`.
 
-## 🗺️ Full project understanding
+## <img src="assets/icons/map.svg" width="22" height="22" alt=""/> Full project understanding
 
 On startup Vexi scans your whole project (not just the open file) and injects
 a compact map into every prompt: languages, frameworks, and architecture
@@ -128,7 +214,7 @@ Scanner safeguards: respects `.gitignore`, always skips `node_modules`,
 `.git`, `dist`, `build`, `coverage`, and ignores files larger than 500KB —
 so it never floods the context window.
 
-## 🎯 Custom Skills
+## <img src="assets/icons/target.svg" width="22" height="22" alt=""/> Custom Skills
 
 Teach Vexi *your* conventions with plain markdown files in `.vexi/skills/`:
 
@@ -147,7 +233,7 @@ vexi skill add https://github.com/user/react-best-practices
 vexi skill add ./docs/conventions.md
 ```
 
-## 🎬 Vexi Replay
+## <img src="assets/icons/clapperboard.svg" width="22" height="22" alt=""/> Vexi Replay
 
 Every chat session is automatically recorded to `.vexi/sessions/` (locally,
 nothing leaves your machine). Export any session as a **single standalone
@@ -164,7 +250,7 @@ and it ends with a session summary (duration, messages, model). An
 **Export video** button records the replay right in the browser
 (MediaRecorder — no ffmpeg, the CLI stays lightweight). Share it anywhere.
 
-## 🌍 Explain code in your native language
+## <img src="assets/icons/languages.svg" width="22" height="22" alt=""/> Explain code in your native language
 
 > The first AI tool that explains any code in your native language.
 
@@ -179,7 +265,7 @@ numbers → how the pieces fit together. Latin-script languages stream
 directly in the terminal; Arabic is written to `.md` + `.html` (dir="rtl")
 and opened in your browser, where it renders perfectly.
 
-## 🗺️ Visual code graph
+## <img src="assets/icons/network.svg" width="22" height="22" alt=""/> Visual code graph
 
 ```bash
 vexi graph --visual
@@ -191,7 +277,7 @@ search. Node heat shows how many files depend on each module, and clicking
 a node runs **impact analysis** — highlighting every file that breaks if
 you change it.
 
-## 🔌 MCP support
+## <img src="assets/icons/plug.svg" width="22" height="22" alt=""/> MCP support
 
 **Vexi as MCP client** — connect external tools and the AI can call them
 mid-conversation (works with every provider, no function-calling API needed):
@@ -223,7 +309,7 @@ official `@modelcontextprotocol/sdk`:
 Vexi **complements** Claude Code instead of competing: its project memory
 becomes a shared memory layer usable by any agent.
 
-## 🧠 Vexi Learn
+## <img src="assets/icons/graduation-cap.svg" width="22" height="22" alt=""/> Vexi Learn
 
 > The agent gets more *you* over time.
 
@@ -241,6 +327,90 @@ session, so you stop repeating yourself. Everything stays local — the only
 network call is to your own model provider, and you always preview before
 saving.
 
+## <img src="assets/icons/link.svg" width="22" height="22" alt=""/> URL-based setup — any OpenAI-compatible endpoint
+
+```bash
+vexi setup
+```
+
+Paste any API endpoint URL and Vexi auto-detects the provider, fetches available models, and lets you pick one — no manual config editing required. Works with:
+
+- **Local models** — Ollama (`http://localhost:11434`), LM Studio, etc.
+- **Custom proxies** — your own OpenAI-compatible gateway
+- **Specialist providers** — Z.ai Coding Plan, Cloudflare Workers AI, and any `/v1/chat/completions`-compatible API
+
+```
+? Paste your endpoint URL › https://openrouter.ai/api/v1
+  Detected: OpenRouter
+? Paste your API key › sk-or-...
+  Fetching available models…
+? Choose a model › meta-llama/llama-3.3-70b-instruct:free
+  ✓ Saved — run `vexi` to start
+```
+
+## <img src="assets/icons/rocket.svg" width="22" height="22" alt=""/> Git push from chat — `/push`
+
+Stage, commit and push without leaving the session. The AI drafts the commit message from your staged diff:
+
+```
+/push                 # AI writes commit message, confirms, then pushes
+/push --only          # push current branch without a new commit
+```
+
+Auth pre-flight runs before the real push so you get a clear error if credentials are missing, not a mid-push failure.
+
+## <img src="assets/icons/undo-2.svg" width="22" height="22" alt=""/> Undo / Redo — instant rescue from any AI edit
+
+> Approve a change, see it break things, type `vexi undo`. Done.
+
+```bash
+vexi undo      # revert the last AI-applied file change
+vexi redo      # re-apply a reverted change
+vexi history   # list every file edit this session, with timestamps
+vexi clean     # remove old snapshot sessions to free disk space
+```
+
+Or use the in-chat shortcuts without leaving the session: `/undo`, `/redo`, `/history`.
+
+**How it works (lightweight snapshot design):**
+
+- Before executing any confirmed shell command, Vexi inspects it for file-write patterns (`cat >`, `sed -i`, `mv`, `cp`, `tee`, `writeFileSync`, PowerShell `Set-Content`, and bare source-file tokens) and saves a copy of **only the affected files** into `.vexi/snapshots/<session>/`.
+- `undo` restores the pre-command copy and saves the current state as a redo point — so you can bounce back and forth freely.
+- Each session keeps a maximum of 50 snapshots; the oldest are pruned automatically.
+- Snapshots are **per-file, not per-project** — no full-tree indexing, no slow startup, no huge disk usage (the approach OpenCode's whole-tree snapshot system suffers from).
+- `vexi clean` wipes all previous sessions' snapshots while keeping the current one active.
+
+This pairs naturally with the confirmation prompt: even if you approve a change that turns out to be wrong, one command gets you back.
+
+## <img src="assets/icons/file-check.svg" width="22" height="22" alt=""/> Reliable file edits
+
+Vexi edits files through structured tools — `read_file`, `write_file`, and
+`edit_file` (exact `old` → `new` substring replacement) — instead of fragile
+shell patching (`cat >`, `sed -i`). `edit_file` refuses a non-existent or
+ambiguous match rather than corrupting the file, and every write is snapshotted
+on the **exact** file about to change, so `/undo` is precise rather than
+regex-guessed.
+
+On providers that reliably support it (Anthropic, OpenAI, Groq, Gemini,
+Mistral, Cerebras, DeepSeek, Qwen, Kimi, GLM, OpenRouter), the tools run over
+**native function-calling**; everywhere else Vexi falls back to a
+provider-agnostic text protocol, so the same capabilities work with every
+provider.
+
+## <img src="assets/icons/coins.svg" width="22" height="22" alt=""/> Token & cost tracking
+
+Vexi accumulates the real token usage reported by your provider and estimates
+the dollar cost from a built-in price table:
+
+```
+/usage    → 12,340 tokens (8.1k in / 4.2k out) · ~$0.0187
+```
+
+Check it anytime with `/usage`, and a one-line summary prints when you exit
+(and to stderr in `-p` mode). Known free-tier models read as **$0**, and
+unpriced models still show token counts. Since you bring your own key, the
+`~` marks it as an estimate.
+
 ## Roadmap
 
 | Phase | Feature | Status |
@@ -250,19 +420,32 @@ saving.
 | 3 | **Vexi Replay** (export sessions as animated HTML) · multilingual code explanation | ✅ done |
 | 4 | Visual code graph · MCP support (client **and** server mode) | ✅ done |
 | 5 | **Vexi Learn** — adapts to your personal coding style | ✅ done |
+| 6 | **Multi-language builds** — auto-executes pip, gcc, javac, cargo, gradle from chat | ✅ done |
+| 7 | **Undo / Redo** — instant one-command revert of any AI file edit, without touching git | ✅ done |
+| 8 | **`/push`** — stage, AI-draft commit message, and push to git from chat | ✅ done |
+| 9 | **`vexi setup`** — configure any OpenAI-compatible endpoint by pasting a URL | ✅ done |
+| 10 | **Self-maintaining** — `vexi update`, `vexi uninstall`, daily update-check notice | ✅ done |
+| 11 | **Reliable file edits** — structured read/write/edit tools with exact undo snapshots, native function-calling where the provider supports it | ✅ done |
+| 12 | **Token & cost tracking** (`/usage`) · remote model-default manifest (defaults refresh without a release) | ✅ done |
 
 ## Why Vexi?
 
 | | Vexi | OpenCode | Claude Code | Cursor |
 | --- | --- | --- | --- | --- |
 | Install | `npm i -g vexi-cli` | binary/script | `npm i -g` | desktop app |
-| BYOK (any provider) | ✅ 5 providers, auto-detect | ✅ | ❌ Anthropic only | partial |
-| Works fully offline/local | ✅ no server, no account | ✅ | ❌ account | ❌ account |
-| Native-language code explanations | ✅ ar/es/pt/fr | ❌ | ❌ | ❌ |
+| BYOK (any provider) | ✅ 13 providers incl. Chinese AI + URL endpoints | ✅ | limited (defaults to Anthropic; Bedrock/Vertex/gateways possible) | partial |
+| No server, no account | ✅ no server, no account | ✅ | ❌ account | ❌ account |
+| Native-language code explanations (built-in) | ✅ ar/es/pt/fr | via model | via model | via model |
 | Session replay export | ✅ | ❌ | ❌ | ❌ |
 | Persistent project memory | ✅ | partial | partial | ✅ |
 | Learns your personal coding style | ✅ from your own sessions | ❌ | ❌ | partial |
-| MCP server mode (be a tool for other agents) | ✅ | ❌ | ❌ | ❌ |
+| MCP server mode (be a tool for other agents) | ✅ | ❌ | ✅ `claude mcp serve` | ❌ |
+| Builds any language (Python, Java, C, Rust, Go) | ✅ | ✅ | ✅ | ✅ |
+| Instant undo/redo of AI edits (no git required) | ✅ per-file snapshots | ❌ | ❌ | ❌ |
+| Git push from chat (AI commit message) | ✅ `/push` | ❌ | ✅ | partial |
+| URL endpoint setup (Ollama, custom proxies) | ✅ `vexi setup` | ✅ | ❌ | ❌ |
+| Structured file-edit tools + exact undo | ✅ read/write/edit + per-file snapshots | partial | ✅ | ✅ |
+| Token & cost tracking (`/usage`) | ✅ per-session estimate | ❌ | ✅ | partial |
 | License | MIT | MIT | proprietary | proprietary |
 
 Vexi **complements** tools like Claude Code instead of competing: its project memory and multilingual explanations will be exposed over MCP so any agent can use them.
@@ -283,7 +466,10 @@ src/
 ├── cli.ts          CLI definition (commander)
 ├── agent.ts        chat loop + first-run onboarding
 ├── config.ts       ~/.vexi/config.json (atomic, chmod 600)
-├── providers/      key detection + streaming API clients
+├── version.ts      dynamic VERSION from package.json
+├── endpoint.ts     URL provider detection + model discovery (vexi setup)
+├── onboarding.ts   interactive URL-based setup wizard
+├── providers/      key detection + streaming API clients (13 providers)
 ├── scanner/        project mapper (.gitignore-aware, size-capped)
 ├── memory/         Context Compression Engine (.vexi/memory.json)
 ├── skills/         custom skills loader (.vexi/skills/*.md)
@@ -292,6 +478,9 @@ src/
 ├── graph/          dependency graph + interactive d3 visualization
 ├── mcp/            MCP client (tools in chat) + server mode
 ├── learn/          Vexi Learn — style mining from your own sessions
+├── snapshots/      undo/redo engine — per-file backups before AI edits
+├── git/            /push command — stage, AI commit message, push
+├── update/         vexi update / uninstall + daily update-check
 ├── i18n/           5-language UI strings + RTL strategy
 ├── ui/             terminal branding (chalk, ora)
 └── utils/          atomic JSON writes, cross-platform open
@@ -306,19 +495,19 @@ To add support for a new key format, edit a single file: `src/providers/detect.t
 
 ---
 
-## 🌍 العربية
+## <img src="assets/icons/globe.svg" width="22" height="22" alt=""/> العربية
 
 **Vexi** — وكيل برمجة بالذكاء الاصطناعي مفتوح المصدر يعمل في الطرفية. ثبّته بأمر واحد (`npm install -g vexi-cli`)، الصق مفتاح API الخاص بك مرة واحدة، وابدأ فورًا. لا تسجيل، لا خادم، كل شيء يعمل محليًا على جهازك. يشرح Vexi أي كود بالعربية الفصحى (`vexi explain auth.ts --ar`) في ملفات HTML تدعم الاتجاه من اليمين لليسار بشكل مثالي، ويتعلّم أسلوبك البرمجي الشخصي من جلساتك السابقة (`vexi learn`).
 
-## 🌍 Español
+## <img src="assets/icons/globe.svg" width="22" height="22" alt=""/> Español
 
 **Vexi** es un agente de programación con IA, de código abierto, que vive en tu terminal. Instálalo con un solo comando (`npm install -g vexi-cli`), pega tu clave API una vez y empieza al instante. Sin registro, sin servidor: todo se ejecuta localmente. Vexi detecta tu proveedor automáticamente y habla tu idioma.
 
-## 🌍 Português
+## <img src="assets/icons/globe.svg" width="22" height="22" alt=""/> Português
 
 **Vexi** é um agente de programação com IA, de código aberto, que vive no seu terminal. Instale com um único comando (`npm install -g vexi-cli`), cole sua chave de API uma vez e comece imediatamente. Sem cadastro, sem servidor: tudo roda localmente. O Vexi detecta seu provedor automaticamente e fala o seu idioma.
 
-## 🌍 Français
+## <img src="assets/icons/globe.svg" width="22" height="22" alt=""/> Français
 
 **Vexi** est un agent de codage IA open source qui vit dans votre terminal. Installez-le en une seule commande (`npm install -g vexi-cli`), collez votre clé API une fois et commencez immédiatement. Pas de compte, pas de serveur : tout s'exécute localement. Vexi détecte automatiquement votre fournisseur et parle votre langue.
 
@@ -326,7 +515,7 @@ To add support for a new key format, edit a single file: `src/providers/detect.t
 
 <div align="center">
 
-**MIT License** · Made with ⚡ by the Vexi community
+**MIT License** · Made with <img src="assets/icons/zap.svg" width="16" height="16" alt="" style="vertical-align:text-bottom"/> by the Vexi community
 
 `npm install -g vexi-cli`