CLI Commands

Command reference, flags, TUI controls, and environment file loading.

Reference

Commands

Command Alias Description
fuku run [profile] r Run services for a profile (default if omitted)
fuku stop [profile] s Stop services by killing processes in service directories
fuku logs [services...] l Stream logs from a running fuku instance
fuku init i Generate a fuku.yaml template
fuku version -v, --version Show version
fuku help -h, --help Show help

Options

Flags

Flag Description
--config, -c Path to config file (default: fuku.yaml, falls back to fuku.yml). Disables automatic override file merging. Only supported with run, stop, and logs commands
--no-ui Run without the interactive TUI (log-only mode)
--profile Filter by profile (used with logs command)

Flags can be placed in any position:

terminal
fuku run core --no-ui
fuku --no-ui run core        # Same result

Examples

Usage examples

terminal
# Run with TUI (default profile)
fuku

# Run a specific profile without TUI
fuku run core --no-ui

# Use short aliases
fuku r core

# Stop services for a profile
fuku stop                       # Default profile
fuku stop core                  # Specific profile

# Stream logs from running instance (separate terminal)
fuku logs                       # All services
fuku logs api auth              # Specific services
fuku logs --profile core api    # Filter by profile
fuku l api db                   # Short alias

# Use a custom config file
fuku --config path/to/fuku.yaml run core
fuku -c custom.yaml run core

# Generate config template
fuku init

# Show help / version
fuku help
fuku version

Keyboard

TUI controls

When running with the interactive TUI (default), use these keyboard shortcuts:

Key Action
/ or k / j Navigate between services
PgUp / PgDn Scroll viewport
Home / End Jump to first / last service
s Stop or start the selected service
r Restart the selected service
ctrl+r Restart all failed services
/ Filter services by name
Esc Clear filter
q Quit and stop all services

Environment

Environment file loading

fuku automatically loads environment files using godotenv, in this order (later files take precedence):

  1. .env
  2. .env.<GO_ENV>
  3. .env.<GO_ENV>.local

If a service directory contains a .env.development file, it is automatically detected and passed to the service via the ENV_FILE variable.