scalix 1.4.1 → 1.5.0

package/docs/DISTRIBUTION.md

@@ -1,301 +0,0 @@
-# Scalix Coder — Distribution Guide
-
-This document covers how to build, distribute, and install Scalix Coder for end users **without exposing source code**.
-
----
-
-## Table of Contents
-
-1. [Overview](#overview)
-2. [Building a Release](#building-a-release)
-3. [What's in the Release](#whats-in-the-release)
-4. [Hosting the Release](#hosting-the-release)
-5. [One-Line Installer Setup](#one-line-installer-setup)
-6. [Manual Installation](#manual-installation)
-7. [VS Code Extension](#vs-code-extension)
-8. [Updating Users](#updating-users)
-9. [Troubleshooting](#troubleshooting)
-
----
-
-## Overview
-
-Scalix Coder is distributed as **compiled JavaScript** — no TypeScript source code is included. Users receive:
-
-- Pre-compiled `.js` files (from `dist/`)
-- A CLI entry point (`bin/scalix.js`)
-- One-click install scripts for Windows and Mac/Linux
-- The VS Code extension (`.vsix` file)
-
-**What's included:**
-- 31 built-in tools (shell, file, git, web, browser, vision, voice, and more)
-- Security sandbox with path restriction, command blocklist, and injection detection
-- IPC server mode for VS Code extension integration
-
-**Requirements for end users:**
-- Node.js 18 or higher
-- npm (comes with Node.js)
-- Windows 10+, macOS 12+, or Linux
-
----
-
-## Building a Release
-
-From the project root, run:
-
-```bash
-npm run release
-```
-
-This will:
-1. Compile TypeScript to JavaScript (`tsc`)
-2. Package everything into `release/` directory
-3. Create both `.tar.gz` (Mac/Linux) and `.zip` (Windows) archives
-4. Include the VS Code extension `.vsix` if available
-5. Strip `devDependencies` and dev scripts from `package.json`
-
-**Output:**
-```
-release/
-├── scalix-coder-v3.0.0/          # Extracted release folder
-│   ├── dist/                      # Compiled JavaScript (NO source code)
-│   ├── bin/scalix.js              # CLI entry point
-│   ├── package.json               # Dependencies only
-│   ├── package-lock.json          # Lockfile
-│   ├── install.bat                # Windows installer
-│   ├── install.sh                 # Mac/Linux installer
-│   ├── scalix-coder-0.2.0.vsix   # VS Code extension
-│   ├── README.md
-│   ├── LICENSE
-│   └── CHANGELOG.md
-├── scalix-coder-v3.0.0.tar.gz    # Mac/Linux archive
-└── scalix-coder-v3.0.0.zip       # Windows archive
-```
-
----
-
-## What's in the Release
-
-### Included
-| Item | Description |
-|---|---|
-| `dist/*.js` | Compiled JavaScript (agent, tools, CLI, etc.) |
-| `bin/scalix.js` | CLI entry point — runs `dist/cli.js` |
-| `package.json` | Production dependencies only |
-| `install.bat` | One-click Windows installer |
-| `install.sh` | One-click Mac/Linux installer |
-| `*.vsix` | VS Code extension package |
-| `README.md` | User documentation |
-| `LICENSE` | License file |
-
-### NOT Included (Protected)
-| Item | Why excluded |
-|---|---|
-| `src/*.ts` / `src/*.tsx` | Source code — proprietary |
-| `tests/` | Internal test suite |
-| `tsconfig.json` | Build configuration |
-| `eslint.config.js` | Lint configuration |
-| `vitest.config.ts` | Test configuration |
-| `scripts/` | Build scripts |
-| `.claude/` | Claude Code settings |
-| `.scalix/` | Project memory |
-| `devDependencies` | Development tools |
-
----
-
-## Hosting the Release
-
-Upload the release archives to any file hosting. Options:
-
-### Option A: Your Own Website / Server
-```
-https://scalix.world/releases/scalix-coder-v3.0.0.tar.gz
-https://scalix.world/releases/scalix-coder-v3.0.0.zip
-https://scalix.world/install.sh
-https://scalix.world/install.ps1
-```
-
-### Option B: AWS S3 / Google Cloud Storage
-```bash
-# Upload to S3
-aws s3 cp release/scalix-coder-v3.0.0.tar.gz s3://your-bucket/releases/
-aws s3 cp release/scalix-coder-v3.0.0.zip s3://your-bucket/releases/
-aws s3 cp scripts/install-remote.sh s3://your-bucket/install.sh
-aws s3 cp scripts/install-remote.ps1 s3://your-bucket/install.ps1
-```
-
-### Option C: GitHub Releases (on a separate public repo)
-Create a public repo (e.g., `scalix-coder-releases`) and upload the archives as release assets.
-
-**After uploading, update the URLs in:**
-- `scripts/install-remote.sh` — change `your-domain.com` to your actual URL
-- `scripts/install-remote.ps1` — change `your-domain.com` to your actual URL
-
----
-
-## One-Line Installer Setup
-
-Once files are hosted, users install with a single command:
-
-### Mac / Linux
-```bash
-curl -fsSL https://scalix.world/install.sh | bash
-```
-
-### Windows (PowerShell)
-```powershell
-irm https://scalix.world/install.ps1 | iex
-```
-
-### What the installer does:
-1. Checks Node.js 18+ is installed
-2. Downloads the release archive
-3. Extracts to `~/.scalix-coder/`
-4. Runs `npm install --omit=dev`
-5. Runs `npm link` to register the `scalix` command globally
-6. Done — user types `scalix` in any terminal
-
-### Custom Download URL
-Users can override the download URL:
-```bash
-SCALIX_DOWNLOAD_URL=https://internal.company.com/scalix.tar.gz curl -fsSL https://scalix.world/install.sh | bash
-```
-
----
-
-## Manual Installation
-
-If users prefer manual installation:
-
-### Windows
-1. Download `scalix-coder-v3.0.0.zip`
-2. Extract the zip file
-3. Open the extracted folder
-4. Double-click `install.bat`
-5. Open any terminal and type `scalix`
-
-### Mac / Linux
-```bash
-tar -xzf scalix-coder-v3.0.0.tar.gz
-cd scalix-coder-v3.0.0
-./install.sh
-```
-
-### Manual (No Installer Script)
-```bash
-tar -xzf scalix-coder-v3.0.0.tar.gz
-cd scalix-coder-v3.0.0
-npm install --omit=dev --legacy-peer-deps
-sudo npm link    # or without sudo on Windows
-scalix
-```
-
----
-
-## VS Code Extension
-
-The VS Code extension (`.vsix` file) is bundled in the release.
-
-### Install
-1. Open VS Code
-2. Press `Ctrl+Shift+P` (or `Cmd+Shift+P` on Mac)
-3. Type **"Extensions: Install from VSIX"**
-4. Select `scalix-coder-0.2.0.vsix` from the extracted folder
-5. Reload VS Code
-
-### Features
-- Sidebar chat panel with AI assistant
-- Right-click: Explain / Fix / Refactor code selection
-- Model picker and mode selector via slash commands
-- Integrated terminal (`Ctrl+Shift+T`)
-- Open chat in editor area (`Ctrl+Shift+K`)
-
-### Configure
-1. Press `Ctrl+,` to open Settings
-2. Search for "Scalix"
-3. Enter your API key
-4. Or type `/setup` in the chat
-
----
-
-## Updating Users
-
-When releasing a new version:
-
-1. Update `version` in `package.json`
-2. Run `npm run release`
-3. Upload new archives to your hosting (overwrite or add new version)
-4. Update version number in `scripts/install-remote.sh` and `scripts/install-remote.ps1`
-5. Users re-run the one-liner to update:
-   ```bash
-   curl -fsSL https://scalix.world/install.sh | bash
-   ```
-
-### Versioning
-- CLI version: `package.json` → `version` (currently `3.1.0`)
-- Extension version: `vscode-extension/package.json` → `version` (currently `0.2.0`)
-- Both versions should be bumped together for coordinated releases
-
----
-
-## Troubleshooting
-
-### "scalix" command not found after install
-```bash
-# Check if npm global bin is in PATH
-npm bin -g
-
-# On Mac/Linux, add to ~/.bashrc or ~/.zshrc:
-export PATH="$(npm bin -g):$PATH"
-
-# On Windows, npm global bin is usually already in PATH.
-# If not, run install.bat as Administrator.
-```
-
-### Permission denied on Mac/Linux
-```bash
-sudo npm link
-# or
-sudo ./install.sh
-```
-
-### Node.js version too old
-```bash
-node -v   # Must be v18+
-```
-Download latest from https://nodejs.org/
-
-### API key not working
-- Run `/setup` in the chat to re-enter your key
-- Or set the environment variable: `export SCALIX_API_KEY=sk-...`
-- Check Settings in VS Code: `Ctrl+,` → search "Scalix"
-
-### Rate limited
-The agent retries automatically up to 5 times with backoff. If you still see rate limit errors, wait 60 seconds and try again.
-
----
-
-## Security Notes
-
-- **No source code** is distributed — only compiled JavaScript
-- API keys are stored locally at `~/.scalix-coder/config.json` (file permissions: 600)
-- Shell commands have a blocklist for destructive patterns
-- Path traversal is blocked — tools cannot access files outside the workspace
-- All buffers and collections are bounded to prevent memory exhaustion
-- Background processes auto-cleanup after 5 minutes
-- The VS Code extension uses VS Code's Content Security Policy for the webview
-- All webview user content is HTML-escaped before rendering
-
----
-
-## Quick Reference
-
-| Task | Command |
-|---|---|
-| Build release | `npm run release` |
-| Build TypeScript | `npm run build` |
-| Run tests | `npm run test` |
-| Type-check | `npm run typecheck` |
-| Lint | `npm run lint` |
-| All checks | `npm run check` |
-| Build VS Code ext | `cd vscode-extension && npm run build && npm run package` |