Docs

Getting Started

Install fuku and get your services running in minutes.

Installation

Homebrew

brew install tab/apps/fuku

Download from Releases

Download the latest binary from GitHub Releases.

macOS (Apple Silicon)

cd ~/Downloads
tar -xzf fuku_v0.15.4_macos_arm64.tar.gz
sudo xattr -rd com.apple.quarantine ~/Downloads/fuku_v0.15.4_macos_arm64/fuku
sudo mv ~/Downloads/fuku_v0.15.4_macos_arm64/fuku /usr/local/bin/fuku

macOS (Intel)

cd ~/Downloads
tar -xzf fuku_v0.15.4_macos_amd64.tar.gz
sudo xattr -rd com.apple.quarantine ~/Downloads/fuku_v0.15.4_macos_amd64/fuku
sudo mv ~/Downloads/fuku_v0.15.4_macos_amd64/fuku /usr/local/bin/fuku

Linux

cd ~/Downloads
tar -xzf fuku_v0.15.4_linux_amd64.tar.gz
sudo mv ~/Downloads/fuku_v0.15.4_linux_amd64/fuku /usr/local/bin/fuku

Build from Source

git clone https://github.com/tab/fuku.git
cd fuku
go build -o cmd/fuku cmd/main.go
sudo ln -sf $(pwd)/cmd/fuku /usr/local/bin/fuku

Quick Start

  1. Generate a config file in your project root:
fuku init
  1. Edit fuku.yaml to define your services, tiers, and profiles. See the Configuration page for the full reference.
  1. Run your services:
# Run with the default profile (interactive TUI)
fuku

# Run a specific profile
fuku run core

# Run without TUI
fuku run core --no-ui

Service Requirements

Each service directory must contain a Makefile with a run target. Fuku executes make run inside each service's directory. 

# Makefile
run:
	npm start

If a .env.development file exists in the service directory, fuku automatically detects it and passes it via the ENV_FILE variable.

Check the examples directory for reference configurations.