server¶

Manage the background foil server and the vllm-mlx engine it supervises.

foil server¶

Manage the running foil server and vllm-mlx engine.

Usage:

foil server [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

foil server clear-cache¶

Clear vllm-mlx prefix cache and GPU memory.

Usage:

foil server clear-cache [OPTIONS]

Options:

  --help  Show this message and exit.

foil server license¶

Show current license status.

Usage:

foil server license [OPTIONS]

Options:

  --help  Show this message and exit.

foil server logs¶

Show server logs (foil + vllm-mlx).

Usage:

foil server logs [OPTIONS]

Options:

  -n, --lines INTEGER  Number of lines to show
  -f, --follow         Follow log output
  --help               Show this message and exit.

foil server projects¶

List registered projects.

Usage:

foil server projects [OPTIONS]

Options:

  --help  Show this message and exit.

foil server remove-project¶

Remove a registered project.

Usage:

foil server remove-project [OPTIONS] PROJECT_ID

Options:

  --help  Show this message and exit.

foil server resetpw¶

Reset the web UI password to default (IlovePeach).

Usage:

foil server resetpw [OPTIONS]

Options:

  --help  Show this message and exit.

foil server restart-engine¶

Restart vllm-mlx without restarting the API server.

Usage:

foil server restart-engine [OPTIONS]

Options:

  --help  Show this message and exit.

foil server start¶

Start the foil server in the background. Returns immediately.

Usage:

foil server start [OPTIONS]

Options:

  --port INTEGER    Server port
  --host TEXT       Server host
  --project TEXT    Project directories to register
  -f, --foreground  Run in foreground (default: background)
  --help            Show this message and exit.

foil server status¶

Show status of foil server and vllm-mlx.

Usage:

foil server status [OPTIONS]

Options:

  --help  Show this message and exit.

foil server stop¶

Stop the foil server and vllm-mlx.

Usage:

foil server stop [OPTIONS]

Options:

  --help  Show this message and exit.

When to use each subcommand¶

server start / server stop — lifecycle control. The tray app starts the server for you; use these when running headlessly.
server status — single source of truth for "is everything up?" Reports server, engine, GPU, and active model.
server logs — tail the combined server + engine log at ~/.foil/logs/.
server projects / server remove-project — manage the project registry used by the dashboard.
server clear-cache / server restart-engine — recover from an unhappy vllm-mlx without restarting the whole server.
server license — confirm active edition and license expiry.
server resetpw — reset the web UI admin password if you lose it.