Installation

Gyrus can be installed from npm or built from source.

Prerequisites

• Bun v1.0.0 or later (for building from source)
• Node.js 18+ (for npm installation)

Install from npm

The easiest way to install Gyrus is via npm:

npm install -g gyrus

Or with your preferred package manager:

# pnpm
pnpm add -g gyrus

# yarn
yarn global add gyrus

# bun
bun add -g gyrus

Build from Source

If you want to build Gyrus from source:

# Clone the repository
git clone https://github.com/ewgenius/gyrus.git
cd gyrus

# Install dependencies
bun install

# Build standalone binary
bun run build

The built binary will be available at ./dist/gyrus.

Verify Installation

After installation, verify Gyrus is working:

gyrus --version

Run the doctor command to check your setup:

gyrus doctor

Next Steps

Once installed, you're ready to set up your first workspace.