Getting Started

Install fuku and get your services running in minutes.

Three ways to install

Homebrew

brew install tab/apps/fuku

Install Script

curl -fsSL https://getfuku.sh/install.sh | sh

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

Your first run

1. Generate a config file in your project root:

fuku init

2. Edit fuku.yaml to define your services, tiers, and profiles. See the Configuration page for the full reference.

3. 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

By default, fuku executes make run inside each service's directory. You can override this with a custom command:

services:
  api:
    dir: ./api
    command: go run cmd/main.go # Custom command (runs via sh -c)
  worker:
    dir: ./worker
    # No command – uses "make run" (requires Makefile)

When using the default make run, each service directory must contain a Makefile with a run target:

run:
	npm start

Each service inherits fuku's own environment but does not receive any per-service variables injected by fuku — the child runs in its dir, so any tool the service uses is free to load .env files itself. fuku still parses each service's .env files for display in the TUI's info aside (the env tab); see the CLI reference for the load order and the Configuration page for the optional env.files override.

Check the Examples page for real-world configuration patterns.