Skip to content

CLI

LyftData includes a CLI for running the server in evaluation mode, administering the control plane, and automating common workflows.

Connect to a server

The CLI targets a server URL (HTTPS by default). Set it once per shell:

  • Linux/macOS: export LYFTDATA_URL=https://server-host:3000/
  • Windows (PowerShell): $env:LYFTDATA_URL = "https://server-host:3000/"

Then authenticate:

Terminal window
lyftdata login admin

If the server is using the default self-signed certificate, re-run with --tls-insecure (or set LYFTDATA_TLS_INSECURE=true) until you install a trusted certificate.

Common commands

  • Help: lyftdata --help, lyftdata <command> --help
  • Version: lyftdata --version
  • Run components: lyftdata run server, lyftdata run worker
  • Jobs: lyftdata jobs …
  • Workers: lyftdata workers …
  • Deployments: lyftdata deployments …
  • Diagnostics: lyftdata diag, lyftdata doctor

External worker hosts

For dedicated worker hosts, use the worker-only binary:

  • lyftdata-worker --help
  • Windows service management: lyftdata-worker service install --help

See Workers and your OS-specific worker guide for full setup steps.