Skip to content

droneship login

Sign in through your browser.

Your account and project are fixed at sign-in, so switching project means signing in again with --project.

--headless is for a machine with no browser — typically an SSH session on a dev box, which is where this CLI most often runs. The default flow needs the browser’s redirect to reach a listener on THIS machine, so over SSH it only works with port forwarding. Headless instead shows a short code to approve from any device.

Terminal window
droneship login [OPTIONS]
Option Description Default
--api-url API_URL Forge control plane (env: DRONESHIP_API_URL)
--auth-url AUTH_URL Sign-in server URL (env: DRONESHIP_AUTH_URL)
--project NAME|ID Sign in to this project instead of your current one — its name, slug, or id
--headless No browser on this machine — show a code to approve from another device
--force Replace this profile’s login even when it points at a different deployment

Sign in with your browser:

Terminal window
droneship login

On a machine with no browser (for example, over SSH), print a code to approve from another device:

Terminal window
droneship login --headless

Sign in to a specific project:

Terminal window
droneship login --project my-project

Sign in to another deployment under its own profile. login refuses to move a signed-in profile to a different deployment unless you pass --force:

Terminal window
droneship --profile staging login --api-url https://<api-host> --auth-url https://<auth-host>

Generated from the CLI. Verified against droneship 1.12.0.