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 是一个非官方的 Claude Code 桌面图形界面应用和工具集:它让你在一个可视化界面里管理编程会话、自定义智能体、使用成本、MCP 服务器和 CLAUDE.md 文件,而不用去操作终端。
它是一个独立的桌面应用,还是在终端里运行的东西?它是一个独立的桌面应用:采用 Tauri 2,Rust 后端,React 18 + TypeScript 界面。它把 Claude Code 命令行工具和可视化体验连接起来,并在首次启动时自动检测你已有的 ~/.claude 目录。
我怎么把它跑起来?安装包还没有发布,所以目前只能从源码构建:克隆仓库,用 Bun 安装前端依赖,然后构建 —— 你会得到 .dmg、.msi/.exe、.deb 或 .AppImage 安装包。
构建之前我需要装好哪些东西?必须先安装 Claude Code 命令行工具并加入 PATH —— opcode 是它之上的可视化层。要编译这个应用,你还需要 Rust 1.70+、Bun 和 Git。
构建时有什么坑需要提前知道?有几点平台差异:Linux 需要 webkit2gtk 开发包,Windows 需要 MSVC Build Tools(外加 WebView2),内存小的机器可能需要用 cargo build -j 2 来避免内存不足导致构建失败。
它能在我的 Windows 电脑上运行吗,还是只有 Mac 才能用?它可以在 Windows 10/11、macOS 11+ 和 Linux(Ubuntu 20.04+)上运行。macOS 还可以构建成同时覆盖 Intel 和 Apple Silicon 的通用二进制包。
我在里面做的任何事会离开我的电脑吗?不会:所有数据都存储在本地,没有任何遥测或追踪,智能体在独立进程中运行,并且每个智能体的文件和网络访问权限都由你自己配置。
自定义 CC Agents 能做什么?你可以给智能体设计名称、图标和系统提示词,选择 Claude 模型,并设置文件读写和网络访问权限。智能体在后台作为独立进程运行,每次运行都会记录详细的性能指标。
我能看到自己在 Claude 上花了多少钱吗?可以 —— 用量仪表盘实时追踪 API 费用,按模型、项目和时间段细分 token 用量,还能导出数据用于记账。图表会展示你的使用趋势。
我能把编程会话回滚到更早的时间点吗?可以。你可以在会话中的任意位置创建检查点,在分支时间线上浏览它们,一键恢复任意检查点,从检查点分出新分支,还能查看它们之间改动的 diff。
它能帮忙管理 MCP 服务器吗?它有一个 Model Context Protocol 服务器的中央注册中心:可以通过界面或 JSON 添加,从 Claude Desktop 导入配置,并在使用前逐个测试连接。
Creator
winfunc
Size
3.2 MB
Stars
22.4K
Age
1y
Commits · 90 Days