upfynai-code 2.9.1 → 2.9.2

package/README.md

@@ -1,106 +1,131 @@
-# upfyn-code
+# Upfyn-Code
 
-> Unified AI coding interface — access AI chat, terminal, file explorer, git, and visual canvas from any browser.
+**Visual AI coding interface for Claude Code, Cursor & Codex.**
 
-**Upfyn-Code** connects your local development machine to a browser-based UI through a secure, encrypted connection. Write code with AI assistance, run shell commands, manage files, handle git operations, and plan on a visual canvas — all from any device, anywhere.
+Canvas whiteboard, multi-agent chat, integrated terminal, git management, voice assistant, and MCP protocol — all in one browser-based IDE.
 
-Your source code **never leaves your machine**. All file operations, terminal commands, and git actions execute locally.
+By [Thinqmesh Technologies](https://thinqmesh.com)
 
-## Install
+---
 
-```bash
-npm install -g upfynai-code
-```
+## What is Upfyn-Code?
 
-Or run directly with npx:
+Upfyn-Code gives you a **visual web interface** for AI coding agents. Instead of working in a plain terminal, you get a full IDE experience with:
 
-```bash
-npx upfynai-code
-```
+- **Multi-Agent Chat** — Claude Code, Cursor, Codex, and 200+ models via OpenRouter
+- **Visual Canvas** — Infinite whiteboard with AI-powered blocks (Chat, Research, Code, Notes, PDF, Dashboard)
+- **Integrated Terminal** — Multi-tab shell with full ANSI color support
+- **File Explorer** — Browse, edit, and manage project files
+- **Git Panel** — Stage, commit, push, view diffs, switch branches
+- **Voice Assistant** — Talk to Upfyn hands-free
+- **Task Tracker** — AI-powered task breakdown from PRDs
+- **MCP Protocol** — Connect to Claude Code, Cursor, or any MCP-compatible tool
+- **Dashboard** — Session analytics, usage stats, and getting-started guide
+- **BYOK** — Bring Your Own API Key (Anthropic, OpenAI, Google, OpenRouter)
 
-**Requirements:** Node.js 22 or later. Works on Windows, macOS, and Linux.
+---
 
-## Quick Start
+## Two ways to use it
+
+### 1. Local mode (free, self-hosted)
+
+Install the package and run everything on your machine. No account needed.
 
 ```bash
-# 1. Authenticate with your Upfyn account
-uc login
+npm install -g upfynai-code
 
-# 2. Connect your machine to the web interface
-uc connect
+# Launch Claude Code + web UI
+uc
 
-# 3. Open the web UI (opens automatically)
+# Or start the web server only
 uc start
 ```
 
-Once connected, open [cli.upfyn.com](https://cli.upfyn.com) on any device to access your full development environment.
+The server starts at `http://localhost:3001`. It auto-detects your installed AI agents and creates a local user automatically.
 
-## Commands
+**What you get locally:**
+- Full web UI with all features (chat, canvas, terminal, git, files, tasks)
+- Direct SDK calls to your local Claude Code / Codex / Cursor
+- No network round-trip — everything runs on your machine
+- Works offline (except AI queries which need API access)
 
-| Command | Description |
-|---------|-------------|
-| `uc` | Launch Claude Code with Upfyn web UI in background |
-| `uc start` | Start the web UI server |
-| `uc connect` | Connect your local machine to the cloud interface |
-| `uc login` | Authenticate with your Upfyn account |
-| `uc logout` | Clear saved credentials |
-| `uc status` | Show current configuration |
-| `uc config` | View or set configuration |
-| `uc help` | Show all available commands |
+### 2. Cloud mode (subscription required)
 
-### Connect Options
+Access your machine from **any browser, anywhere** via [cli.upfyn.com](https://cli.upfyn.com).
 
 ```bash
-uc connect --key <token>
+# 1. Sign up at cli.upfyn.com and get your relay token
+# 2. Connect your machine
+uc connect --server https://cli.upfyn.com --key upfyn_your_token
 ```
 
-- `--key <token>` — Your connection token (get from the web UI after signing in)
+Once connected, your local machine is bridged to the web UI. AI prompts, terminal commands, file operations, and git — all route through an encrypted relay to your machine.
 
-## Features
+**What you need for cloud mode:**
+- An active subscription at [cli.upfyn.com/pricing](https://cli.upfyn.com/pricing)
+- Your relay token (provided after signup)
+- The CLI installed on your machine
 
-### AI Chat
-Converse with AI coding assistants to write, debug, and refactor code across any language. Supports multiple AI models.
+**Why subscribe?**
+- Access your dev environment from any device (phone, tablet, another PC)
+- MCP API access — connect Claude Code or Cursor to Upfyn-Code remotely
+- Voice assistant with daily call allowance
+- Priority support
 
-### Integrated Terminal
-Run shell commands on your connected machine directly from the browser. Full terminal emulation with command history.
+---
 
-### File Explorer
-Browse, create, edit, and manage your entire project tree remotely. Supports drag-and-drop, file search, and bulk operations.
+## CLI Commands
 
-### Git Management
-Visual git interface for commits, branches, diffs, and merges. Stage changes, resolve conflicts, and manage branches without leaving the browser.
+| Command | Description |
+|---------|-------------|
+| `uc` | Launch Claude Code with Upfyn web UI |
+| `uc start` | Start the local web server only |
+| `uc connect --key <token>` | Connect to cli.upfyn.com (subscription required) |
+| `uc config --api-key <key>` | Save your Anthropic API key |
+| `uc status` | Show configuration and data locations |
+| `uc install-commands` | Install `/upfynai-*` slash commands for Claude Code |
+| `uc update` | Update to latest version |
+| `uc help` | Show all commands |
 
-### Upfyn Canvas
-Visual whiteboard with AI-powered blocks for planning and collaboration. Connect chat, research, code, and documentation blocks into context flows.
+## Slash Commands
 
-### MCP Protocol
-Connect external tools and services via the Model Context Protocol. Use Upfyn-Code as an MCP server with Claude Desktop, Cursor, and other compatible tools.
+When you run `uc`, these slash commands are automatically available inside Claude Code:
 
-## How It Works
+| Command | Description |
+|---------|-------------|
+| `/upfynai-connect` | Connect CLI session to web UI |
+| `/upfynai-disconnect` | Disconnect from web UI |
+| `/upfynai-status` | Show connection status |
+| `/upfynai-doctor` | Run diagnostics |
 
-1. **Install** the CLI on your development machine
-2. **Authenticate** with `uc login`
-3. **Connect** with `uc connect` — creates a secure, encrypted connection
-4. **Open** [cli.upfyn.com](https://cli.upfyn.com) on any browser (desktop, tablet, or mobile)
+## BYOK (Bring Your Own Key)
 
-The CLI connects your local filesystem, terminal, and git to the web interface. No ports are exposed and no firewall configuration is needed.
+Even without a connected machine, you can use AI chat by adding your own API keys in Settings:
 
-## Security
+- **Anthropic** — Claude models (Sonnet, Opus, Haiku)
+- **OpenAI** — GPT models
+- **OpenRouter** — 200+ models from all providers
+- **Google AI** — Gemini models
 
-- All communication is encrypted end-to-end
-- Source code is **never stored** on servers
-- Secure authentication with automatic session management
-- Each user's environment is fully isolated
+Configure via the web UI (Settings > AI Providers) or CLI:
+```bash
+uc config --api-key sk-ant-api03-your-key
+```
 
-## Links
+## Requirements
 
-- **Website:** [cli.upfyn.com](https://cli.upfyn.com)
-- **Documentation:** [cli.upfyn.com/docs](https://cli.upfyn.com/docs)
-- **GitHub:** [github.com/AnitChaudhry/UpfynAI-Code](https://github.com/AnitChaudhry/UpfynAI-Code)
-- **Issues:** [github.com/AnitChaudhry/UpfynAI-Code/issues](https://github.com/AnitChaudhry/UpfynAI-Code/issues)
+- **Node.js 18+**
+- At least one AI agent installed:
+  ```bash
+  npm install -g @anthropic-ai/claude-code  # Claude Code
+  npm install -g @openai/codex              # OpenAI Codex
+  # Cursor — install from cursor.com
+  ```
 
-## License
+## Documentation
 
-GPL-3.0 — see [LICENSE](https://github.com/AnitChaudhry/UpfynAI-Code/blob/main/LICENSE) for details.
+Full documentation: [cli.upfyn.com/docs](https://cli.upfyn.com/docs)
+
+## License
 
-Built by [Upfynai-Code](https://cli.upfyn.com).
+GPL-3.0 — Thinqmesh Technologies