Skip to content

Getting started

By the end of this guide, one project will be registered with Cadder and visible from both the terminal and the TUI.

Keep the release together. Use cadder, cadderd, and the caddy shim from the same release. Cadder rejects mixed versions before changing runtime state.

  1. Download Cadder.

    Download the release archive and its matching SHA-256 file for your platform. Verify the archive, then extract cadder, cadderd, and the caddy shim into one user-owned directory.

    See Releases for the supported archives and upgrade path.

  2. Add the Cadder directory to PATH.

    Add the directory containing all three executables to your user PATH. Cadder does not change PATH for you.

  3. Select the real Caddy executable.

    Copy cadder.toml.example to cadder.toml beside the executables, then set one real Caddy source.

    Windows:

    [caddy]
    real_path = "C:/Tools/caddy/caddy-real.exe"

    macOS and Linux:

    [caddy]
    real_path = "/usr/local/bin/caddy-real"

    You may set real_command instead of real_path, but never both. See Configure real Caddy for the selection order.

  4. Run a managed project.

    Open a project that contains a Caddyfile and run the command it already uses:

    caddy run

    The shim starts or attaches to cadderd, registers the project routes, and keeps the registration alive until the command exits. Start other projects the same way.

  5. Confirm the current state.

    cadder status
    cadder projects list
    cadder domains list

    These commands show the daemon, real Caddy, registered projects, and registered domains without opening the full-screen interface.

  6. Open the operator.

    cadder tui --start-daemon

    The option starts or attaches to cadderd before the operator opens. Use Up and Down to select a project or domain. Space and Enter toggle it. Stop and Restart ask for confirmation before changing the runtime.

Start with the boundary closest to the problem:

cadder caddyfile inspect ./Caddyfile
cadder port inspect 3000
cadder diagnostics

Use CLI and TUI for domain inspection, bounded logs, and the guarded port-owner command.