installation.md

Installation Guide

English | 简体中文

Prerequisites (环境要求)

Before installing Orion, ensure you have the following dependencies installed:

1. Git: Version 2.20+ (Required for git worktree support).
2. Tmux: Required for session management.

   # macOS
   brew install tmux

3. Qwen: The AI agent runtime. Ensure qwen is in your PATH.
4. Go: Version 1.21+ (Required to build from source).

One-Click Install (Recommended)

You can install Orion using the following command:

curl -fsSL https://raw.githubusercontent.com/bytedance/Orion/main/install.sh | bash

Manual Install (Build from Source)

If you prefer to build from source or contribute to the project:

# 1. Clone the repository
git clone https://github.com/bytedance/Orion.git
cd Orion

# 2. Build the binary
go build -o bin/orion main.go

# 3. Add to PATH (Optional)
export PATH=$PWD/bin:$PATH

Local Install (Override /usr/local/bin)

If you are developing Orion locally and want to install/override the binary under /usr/local/bin:

make local-install

To uninstall:

make uninstall

Verification (验证安装)

Run the following command to verify the installation:

orion --version
# Local build (make local-install): Orion version dev
# install.sh (GitHub release): Orion version vX.Y.Z

Next Steps

Once installed, you can start by initializing a workspace. See Human Node Guide.