upfyn-code 1.0.1 → 1.0.3

package/README.md

@@ -0,0 +1,166 @@
+# upfyn-code
+
+> Unified AI coding interface — access AI chat, terminal, file explorer, git, and visual canvas from any browser.
+
+**Upfyn-Code** connects your local development machine to a browser-based UI through a secure WebSocket relay. Write code with AI assistance, run shell commands, manage files, handle git operations, and plan on a visual canvas — all from any device, anywhere.
+
+Your source code **never leaves your machine**. All file operations, terminal commands, and git actions execute locally through the relay connection.
+
+## Install
+
+```bash
+npm install -g upfyn-code
+```
+
+Or run directly with npx:
+
+```bash
+npx upfyn-code
+```
+
+**Requirements:** Node.js 18 or later. Works on Windows, macOS, and Linux.
+
+## Quick Start
+
+```bash
+# 1. Authenticate with your Upfyn account
+upfyn-code login
+
+# 2. Connect your machine to the web interface
+upfyn-code connect
+
+# 3. Open the web UI (opens automatically)
+upfyn-code
+```
+
+Once connected, open [cli.upfyn.com](https://cli.upfyn.com) on any device to access your full development environment.
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `upfyn-code` | Open the hosted web interface (default) |
+| `upfyn-code --local` | Start a local server instead of the hosted app |
+| `upfyn-code login` | Authenticate with your Upfyn account |
+| `upfyn-code logout` | Clear saved credentials |
+| `upfyn-code status` | Show current auth status and configuration |
+| `upfyn-code connect` | Connect your local machine to the remote server |
+| `upfyn-code mcp` | Show MCP integration config for Claude / Cursor |
+
+### Connect Options
+
+```bash
+upfyn-code connect --server <url> --key <token>
+```
+
+- `--server <url>` — Server URL to connect to
+- `--key <token>` — Relay token (get from the web UI after signing in)
+
+### MCP Integration
+
+```bash
+upfyn-code mcp --server <url> --key <token>
+```
+
+Outputs the MCP (Model Context Protocol) configuration JSON for use with Claude Desktop, Cursor, or other MCP-compatible tools.
+
+**Example output:**
+
+```json
+{
+  "mcpServers": {
+    "upfyn-code": {
+      "url": "https://your-server.com/mcp",
+      "headers": {
+        "Authorization": "Bearer rt_xxxxx"
+      }
+    }
+  }
+}
+```
+
+## Features
+
+### AI Chat
+Converse with AI coding assistants to write, debug, and refactor code across any language. Supports multiple AI models.
+
+### 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.
+
+### Git Management
+Visual git interface for commits, branches, diffs, and merges. Stage changes, resolve conflicts, and manage branches without leaving the browser.
+
+### Upfyn Canvas
+Visual whiteboard with AI-powered blocks for planning and collaboration. Connect chat, research, code, and documentation blocks into context flows.
+
+### 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.
+
+## How It Works
+
+1. **Install** the CLI on your development machine
+2. **Authenticate** with `upfyn-code login`
+3. **Connect** with `upfyn-code connect` — this creates a secure WebSocket tunnel
+4. **Open** [cli.upfyn.com](https://cli.upfyn.com) on any browser (desktop, tablet, or mobile)
+
+The CLI bridges your local filesystem, terminal, and git to the web interface. No ports are exposed and no firewall configuration is needed — the connection works through a secure relay.
+
+```
+┌─────────────┐    WebSocket     ┌──────────────┐     Browser      ┌──────────────┐
+│  Your Local  │ ──────────────▶ │  Upfyn Relay  │ ◀────────────── │   Web UI at  │
+│   Machine    │   (encrypted)   │    Server     │                  │ cli.upfyn.com│
+└─────────────┘                  └──────────────┘                  └──────────────┘
+```
+
+## Security
+
+- All communication is encrypted with TLS
+- Source code is relayed in real-time and **never stored** on servers
+- Authentication uses JWT tokens with httpOnly cookies
+- The relay connection requires both a valid session and a connection token
+- Self-hosting is supported for full data sovereignty
+
+## Self-Hosting
+
+Upfyn-Code is open source under the GPL-3.0 license. You can deploy the entire stack on your own infrastructure:
+
+```bash
+git clone https://github.com/AnitChaudhry/UpfynAI-Code.git
+cd UpfynAI-Code
+
+# Install dependencies
+npm install
+
+# Start the backend
+cd backend && npm start
+
+# Start the frontend
+cd frontend && npm run dev
+```
+
+See the [repository](https://github.com/AnitChaudhry/UpfynAI-Code) for full deployment instructions.
+
+## Configuration
+
+Credentials and config are stored locally at:
+
+| Platform | Path |
+|----------|------|
+| macOS / Linux | `~/.config/upfyn-code/` |
+| Windows | `%APPDATA%\upfyn-code\` |
+
+## Links
+
+- **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)
+
+## License
+
+GPL-3.0 — see [LICENSE](https://github.com/AnitChaudhry/UpfynAI-Code/blob/main/LICENSE) for details.
+
+Built by [Thinqmesh Technologies](https://cli.upfyn.com).

package/bin/cli.js

@@ -11,7 +11,7 @@ const program = new Command();
 program
   .name('upfyn-code')
   .description('Launch Upfyn AI coding environment from your terminal')
-  .version('1.0.1')
+  .version('1.0.3')
   .option('--local', 'Start a local server instead of opening the hosted app')
   .action(async (options) => {
     if (options.local) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "upfyn-code",
-  "version": "1.0.1",
-  "description": "Launch Upfyn AI coding environment from your terminal",
+  "version": "1.0.3",
+  "description": "Unified AI coding interface — access AI chat, terminal, file explorer, git, and visual canvas from any browser. Connect your local machine and code from anywhere.",
   "type": "module",
   "bin": {
     "upfyn-code": "./bin/cli.js"
@@ -9,7 +9,9 @@
   "files": [
     "bin/",
     "src/",
-    "dist/"
+    "dist/",
+    "README.md",
+    "LICENSE"
   ],
   "scripts": {
     "start": "node bin/cli.js",
@@ -17,13 +19,41 @@
   },
   "keywords": [
     "upfyn",
+    "upfyn-code",
     "ai",
     "coding",
     "cli",
-    "terminal"
+    "terminal",
+    "remote-development",
+    "code-editor",
+    "ai-assistant",
+    "ai-coding",
+    "developer-tools",
+    "devtools",
+    "browser-ide",
+    "remote-access",
+    "websocket",
+    "git",
+    "file-explorer",
+    "canvas",
+    "whiteboard",
+    "mcp",
+    "model-context-protocol"
   ],
-  "author": "Upfyn",
-  "license": "MIT",
+  "author": {
+    "name": "Thinqmesh Technologies",
+    "url": "https://cli.upfyn.com"
+  },
+  "license": "GPL-3.0",
+  "homepage": "https://cli.upfyn.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AnitChaudhry/UpfynAI-Code.git",
+    "directory": "packages/cli"
+  },
+  "bugs": {
+    "url": "https://github.com/AnitChaudhry/UpfynAI-Code/issues"
+  },
   "dependencies": {
     "chalk": "^5.3.0",
     "commander": "^12.1.0",
@@ -35,5 +65,10 @@
   },
   "engines": {
     "node": ">=18.0.0"
-  }
+  },
+  "os": [
+    "darwin",
+    "linux",
+    "win32"
+  ]
 }