Back to results
zeabur/cli(opens in a new tab)
Language: Go
Zeabur's official command line tool
- stars
- 68
- watchers
- 4
- forks
- 19
- open issues
- 29
- Last updated
- 10/22/2026
gem-hunterLanguage: Go
Zeabur's official command line tool
Zeabur's official command line tool
Note: Zeabur CLI is currently in beta, and we are still working on it. If you have any questions or suggestions, please feel free to contact us.
No need to install, you can use it directly with npx. Make sure you have Node.js installed.
If you can open the browser:
npx zeabur auth login
Or you can use token to login:
npx zeabur auth login --token <your-token>
Zeabur CLI will open a browser window and ask you to login with your Zeabur account.
# list all projects npx zeabur project ls # set project context, the following commands will use this project context # you can use arrow keys to select the project npx zeabur context set project # list all services in the project npx zeabur service ls # set service context(optional) npx zeabur context set service # set environment context(optional) npx zeabur context set env # restart the service npx zeabur service restart # get the latest deployment info npx zeabur deployment get # get the latest deployment log(runtime) npx zeabur deployment log -t=runtime # get the latest deployment log(build) npx zeabur deployment log -t=build
Non-interactive mode is useful when you want to use Zeabur CLI in a script(such as CI/CD pipeline, etc.)
Note: you can add -i=false to all commands to disable interactive mode.
In fact, if the parameters are complete, it's same whether you use interactive mode or not.
# list all projects npx zeabur project ls -i=false # set project context, the following commands will use this project context npx zeabur context set project --name <project-name> # or you can use project id # npx zeabur context set project --id <project-id> # list all services in the project npx zeabur service ls # set service context(optional) npx zeabur context set service --name <service-name> # or you can use service id # npx zeabur context set service --id <service-id> # set environment context(optional)(only --id is supported) npx zeabur context set env --id <env-id> # restart the service # if service context is set, you can omit the service name; so does environment context npx zeabur service restart --env-id <env-id> --service-name <service-name> # or you can use service id # npx zeabur service restart --env-id <env-id> --service-id <service-id> # get the latest deployment info(if contexts are set, you can omit the parameters) npx zeabur deployment get --env-id <env-id> --service-name <service-name> # or you can use service id # npx zeabur deployment get --env-id <env-id> --service-id <service-id> # get the latest deployment log(runtime)(service id is also supported) npx zeabur deployment log -t=runtime --env-id <env-id> --service-name <service-name> # get the latest deployment log(build)(service id is also supported) npx zeabur deployment log -t=build --env-id <env-id> --service-name <service-name>
npx zeabur <command> --help
By default, the CLI acts under the personal workspace — the account that logged in. To list or create projects under a team you belong to, switch the workspace:
# show your personal workspace + all teams you belong to, with your role per team npx zeabur workspace list # switch to a team — pass either the team name OR its 24-char ObjectID. # A 24-char hex value is always interpreted as an ID; anything else is # looked up by name. If multiple teams share a name the CLI errors out and # prints the per-candidate `workspace switch <id>` invocation so you can # pick by ID (team names are unconstrained, so duplicates are possible). npx zeabur workspace switch acme # show the workspace the CLI is currently using npx zeabur workspace current # return to the personal workspace npx zeabur workspace clear
Switching a workspace clears the pinned project / environment / service context, because resource IDs do not overlap between workspaces.
The workspace only affects directory-level commands (project list, project create, deploy without a linked project). Commands that take a specific service or deployment ID use that resource's own owner and are workspace-independent — your team's service restart works the same regardless of which workspace is active.
For one-off commands that should run under a different workspace without switching the persisted state, use the --workspace flag:
# list projects in the "acme" team without switching workspaces
npx zeabur --workspace acme project listswitch personal is not a way to return to personal — it always looks for a team literally named personal (team names are unconstrained). Use workspace clear to go back.
zeabur api graphql sends any GraphQL query to the Zeabur API with the credentials of the logged-in user and prints the raw JSON response — useful for fields that no dedicated command exposes yet, and for scripts or coding agents that should never handle the token themselves.
# the query is passed as the "query" field npx zeabur api graphql -f query='query { me { _id username } }' # every other field becomes a variable: -f adds a string, -F adds a typed value # (true / false / null / integers; @file or @- reads the value from a file / stdin) npx zeabur api graphql -f query='query($id: ObjectID!) { project(_id: $id) { name } }' -F id=<project-id> npx zeabur api graphql -F query=@query.graphql -F limit=10 # or pass a complete JSON request body echo '{"query": "query { me { _id } }"}' | npx zeabur api graphql --input -
The command exits non-zero when the request fails or the response contains GraphQL errors; the response body is still printed. The request is sent as-is — --workspace and the saved context do not rewrite it, so pass team or project IDs as variables.