OpenFang

Getting Started

install/init/start/spawn/chat commands

Overview
What It Is
Core Concepts
Architecture
Security (16 Layers)
Hands
Ecosystem
Getting Started
Benchmarks
Whitepaper
Sources

Configuration & Quick Start

This page is primarily based on the official Getting Started documentation.

Installation Methods

Method 1: Official Install Script (Linux/macOS)

bash
curl -fsSL https://openfang.sh/install | sh

Method 2: Cargo Install (Cross-Platform)

bash
cargo install --git https://github.com/RightNow-AI/openfang openfang-cli

Or build from source:

bash
git clone https://github.com/RightNow-AI/openfang.gitcd openfangcargo install --path crates/openfang-cli

Method 3: Docker

bash
docker pull ghcr.io/RightNow-AI/openfang:latestdocker run -d \  --name openfang \  -p 4200:4200 \  -e ANTHROPIC_API_KEY=$ANTHROPIC_API_KEY \  -v openfang-data:/data \  ghcr.io/RightNow-AI/openfang:latest

Initialization & Configuration

bash
openfang init

By default, this will create:

  • ~/.openfang/config.toml
  • ~/.openfang/data/

Export a provider key (example):

bash
export ANTHROPIC_API_KEY=sk-ant-...# or export OPENAI_API_KEY=sk-...# or export GROQ_API_KEY=gsk_...

Start Daemon + Open Dashboard

bash
openfang start# http://127.0.0.1:4200/

Spawn/Chat with an Agent

Using built-in templates:

bash
openfang agent spawn agents/hello-world/agent.tomlopenfang agent listopenfang chat hello-world

Common Commands Reference

bash
openfang --versionopenfang doctoropenfang statusopenfang agent spawn <manifest.toml>openfang agent listopenfang agent chat <id>openfang agent kill <id>openfang hand activate <hand>openfang hand status <hand>openfang hand pause <hand>openfang hand resume <hand>openfang hand deactivate <hand>