openfang

(β˜… 18,127)

Open-source Agent Operating System

  • .dockerignore
  • .env.example
  • .gitignore
  • AGENTS.md
  • Cargo.lock
  • Cargo.toml
  • CHANGELOG.md
  • CLAUDE.md
  • CONTRIBUTING.md
  • Cross.toml
  • docker-compose.yml
  • Dockerfile
  • flake.nix
  • LICENSE-APACHE
  • LICENSE-MIT
  • MIGRATION.md
  • openfang.toml.example
  • README.md
  • rust-toolchain.toml
  • rustfmt.toml
  • SECURITY.md
  • start-vertex.bat
  • test_vertex_e2e.py

# Installation Guide

1. Get the code
git clone https://github.com/RightNow-AI/openfang

Downloads the entire project code from GitHub to your computer.

cd openfang

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
curl -fsSL https://openfang.sh/install | sh

Downloads and runs the official install script in one line β€” this handles the full setup automatically.

irm https://openfang.sh/install.ps1 | iex

Downloads and runs the official install script via PowerShell β€” this handles the full setup automatically.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

5. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
pip install -r agents/langchain-code-reviewer/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <μ‹€ν–‰ν•  파일λͺ…>.py # READMEμ—μ„œ μ •ν™•ν•œ μ‹€ν–‰ 파일λͺ…을 ν™•μΈν•˜μ„Έμš”

Runs the Python script (or module).

βœ… If it runs without errors and prints output in the terminal, it worked.

6. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo build --workspace --lib

Compiles the Rust project.

cargo test --workspace

Type this command into your terminal and run it.

cargo clippy --workspace --all-targets -- -D warnings

Type this command into your terminal and run it.

cargo fmt --all -- --check

Type this command into your terminal and run it.

βœ… If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation