Every command, grouped by what it manages. prints the same flags with examples. To install the CLI and sign in, see Getting started with the CLI.
Conventions
Commands are . The colon form () also works, and error messages use it.
Bare on a terminal opens the interactive app (). Bare usually lists that group's resources.
Resources can be named by full UUID, the short id from a command, hostname, or IP, wherever the argument says so.
Commands that destroy data, power-cycle, or charge money ask for confirmation on a terminal. When output is piped, pass (), or the command exits 1 without acting.
Ordering and other wizards are interactive on a terminal. Pass with every required flag to script them.
Under an API key, lists only the commands the key can run.
Global flags and environment
Flag
Description
,
Output format. The default is a table on a terminal and JSON when piped.
Show help for the command.
Variable
Description
API key for the current shell. Overrides stored credentials.
Connection profile to use instead of the active one.
API base URL. Overrides the profile and the stored URL.
Store credentials in a file instead of the OS keychain.
Render mode for one-shot commands: , , or .
Disable colour output.
Config directory base. The default is .
File
Description
API URL, active team and project, profiles, directory links, and render mode.
Stored login when no keychain is available. Named profiles use .
Cached minimum-version check, refreshed every six hours.
On Windows the directory is .
Sessions and API keys
Every command works with a browser session from . An API key runs only the commands whose scope it holds; each table below lists the scope. Commands marked session can't be run with an API key: these include Apps, Functions, the account, team, and config commands, SSH keys, payment methods, tickets, consoles, IP purchases, and the interactive app. and run under any key, and and always run.
Auth and account
Command
Description
Sign in through the browser. The CLI prints a URL and a code to confirm in the portal.
Read an API key () from stdin, verify it, and store it. On a terminal it prompts with masked input.
Revoke the session and clear stored credentials. Local credentials are cleared even if the portal is unreachable.
The signed-in account and auth mode. returns the raw account payload. Runs under any API key.
Account details. Same as . returns the raw payload.
Teams, projects, and config
Command
Description
Show the active team, or switch to one by name substring or id prefix. lists your teams; opens a picker.
Organization and billing details. picks a team other than the active one.
Invite a member to the active team. `--role admin
Projects in the active team. Same as .
Active profile, team, project, and user. Same as . () adds the API URL, the output default, and file paths.
Saved connection profiles, with the active one marked.
Create or update a profile: a named API URL with its own login.
Switch profile. clears it.
Delete a profile and its stored login. Alias .
Active team, project, user, API URL, and render mode.
All commands in this section are session-only.
Servers
, , , and share one command set. Replace with the group you need. Bare is the same as .
Command
Description
API-key scope
List instances. , ,
Full details for one instance. Without an id, pick from a list. Alias . ,
, , , , , or . Every action except confirms. polls until the target state; (default 120).
Reinstall with a new OS image. Erases all data. See below.
Change CPU, RAM, disk, or bandwidth in place. See below.
Attach a serial console (Ctrl-] to disconnect), or print a browser URL for a graphical console.
session
Live CPU, memory, disk, uptime, and network I/O. `--timeframe hour
day
Month-to-date usage, allowance, overage, and up to 12 months of history.
Recent activity. (1–100, default 25),
session
Show the boot order, or set it to or .
IP addresses, extra-IP add-ons, and add-ons awaiting payment.
Buy extra IPv4 addresses. Charges immediately. See below.
session
For the other groups, the scopes replace with , , or , for example .
Reinstall
Flag
Description
Required. OS image: the short id from , a full UUID, or an exact name.
Read the new root password from stdin. also works but is visible in your shell history.
Saved SSH key to authorise. Repeatable. takes a raw key instead.
cloud-init username, up to 32 characters.
Your Synteq account password, which reinstall requires. Without it, a terminal prompts. Can't be combined with .
,
Wait until the instance is running again (default 900 seconds).
Skip the confirmation.
Resize
shows a prorated quote before it charges. Upsizes charge your payment method; downsizes issue a prorated credit. Disk can only grow.
Flag
Description
Plan from to use as the target spec. Individual flags override it.
, , ,
Target cores, GB of RAM, GB of disk, and TB of monthly bandwidth. Omitted values stay as they are.
,
Switch to dedicated cores or back to shared.
,
How to pay for an upsize.
Skip the confirmation. The quote still prints.
Extra IPv4 addresses
shows the monthly price and today's charge, then confirms.
Flag
Description
Addresses to add, 1–10 per request (default 1). The per-server cap may be lower.
`--billing-mode prorate
new_cycle`
,
How to pay. A saved BitPay method returns a checkout URL.
Charge without confirming.
Bare metal
manages physical dedicated servers. Bare lists them.
Command
Description
API-key scope
List servers. ,
Full details. Without an id, pick from a list.
Show in-stock offerings and order one. When nothing is in stock, it points you to support. , , , , or , , , , ,
Show the power state, or run , , , , , or . , (default 300),
Reinstall the OS. Erases the server. You confirm by typing the server's reference, or pass . , , , , , (default 1800)
session
Show the one-time install password. It's available for 7 days after provisioning, and every read is logged. reports whether it's still available.
session
Print the URL for the server's graphical console in the portal. Works whether the server is on or off.
session
Month-to-date usage, allowance, overage, and history.
Recent activity. ,
Ordering
asks what you want to order. The subcommands go straight to a wizard, and each is the same as the group's own command.
Command
Same as
Orders
A custom-spec VPS.
A GPU Cloud instance from preset plans.
An Instant Metal server. Alias .
A block storage volume.
All ordering commands need the scope.
Flags for VPS, GPU, and Instant Metal
Flag
Description
Plan id from .
, ,
A custom spec instead of a plan: cores, GB of RAM, and GB of NVMe disk. Pass all three.
Custom bandwidth allowance. The default is the plan's included allowance.
Run a custom spec on dedicated cores.
,
Location and OS image.
Hostname, 5–253 characters. For several servers, repeat once per server.
How many to order (default 1).
`--billing-cycle monthly
quarterly
,
SSH key to install.
,
Root password (8 characters minimum) and cloud-init username.
, ,
How to pay.
Project to bill. The default is the active project.
,
Wait until the server is running and print it (default 600 seconds).
,
Script the order without prompts.
uses a tier ladder instead of a custom spec. Pass , where is the smallest tier, and optionally to pick the VDS category. The location, image, hostname, key, payment, and billing-cycle flags are the same.
Catalog and images
Command
Description
API-key scope
Products and plans for VPS, VDS, GPU Cloud, Instant Metal, and block storage.
OS images for orders and reinstalls. Aliases , . shows full UUIDs.
Block storage
Command
Description
API-key scope
Volumes.
Order a volume. (1–64 characters), (GB, 1–10000), , , , , , ,
Attach a detached volume to a server in the same location. Data is kept across detach and attach.
Detach a volume. Unmount it in the guest first.
Grow a volume after a prorated quote. Volumes can't shrink. `--unit tb
gb--payment-method--apply-credits--yes`
Other resources
Command
Description
API-key scope
Every resource across kinds. , . Alias .
session
IP transit services.
Apps
App commands take , or the slug as their first argument. Without either, they use the app linked to the current directory or its nearest linked parent. All app commands are session-only.
Create and link
Command
Description
Apps in the active project.
Create an app. (default ; a paid plan charges the first month now), , , , ,
Link the directory to an app through a walkthrough: team, project, an existing or new app, then optional variables and GitHub. Same as .
The linked app, its status, hostname, plan, release, and last build. Same as bare .
Remove the directory's link.
Flag on
Description
Link to this app and skip the walkthrough.
Project to look the app up in.
Remove the link.
Never prompt. Requires .
Deploy
builds and releases the current directory, a tarball, or an existing image, then follows the build until the release is live.
Flag
Description
Target app. The default is the linked app.
Directory to upload (default ). In a git checkout, decides what is uploaded; otherwise , , , , and paths in are left out. files are never uploaded. The size limit depends on the app's plan.
Roll out an existing registry image. Can't be combined with .
Build from a at this URL instead of a directory.
Import a file's variables before the build.
Create an app and deploy to it. Use with (default ), , , and for a paid plan , , and .
Return once the build is triggered.
Seconds between status checks (default 5, minimum 2).
Stop waiting after this many seconds (default 1800). The build continues.
The command exits 1 if the build fails or the release doesn't go live. In an unlinked directory on a terminal, it runs the walkthrough first.
Deployments
Command
Description
Releases, newest first.
One build or release: status, steps, and trigger. is a build id, release id, or release number such as .
Redeploy release 's image as a new release.
Environment variables
Command
Description
Keys and scope. Values are never listed.
Set a variable. Quote the pair if the value has spaces. `--scope runtime
Show one value. Config values print in full; secrets show the last 4 characters.
Delete a variable.
sets what happens after the change is saved:
Value
Description
Roll out to running instances after about two minutes without further changes. The default.
Replace running instances with the new environment right away, on the same build.
Start a new build from the current directory.
Wait for your next deploy.
Build and deploy settings
prints the current values. changes only the flags you pass.
Flag on
Description
Subdirectory to build from.
Dockerfile path, relative to the build context.
Docker build context.
Override the container's start command.
Run once before each deploy, for example migrations.
`--auto-deploy on_commit
off`
Comma-separated globs; a push builds only if it changes a matching file. clears it.
Comma-separated globs; changes to matching files don't trigger a build. clears it.
Path a new release must answer before it takes traffic, such as .
Port the app listens on (1–65535). clears it so the port is detected.
Domains
Command
Description
The Synteq hostname and custom domains, with TLS status.
Attach a domain and print the DNS records to create. accepts the plan's custom-domain fee for the first domain.
Re-check DNS and TLS.
Detach a domain.
Plans
Command
Description
The current plan and the plans you can switch to.
Change plan after a proration preview: , , , or .
Logs, metrics, and health
Command
Description
Search log history, or tail live logs with () until Ctrl-C. See the flags below.
CPU, memory, and network against the plan, with the window's peak and average. `--range 15m
Probe the app's health check now.
Flag on
Description
,
Tail live logs instead of querying history.
Window: , , , , , , , , or (default ).
,
An exact window: an ISO timestamp or an age such as . defaults to now.
Case-insensitive substring filter.
One instance only.
Lines to return, newest first (1–5000, default 500).
Timestamps print in your local time zone; returns ISO timestamps.
Functions
Function commands take the function's name as their first argument or . Without either, they use the function linked to the current directory. A directory linked to an app can't be used for function commands, and the reverse. All function commands are session-only.
Create, link, and deploy
Command
Description
Create or reuse a function, link the directory, and write a starter handler if there's no entry file or Dockerfile. Safe to re-run. `--runtime node22
Create a function without linking. Its address is . (default ), , or ,
Link the directory to an existing function. Writes no files. , ,
Functions in the active project.
Configuration, current release, and health. Same as bare .
Upload the directory and follow the build and release. See the flags below.
Remove the directory's link.
Flag on
Description
Directory to upload (default ).
Roll out an existing registry image instead of uploading source.
Create or reuse a function with this name, link the directory, and deploy. Use with , , , and .
,
Set a config or secret variable before the build. Repeatable.
Import a file's variables before the build.
Add a cron trigger before the build.
Return once the build is triggered.
Seconds between status checks (default 3, minimum 2).
Stop waiting after this many seconds (default 600). Ctrl-C also stops watching; the deploy continues.
Deploy without confirming when the files suggest a different runtime than the function's.
uploads text files only and prints every file it skips, with the reason:
A file with a NUL byte in its first 8 KiB is skipped as binary.
, , , , , , , , , , and are skipped at any depth, along with paths matched by a file (gitignore syntax).
and files are never uploaded. , , and are.
Paths are limited to 255 characters with no segments. Symlinks aren't followed.
The total is limited to 5 MB. Over it, the CLI names the largest files and stops.
Change only the settings you pass. `--runtime node22
Stop serving traffic. Requests return and cron triggers stop firing.
Serve traffic again.
Delete the function and unlink its directory. It must have been paused for 14 days. skips retyping the name, but your account password is still required, so a terminal is needed.
Releases, invocation, and logs
Command
Description
Releases, newest first, with the current one marked.
Create a new release from release 's image.
Send a plain HTTPS request to the function, with no Synteq credentials attached. (default ), (default ), /, (default ), (repeatable). returns .
Recent runs, newest first. (default 20, maximum 100), , , , adds captured output and outbound HTTP calls, / prints new runs every 3 seconds.
Environment variables
Command
Description
Keys, kind, and scope. Never values.
Set a variable. `--kind secret
Show one value. Secrets show the last 4 characters; config prints in full.
Delete a variable.
Cron triggers
Schedules are five-field cron expressions in UTC; quote them so the shell doesn't expand the stars. Each firing is a normal run: metered, logged, and listed by . Trigger ids are the short ids from or the full UUID.
Command
Description
Triggers on the function.
Add a trigger. /, ,
Change only the flags you pass. /, , , ,
Fire the trigger now, outside its schedule. Works on a disabled trigger.
Delete a trigger. To pause one, use .
Run credits
These apply to functions on a credits plan. acts on the team credit pool instead of one function.
Command
Description
Balance, plan, monthly grant, credit rate, and auto-reload settings.
Buy run credits with a saved payment method after a price confirmation. , , , ,
buys that many credits whenever the balance drops below (default: one reload's worth). turns it off.
Billing
Command
Description
API-key scope
Account credit balance and recent history. Same as .
Buy account credit with a saved payment method. Card and PayPal settle at once; BitPay returns a checkout URL. , ,
session
Saved payment methods. Same as .
session
Open the portal to add a method. prints the link instead.
session
Make a method the team default.
session
Remove a method. The default can't be removed until another is set.
session
Account credits pay for any resource. Function run credits are separate; see Run credits.
SSH keys
Command
Description
SSH public keys on your account.
Add a key. (1–100 characters), and either or .
Delete a key.
SSH key commands are session-only.
Support tickets
and are the same group. Tickets are named by UUID or by their number from , such as or .
Command
Description
Your tickets. `--status open
The ticket's header and full thread.
Open a ticket. (3–100 characters) and (10–5000 characters, or for stdin) are required. (required when piped), `--priority low
Add a message. (1–5000 characters, or for stdin),
Close a ticket. marks it resolved instead.
Reopen a closed or resolved ticket.
List a ticket's attachments, or download them with (repeatable) or . / (default )
Departments you can open a ticket with.
Ticket commands are session-only.
Tools
Command
Description
Open the interactive app: dashboard, resources, ordering, and billing. Session-only.
Print the automation guide for AI agents and scripts as Markdown, to append to a project's or . Needs no sign-in.
Print shell completion setup for , , or . refreshes the completion cache.
Help for a command, or the list of commands.
synteq api
sends an authenticated request to any portal API path and prints the raw JSON. Use it for endpoints the CLI doesn't wrap; a dedicated command validates input and formats output. The paths are in the API reference. It runs under any session or API key, and the API checks the key's scope per endpoint.
synteq api GET /orders/catalog --query category=gpu_cloudsynteq api POST /orders/preview --input body.json
Argument or flag
Description
, , , , or .
API path starting with . Full URLs are refused.
JSON body from a file, or for stdin. Piped stdin is used automatically.
Query parameter. Repeatable.
Extra header. Repeatable. and can't be overridden.
Print the response status and headers to stderr before the body.
Output is pretty-printed on a terminal and compact when piped.
Exit codes and errors
Code
Meaning
Success.
User error: bad flags, not found, missing scope, or a refused confirmation.
Not signed in, or the session expired. Run .
Server error, network error, or a that timed out or ended in a failed state. Reads are safe to retry.
The CLI is older than the minimum supported version. Run .
In JSON mode an error is one object on stderr. Include the when you contact support.
The minimum-version check is cached for six hours and passes if the portal can't be reached. , , and always run.
Scripting and CI
Server, storage, ordering, and catalog commands run with an API key in . Apps and Functions need a session, so a deploying CI job must reuse a session stored by on a machine where the browser step was completed.
Pass every value as a flag, with and where a command takes them. When stdout isn't a terminal, the CLI never opens a browser or the interactive app.
on , , and blocks until the server reaches its target state and exits 3 if it doesn't.