Skip to content
Servestead

Install and launch

1. Build the CLI

Section titled “1. Build the CLI”

From the repository root:

Terminal window
mkdir -p bin
go build -o ./bin/servestead ./backend

Confirm the binary is available:

Terminal window
./bin/servestead --help

2. Run the preflight

Section titled “2. Run the preflight”
Terminal window
./bin/servestead doctor

Resolve missing local requirements before connecting to a server.

3. Open the terminal UI

Section titled “3. Open the terminal UI”
Terminal window
./bin/servestead setup

The first screen lists saved profiles followed by actions for DigitalOcean provisioning, a new server profile, and the direct legacy tools. Use j and k or the arrow keys to move, then press enter.

The footer changes with each screen. Follow it for available actions. esc returns to the previous screen, q exits from navigation screens, and ctrl+c requests cancellation while work is running.

Expected result

Section titled “Expected result”

An empty configuration root shows no saved profiles. A configured machine lists its profiles with the latest run status. Selecting a profile opens its stage dashboard.

Continue with Connect an existing VPS or Provision with DigitalOcean.