oku

README

Oku Agent (oku)

Swap and bridge across 30+ chains and trade perps on Oku, from your terminal or your AI agent.

• Swap tokens across 30+ chains with quotes from multiple routes.
• Bridge between supported EVM chains.
• Trade perps on Hyperliquid with orders, positions and risk controls.
• Work with agents using JSON output, offline docs, skills and MCP. Review every prepared action before submitting.

Status: Public alpha. Commands may change.

AI agents: start here. If a user gave you this repository so you can install or use oku (not develop it), stop. Read and follow Bootstrap in docs/agents.md before you run any install or login command. Login needs the user's interactive terminal.

Install

Pick one method. Upgrades, uninstall and more options are in all install methods.

Homebrew (macOS and Linux)

brew install oku-trade/tap/oku

npm

npm install -g @gfxlabs/oku-cli

Arch Linux (AUR)

yay -S oku-bin

Debian/Ubuntu

V=$(curl -fsSLo /dev/null -w '%{url_effective}' https://github.com/oku-trade/oku-cli/releases/latest); V=${V##*/v}
curl -fsSLO "https://github.com/oku-trade/oku-cli/releases/download/v$V/oku_${V}_linux_amd64.deb" # linux_arm64 on arm64
sudo apt install "./oku_${V}_linux_amd64.deb"

Fedora/RHEL

V=$(curl -fsSLo /dev/null -w '%{url_effective}' https://github.com/oku-trade/oku-cli/releases/latest); V=${V##*/v}
sudo dnf install "https://github.com/oku-trade/oku-cli/releases/download/v$V/oku-$V-1.x86_64.rpm" # aarch64 on arm64

Install script (macOS and Linux, no sudo)

curl -fsSLO https://raw.githubusercontent.com/oku-trade/oku-cli/master/scripts/install.sh
sh install.sh # installs to ~/.local/bin

Go

go install github.com/oku-trade/oku-cli/cmd/oku@latest

mise

mise use -g github:oku-trade/oku-cli

Nix

nix profile add github:oku-trade/oku-cli

From source

git clone https://github.com/oku-trade/oku-cli.git && cd oku-cli
make install # $HOME/.local/bin/oku

Quick start

oku auth login
oku account summary
oku wallet balances --chain 42161
oku orders prepare --market BTC --side buy --type market --size 0.0002
# Review the returned account, market, side, size and digest against your request.
oku orders submit --intent ID --digest SHA
oku orders status --intent ID

Once the companion Accounts fee-association change and authorization-page change are deployed, sign in to your existing Oku site account on the authorization page when running oku auth login. The page proves control of the embedded agent wallet under a separate Privy-based Oku Agent session, then associates that wallet with your site account for fee calculation only. Historical trading volume from both identities, including trades before association, contributes to the fee tier in both directions. The CLI session stays the standalone agent identity, not a login to your primary Oku account. It cannot access the primary account's sessions, settings, balances or order history. Agent-wallet funds and Hyperliquid agent approval remain separate. No accounts or order histories are merged, and there is no unlink flow. Existing CLI sessions remain standalone and do not need logout or re-login for fee association. The shared fee tier is applied server-side. This documentation does not imply a live rollout.

Use your own trusted RPC for wallet transactions: save it once with oku rpc set 42161 URL (or set OKU_RPC_URL_42161, which takes precedence). See usage for agent-wallet funds, JSON input and unknown outcomes.

Use with your AI agent

oku skills install --target claude # or codex, jcode, or --dir PATH
claude mcp add oku -- oku mcp serve

For Codex, add this to ~/.codex/config.toml:

[mcp_servers.oku]
command = "oku"
args = ["mcp", "serve"]

MCP is read-only by default. To expose mutation tools, start the server with oku mcp serve --allow-mutations. See agent setup for skills, permissions and other clients.

Docs

• Install: methods, upgrades, uninstall and completions.
• Agents: skills, MCP and authorization.
• Usage: workflows, JSON, funds and recovery.
• Commands: command and flag reference.
• Security: credentials, signing and revocation.
• Telemetry: optional usage telemetry.
• Architecture: CLI design.

Read these offline with oku docs list and oku docs show <name>.

License

AGPL-3.0-only. See LICENSE.

Documentation

Overview

Package oku embeds the canonical documentation and agent skill assets that live at the repository root so installed binaries can serve them offline.

Index

• func Docs() fs.FS
• func Skills() fs.FS

Functions

func Docs

func Docs() fs.FS

Docs returns the bundled docs/ directory as a filesystem rooted at docs/.

func Skills

func Skills() fs.FS

Skills returns the bundled skills/ directory rooted at skills/, one subdirectory per skill containing SKILL.md.