opcode README

The project's README from github.com/winfunc/opcode. As one markdown file: README.md.

opcode Logo

opcode

A powerful GUI app and Toolkit for Claude Code

Create custom agents, manage interactive Claude Code sessions, run secure background agents, and more.

Features Installation Usage Development Discord

457013521-6133a738-d0cb-4d3e-8746-c6768c82672c

https://github.com/user-attachments/assets/6bceea0f-60b6-4c3e-a745-b891de00b8d0

[!TIP] ⭐ Star the repo and follow @getAsterisk on X for early access to asteria-swe-v0.

[!NOTE] This project is not affiliated with, endorsed by, or sponsored by Anthropic. Claude is a trademark of Anthropic, PBC. This is an independent developer project using Claude.

🌟 Overview

opcode is a powerful desktop application that transforms how you interact with Claude Code. Built with Tauri 2, it provides a beautiful GUI for managing your Claude Code sessions, creating custom agents, tracking usage, and much more.

Think of opcode as your command center for Claude Code - bridging the gap between the command-line tool and a visual experience that makes AI-assisted development more intuitive and productive.

📋 Table of Contents

✨ Features

🗂️ Project & Session Management

🤖 CC Agents

📊 Usage Analytics Dashboard

🔌 MCP Server Management

⏰ Timeline & Checkpoints

📝 CLAUDE.md Management

📖 Usage

Getting Started

  1. Launch opcode: Open the application after installation
  2. Welcome Screen: Choose between CC Agents or Projects
  3. First Time Setup: opcode will automatically detect your ~/.claude directory

Managing Projects

Projects → Select Project → View Sessions → Resume or Start New

Creating Agents

CC Agents → Create Agent → Configure → Execute
  1. Design Your Agent: Set name, icon, and system prompt
  2. Configure Model: Choose between available Claude models
  3. Set Permissions: Configure file read/write and network access
  4. Execute Tasks: Run your agent on any project

Tracking Usage

Menu → Usage Dashboard → View Analytics

Working with MCP Servers

Menu → MCP Manager → Add Server → Configure

🚀 Installation

Prerequisites

Release Executables Will Be Published Soon

🔨 Build from Source

Prerequisites

Before building opcode from source, ensure you have the following installed:

System Requirements

Required Tools

  1. Rust (1.70.0 or later)

    # Install via rustup
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

  2. Bun (latest version)

    # Install bun
curl -fsSL https://bun.sh/install | bash

  3. Git

    # Usually pre-installed, but if not:
# Ubuntu/Debian: sudo apt install git
# macOS: brew install git
# Windows: Download from https://git-scm.com

  4. Claude Code CLI

Platform-Specific Dependencies

Linux (Ubuntu/Debian)

# Install system dependencies
sudo apt update
sudo apt install -y \
  libwebkit2gtk-4.1-dev \
  libgtk-3-dev \
  libayatana-appindicator3-dev \
  librsvg2-dev \
  patchelf \
  build-essential \
  curl \
  wget \
  file \
  libssl-dev \
  libxdo-dev \
  libsoup-3.0-dev \
  libjavascriptcoregtk-4.1-dev

macOS

# Install Xcode Command Line Tools
xcode-select --install

# Install additional dependencies via Homebrew (optional)
brew install pkg-config

Windows

Build Steps

  1. Clone the Repository

    git clone https://github.com/getAsterisk/opcode.git
cd opcode

  2. Install Frontend Dependencies

    bun install

  3. Build the Application

    For Development (with hot reload)

    bun run tauri dev

    For Production Build

    # Build the application
bun run tauri build

# The built executable will be in:
# - Linux: src-tauri/target/release/
# - macOS: src-tauri/target/release/
# - Windows: src-tauri/target/release/

  4. Platform-Specific Build Options

    Debug Build (faster compilation, larger binary)

    bun run tauri build --debug

    Universal Binary for macOS (Intel + Apple Silicon)

    bun run tauri build --target universal-apple-darwin

Troubleshooting

Common Issues

  1. "cargo not found" error

    • Ensure Rust is installed and ~/.cargo/bin is in your PATH
    • Run source ~/.cargo/env or restart your terminal

  2. Linux: "webkit2gtk not found" error

    • Install the webkit2gtk development packages listed above
    • On newer Ubuntu versions, you might need libwebkit2gtk-4.0-dev

  3. Windows: "MSVC not found" error

    • Install Visual Studio Build Tools with C++ support
    • Restart your terminal after installation

  4. "claude command not found" error

    • Ensure Claude Code CLI is installed and in your PATH
    • Test with claude --version

  5. Build fails with "out of memory"

    • Try building with fewer parallel jobs: cargo build -j 2
    • Close other applications to free up RAM

Verify Your Build

After building, you can verify the application works:

# Run the built executable directly
# Linux/macOS
./src-tauri/target/release/opcode

# Windows
./src-tauri/target/release/opcode.exe

Build Artifacts

The build process creates several artifacts:

All artifacts are located in src-tauri/target/release/.

🛠️ Development

Tech Stack

Project Structure

opcode/
├── src/                   # React frontend
│   ├── components/        # UI components
│   ├── lib/               # API client & utilities
│   └── assets/            # Static assets
├── src-tauri/             # Rust backend
│   ├── src/
│   │   ├── commands/      # Tauri command handlers
│   │   ├── checkpoint/    # Timeline management
│   │   └── process/       # Process management
│   └── tests/             # Rust test suite
└── public/                # Public assets

Development Commands

# Start development server
bun run tauri dev

# Run frontend only
bun run dev

# Type checking
bunx tsc --noEmit

# Run Rust tests
cd src-tauri && cargo test

# Format code
cd src-tauri && cargo fmt

🔒 Security

opcode prioritizes your privacy and security:

  1. Process Isolation: Agents run in separate processes
  2. Permission Control: Configure file and network access per agent
  3. Local Storage: All data stays on your machine
  4. No Telemetry: No data collection or tracking
  5. Open Source: Full transparency through open source code

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Areas for Contribution

📄 License

This project is licensed under the AGPL License - see the LICENSE file for details.

🙏 Acknowledgments

Made with ❤️ by the Asterisk

Report Bug · Request Feature

Star History

Star History Chart

opcode (winfunc/opcode)

Searching Database…

22.4K ·GitHub
Opcode
What is this?opcode is an unofficial desktop GUI app and toolkit for Claude Code: it lets you manage coding sessions, custom agents, usage costs, MCP servers and CLAUDE.md files from one visual interface instead of the terminal.
Is it a separate desktop app, or something that runs inside the terminal?It's a standalone desktop app: Tauri 2 with a Rust backend and a React 18 + TypeScript UI. It bridges the Claude Code CLI with a visual experience and automatically detects your existing ~/.claude directory on first launch.
How do I get it running?Installers aren't published yet, so you currently build from source: clone the repo, install the frontend dependencies with Bun, then build — you get .dmg, .msi/.exe, .deb or .AppImage artifacts.
What do I need to have installed before building it?Claude Code CLI must already be installed and in your PATH — opcode is the visual layer on top of it. To compile the app you also need Rust 1.70+, Bun and Git.
Any build pitfalls I should know about?A few platform quirks: Linux needs the webkit2gtk dev packages, Windows needs MSVC Build Tools (plus WebView2), and low-RAM machines may need cargo build -j 2 to avoid out-of-memory failures.
Will it run on my Windows PC, or is it Mac-only?It runs on Windows 10/11, macOS 11+ and Linux (Ubuntu 20.04+). macOS can also be built as a universal binary covering both Intel and Apple Silicon.
Does anything I do in it leave my machine?No: all data is stored locally, there is no telemetry or tracking, and agents run in separate processes with per-agent file and network permissions you configure.
What can the custom CC Agents do?You design an agent with a name, icon and system prompt, pick the Claude model, and set permissions for file read/write and network access. Agents run in the background as separate processes, and every run is logged with detailed performance metrics.
Can I see how much I'm spending on Claude?Yes — the usage dashboard tracks API costs in real time, breaks tokens down by model, project and time period, and lets you export the data for accounting. Charts show your usage trends.
Can I roll my coding session back to an earlier point?Yes. You can create checkpoints anywhere in a session, browse them on a branching timeline, restore any checkpoint in one click, fork new branches from checkpoints, and view a diff of what changed between them.
Does it help manage MCP servers?There's a central registry for Model Context Protocol servers: add them through the UI or as JSON, import configs from Claude Desktop, and test each connection before using it.
What are similar projects?casbin-gateway, claudecodeui, ThinkWatch-Lite, void, ai-manager, zuse, laya, skills-manager
Which topics is it in?anthropic-claude, claude-ai, cost-tracking, ide, tauri, tailwindcss, agpl, cursor, sqlite, anthropic, coding-agent, desktop
Creator
winfunc
Size
3.2 MB
Stars
22.4K
Updated
CommitSep 18Releasev0.2.0Aug 31
Age
1y
Commits · 90 Days