Skip to content
Servestead

Install and Launch

Build the current Servestead source, confirm the CLI, and open the local control plane.

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. Launch Servestead Web

Section titled “3. Launch Servestead Web”
Terminal window
./bin/servestead ui

Servestead binds to a random local loopback port, prints the session URL, and opens it in your default browser. Keep this terminal process running while you use the interface.

If the Browser Does Not Open

Section titled “If the Browser Does Not Open”
Terminal window
./bin/servestead ui --no-open

Copy the printed http://127.0.0.1:…/ui?token=… URL into a browser on the same machine. Treat that URL as a temporary session credential and do not share it.

Use a Predictable Local Port

Section titled “Use a Predictable Local Port”
Terminal window
./bin/servestead ui --addr 127.0.0.1:8080 --no-open

The address must use localhost, 127.0.0.1, or ::1. Servestead rejects non-loopback bindings.

4. Close the Session

Section titled “4. Close the Session”

Use Shutdown in the left navigation, or return to the terminal and press Ctrl+C. Closing only the browser tab does not stop the local process.

Expected Result

Section titled “Expected Result”

The Command Center opens. On a first run it shows No profiles yet and links to Start setup. On later runs it selects the most recently updated profile.

Continue with Connect an existing VPS or Provision with DigitalOcean.