From 8febff17009b6a143e02f865f01ec7a22b30af37 Mon Sep 17 00:00:00 2001 From: untra Date: Fri, 23 Jan 2026 23:17:17 -0700 Subject: [PATCH 1/5] docs updates further --- docs/getting-started/installation.md | 48 ++++++++++++++---- docs/getting-started/prerequisites.md | 70 ++++++++++++++++++++++++--- 2 files changed, 100 insertions(+), 18 deletions(-) diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index e7fc2a6..abe1c1e 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -6,29 +6,54 @@ layout: doc # Installation -This guide covers installing Operator on macOS. +This guide covers installing Operator on macOS, Linux, and Windows. -## Download +## VS Code Extension (Recommended) -Get the latest release from the [Downloads](/downloads/) page or use the command line: +The **VS Code Extension** is the recommended way to get started with Operator. +Install from VS Code Marketplace + +Works on **macOS**, **Linux**, and **Windows** - no additional setup required. + +For detailed setup instructions, see the [VS Code Extension documentation](/getting-started/sessions/vscode/). + +--- + +## CLI Installation (Alternative) + +For headless servers, CI/CD pipelines, or advanced workflows, install the CLI binary for your platform. + +### macOS ```bash # Apple Silicon (M1/M2/M3) curl -L https://github.com/untra/operator/releases/latest/download/operator-macos-arm64 -o operator - -# Intel Mac -curl -L https://github.com/untra/operator/releases/latest/download/operator-macos-x86_64 -o operator +chmod +x operator +sudo mv operator /usr/local/bin/ ``` -## Install - -Move the binary to your PATH: +### Linux ```bash +# ARM64 +curl -L https://github.com/untra/operator/releases/latest/download/operator-linux-arm64 -o operator + +# x86_64 +curl -L https://github.com/untra/operator/releases/latest/download/operator-linux-x86_64 -o operator + chmod +x operator sudo mv operator /usr/local/bin/ ``` +### Windows (PowerShell) + +```powershell +Invoke-WebRequest -Uri "https://github.com/untra/operator/releases/latest/download/operator-windows-x86_64.exe" -OutFile "operator.exe" +# Add to PATH or move to desired location +``` + +For checksums and all available downloads, see the [Downloads](/downloads/) page. + ## Verify Installation Confirm Operator is installed correctly: @@ -45,12 +70,15 @@ Create a configuration file: operator init ``` -This creates `~/.config/operator/config.toml` with default settings. +This creates the configuration file with default settings: +- **macOS/Linux**: `~/.config/operator/config.toml` +- **Windows**: `%APPDATA%\operator\config.toml` ## Next Steps Configure your integrations: +- [Set up a Session Manager](/getting-started/sessions/) - [Set up a Coding Agent](/getting-started/agents/claude/) - [Connect your Kanban Provider](/getting-started/kanban/jira/) - [Link your Git Repository](/getting-started/git/github/) diff --git a/docs/getting-started/prerequisites.md b/docs/getting-started/prerequisites.md index d6349d0..4478148 100644 --- a/docs/getting-started/prerequisites.md +++ b/docs/getting-started/prerequisites.md @@ -10,29 +10,79 @@ Before installing Operator, ensure your system meets the following requirements. ## System Requirements -- **Operating System**: macOS 12.0+ (Monterey or later) -- **Architecture**: Apple Silicon (arm64) or Intel (x86_64) +### Supported Platforms + +| Platform | Versions | Architectures | +|----------|----------|---------------| +| macOS | 12.0+ (Monterey or later) | Apple Silicon (arm64), Intel (x86_64) | +| Linux | Modern distributions | arm64, x86_64 | +| Windows | 10+ | x86_64 | + +### Hardware Requirements + - **Memory**: 4GB RAM minimum, 8GB recommended - **Disk Space**: 100MB for Operator, plus space for project files ## Required Software -### tmux +### Git -Operator uses tmux for session management. Install via Homebrew: +Version control is required for project management. Verify installation: ```bash -brew install tmux +git --version # Should be 2.30+ ``` -### Git +**Installation by platform:** + +| Platform | Installation | +|----------|--------------| +| macOS | `brew install git` or install Xcode Command Line Tools | +| Linux | Use package manager (`apt install git`, `dnf install git`, etc.) | +| Windows | Download [Git for Windows](https://git-scm.com/download/win) | + +### Session Manager + +Operator requires a session manager for launching and managing coding agents: + +| Platform | Recommended | Alternative | +|----------|-------------|-------------| +| macOS | [VS Code Extension](/getting-started/vscode-extension/) | tmux | +| Linux | [VS Code Extension](/getting-started/vscode-extension/) | tmux | +| Windows | [VS Code Extension](/getting-started/vscode-extension/) (required) | N/A | + +#### VS Code Extension + +The VS Code Extension provides the best experience across all platforms and is **required on Windows**. See [VS Code Extension Setup](/getting-started/vscode-extension/) for installation instructions. -Version control is required for project management: +#### tmux (macOS/Linux only) +For terminal-based workflows on macOS and Linux, tmux can be used as an alternative session manager: + +**macOS:** ```bash -git --version # Should be 2.30+ +brew install tmux +``` + +**Linux:** +```bash +# Debian/Ubuntu +apt install tmux + +# Fedora/RHEL +dnf install tmux ``` +> **Note**: tmux is not available on Windows. Windows users must use the VS Code Extension. + +## Windows-Specific Notes + +Windows support has some limitations: + +- **Session Manager**: VS Code Extension is required (tmux not available) +- **Backstage Server**: Not supported on Windows +- **Notifications**: Native notifications are planned; currently logs only + ## Optional Dependencies ### Coding Agent @@ -43,6 +93,10 @@ At least one AI coding agent should be installed: - [Codex](/getting-started/agents/codex/) - [Gemini](/getting-started/agents/gemini/) +### Backstage Server (macOS/Linux only) + +For centralized project management across multiple repositories, see [Backstage Server Setup](/getting-started/backstage-server/). Note: Not supported on Windows. + ### Kanban Integration For issue tracking integration, configure: From bcca0e621e8127faa06f9d376599ed359daa04f1 Mon Sep 17 00:00:00 2001 From: untra Date: Sat, 24 Jan 2026 11:58:13 -0700 Subject: [PATCH 2/5] asset adjustments --- .github/workflows/vscode-extension.yaml | 2 +- Cargo.lock | 25 +++++++++++++++++++++ Cargo.toml | 1 + README.md | 2 +- docs/_includes/head.html | 4 ++-- {img => docs/assets/img}/operator_logo.svg | 0 docs/assets/{ => img}/patricia_128.png | Bin docs/assets/{ => img}/patricia_512.png | Bin 8 files changed, 30 insertions(+), 4 deletions(-) rename {img => docs/assets/img}/operator_logo.svg (100%) rename docs/assets/{ => img}/patricia_128.png (100%) rename docs/assets/{ => img}/patricia_512.png (100%) diff --git a/.github/workflows/vscode-extension.yaml b/.github/workflows/vscode-extension.yaml index 1dea8f6..3941252 100644 --- a/.github/workflows/vscode-extension.yaml +++ b/.github/workflows/vscode-extension.yaml @@ -168,7 +168,7 @@ jobs: name: Publish to Marketplace needs: build-vsix runs-on: ubuntu-latest - if: github.event_name == 'workflow_dispatch' && github.event.inputs.publish == 'true' + if: github.event_name == 'push' && github.ref == 'refs/heads/main' steps: - uses: actions/checkout@v4 diff --git a/Cargo.lock b/Cargo.lock index 39cd19f..d9b6383 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -843,6 +843,12 @@ dependencies = [ "syn", ] +[[package]] +name = "env_home" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c7f84e12ccf0a7ddc17a6c41c93326024c42920d7ee630d04950e6926645c0fe" + [[package]] name = "equivalent" version = "1.0.2" @@ -1961,6 +1967,7 @@ dependencies = [ "tui-textarea", "utoipa", "uuid", + "which", ] [[package]] @@ -3641,6 +3648,18 @@ dependencies = [ "rustls-pki-types", ] +[[package]] +name = "which" +version = "7.0.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "24d643ce3fd3e5b54854602a080f34fb10ab75e0b813ee32d00ca2b44fa74762" +dependencies = [ + "either", + "env_home", + "rustix 1.1.2", + "winsafe", +] + [[package]] name = "winapi" version = "0.3.9" @@ -4133,6 +4152,12 @@ dependencies = [ "memchr", ] +[[package]] +name = "winsafe" +version = "0.0.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d135d17ab770252ad95e9a872d365cf3090e3be864a34ab46f48555993efc904" + [[package]] name = "wit-bindgen" version = "0.46.0" diff --git a/Cargo.toml b/Cargo.toml index 7bb5338..98fb2a6 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -62,6 +62,7 @@ regex = "1" once_cell = "1" lazy_static = "1" backon = "1" +which = "7" # System info (for core count) sysinfo = "0.32" diff --git a/README.md b/README.md index ab21603..bd9cb59 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![Operator! logo](./img/operator_logo.svg) +![Operator! logo](docs/assets/img/operator_logo.svg) # Operator! diff --git a/docs/_includes/head.html b/docs/_includes/head.html index 807a1c1..da2637c 100644 --- a/docs/_includes/head.html +++ b/docs/_includes/head.html @@ -4,8 +4,8 @@ {% if page.title %}{{ page.title }} | {% endif %}{{ site.title }} - - + +