> ## Documentation Index > Fetch the complete documentation index at: https://www.latitude.sh/docs/llms.txt > Use this file to discover all available pages before exploring further. # Commands ## General **Log in to Latitude.sh** ```shell theme={null} lsh login ``` Opens your browser for browser-assisted authentication. To authenticate with an API key instead, pass it as an argument: ```shell theme={null} lsh login --with-token ``` **Update the CLI to latest version** ```shell theme={null} lsh update ``` **Generate a shell completion script** ```shell theme={null} lsh completion ``` ## Api Keys **Create an API Key** ```shell theme={null} lsh api_keys create ``` **Delete an API Key** ```shell theme={null} lsh api_keys destroy ``` **List API Keys** ```shell theme={null} lsh api_keys list ``` **Update an API Key** ```shell theme={null} lsh api_keys update ``` ## Auth **Show the current authentication context** ```shell theme={null} lsh auth status ``` Shows the active profile's email, team and API key, plus every other stored profile. Pass `--check` to validate each stored token against the API. **Log out** ```shell theme={null} lsh auth logout ``` Removes the stored profile and, for browser logins, revokes the API key. Pass `--profile ` to log out a specific profile, or `--all` to log out every stored profile. ## Elastic IPs **List Elastic IPs** ```shell theme={null} lsh elastic-ips list ``` Lists all Elastic IPs in the team. `ls` is available as an alias. Filter with `--project`, `--server`, and `--status`, where status is one of `configuring`, `active`, `moving`, `releasing`, or `error`. **Retrieve an Elastic IP** ```shell theme={null} lsh elastic-ips get ``` **Create an Elastic IP** ```shell theme={null} lsh elastic-ips create --project --server ``` Both `--project` and `--server` are required: the API allocates the IP in the target server's region and assigns it there. Allocation is asynchronous, so the new IP starts in the `configuring` status until provisioning completes. **Move an Elastic IP to another server** ```shell theme={null} lsh elastic-ips update --server ``` Reassigns the Elastic IP to another server in the same project. **Delete an Elastic IP** ```shell theme={null} lsh elastic-ips delete ``` Releases the Elastic IP. `rm` is available as an alias. ## Events **List team audit events** ```shell theme={null} lsh events list ``` Lists the team's audit events, newest first, with automatic pagination. Filter the results with `--author` (ID or email), `--project` (ID or slug), `--target-type` (repeatable, e.g. `servers`, `projects`, `virtual_networks`), `--target-id`, and `--action` (e.g. `servers.create`). Use `--since` and `--until` to scope the time range. Both accept either a relative duration looking back from now (`24h`, `7d`, `2w`) or an ISO date (`2026-06-01`): ```shell theme={null} lsh events list --since 24h --target-type servers lsh events list --author user@example.com --action servers.create lsh events list --project my-project --since 2026-06-01 ``` Pass `--follow` (or `-f`) to stream new events in real time instead of printing a one-time list. The command keeps polling and prints each new event as it happens until you stop it with Ctrl+C. Combine it with the usual filters to watch a single resource: ```shell theme={null} lsh events list --follow --target-id sv_xxxx ``` `--follow` streams plain text only: `-o json`, `-o yaml`, and `-o csv` are ignored with a warning, and `--until` is ignored because the stream has no end. Following starts from the current moment unless you pass `--since` to replay recent history before streaming. ## Firewalls **List firewalls** ```shell theme={null} lsh firewalls list ``` Lists all firewalls in the team. `ls` is available as an alias. Filter by project with `--project `. In the interactive table, press Enter on a row to expand that firewall's rules. **Retrieve a firewall** ```shell theme={null} lsh firewalls get ``` **Create a firewall** ```shell theme={null} lsh firewalls create --name --project ``` `--name` and `--project` are both required. Add rules with `--rules`, passing either an inline JSON array or a file with `@path/to/rules.json`: ```shell theme={null} echo '[{"from":"ANY","to":"ANY","protocol":"TCP","port":"22","description":"SSH"}]' > rules.json lsh firewalls create --name web --project my-project --rules @rules.json ``` Each rule accepts `from`, `to`, `protocol` (`TCP` or `UDP`), `port` (a single port or a range), and an optional `description`. **Update a firewall** ```shell theme={null} lsh firewalls update --name ``` Pass `--name`, `--rules`, or both — at least one is required. Passing `--rules` replaces the firewall's entire rule set; pass `[]` to clear all rules. **Delete a firewall** ```shell theme={null} lsh firewalls delete ``` `rm` is available as an alias. ### Firewall assignments An assignment attaches a firewall to a server so the firewall's rules apply to that server's traffic. **Assign a server to a firewall** ```shell theme={null} lsh firewalls assignments create --firewall --server ``` **List firewall assignments** ```shell theme={null} lsh firewalls assignments list --firewall ``` With `--firewall`, lists the assignments of a single firewall. Omit it to list every firewall assignment in the team, optionally filtered by `--server `. **Remove a firewall assignment** ```shell theme={null} lsh firewalls assignments delete --firewall ``` `rm` is available as an alias. ## IPs **List IP addresses of a project** ```shell theme={null} lsh ips list --project ``` Pass `--all-projects` to list IPs across every project you have access to. Filter with `--server`, `--family`, `--type` and `--location`. **Retrieve an IP address** ```shell theme={null} lsh ips get ``` ## Kubernetes Manage Kubernetes clusters, list available versions, and fetch a cluster's kubeconfig. `k8s` is available as an alias: `lsh k8s clusters list`. **List clusters** ```shell theme={null} lsh kubernetes clusters list --project ``` Lists the Kubernetes clusters in a project. This endpoint accepts the project ID (`proj_xxx`) only — it does not resolve slugs. `ls` is available as an alias. **Retrieve a cluster** ```shell theme={null} lsh kubernetes clusters get ``` **Create a cluster** ```shell theme={null} lsh kubernetes clusters create --project --region --plan ``` `--project`, `--region` (site code, e.g. `SAO2`), and `--plan` (the control-plane node plan) are required. Optional flags: `--worker-plan` (defaults to the control-plane plan), `--worker-count` (defaults to 1), `--control-plane-count` (defaults to 1), `--kubernetes-version` (defaults to the latest supported), `--ssh-keys` (SSH key IDs, repeatable), `--os`, and `--name` (auto-generated if omitted). By default the command returns as soon as the request is accepted. Pass `--wait` to block until the cluster is provisioned instead. The wait fails fast if the cluster enters a failed phase, and `--timeout` (default `10m`) caps how long it waits. ```shell theme={null} lsh kubernetes clusters create --project --region SAO2 --plan c2-small-x86 --worker-count 3 --wait ``` **Delete a cluster** ```shell theme={null} lsh kubernetes clusters delete ``` `rm` is available as an alias: `lsh kubernetes clusters rm `. **List available Kubernetes versions** ```shell theme={null} lsh kubernetes versions list ``` **Fetch a cluster's kubeconfig** ```shell theme={null} lsh kubernetes kubeconfig ``` Prints the cluster's kubeconfig as raw YAML to stdout. Redirect it to a file to use with kubectl: ```shell theme={null} lsh kubernetes kubeconfig > kubeconfig.yaml ``` ## Operating Systems **List operating systems available for deployment** ```shell theme={null} lsh operating-systems list ``` `os` is available as an alias: `lsh os list`. ## Plans **Retrieve information of a plan** ```shell theme={null} lsh plans get ``` **List available plans** ```shell theme={null} lsh plans list ``` **List bandwidth package plans** ```shell theme={null} lsh plans list-bandwidth ``` **Show per-location plan availability and stock level** ```shell theme={null} lsh plans stock ``` ## Profiles The CLI stores one profile per team you are logged into. The active profile defines the team your commands run against. **List stored profiles** ```shell theme={null} lsh profile list ``` **Switch the active profile** ```shell theme={null} lsh profile use ``` You can also set the profile for a single command with the global `--profile` flag or the `LSH_PROFILE` environment variable. ## Projects **Create a project** ```shell theme={null} lsh projects create ``` **Delete a project** ```shell theme={null} lsh projects destroy ``` **Retrieve a project** ```shell theme={null} lsh projects get ``` **List projects** ```shell theme={null} lsh projects list ``` **Update a project** ```shell theme={null} lsh projects update ``` ## Regions **List available regions** ```shell theme={null} lsh regions list ``` ## Servers **Deploy a bare metal server** ```shell theme={null} lsh servers create ``` **Delete a server** ```shell theme={null} lsh servers destroy ``` **Get information on a server** ```shell theme={null} lsh servers get ``` **List servers** ```shell theme={null} lsh servers list ``` **Reinstall a server** ```shell theme={null} lsh servers reinstall ``` **Wait for a server to finish provisioning** By default, `servers create` and `servers reinstall` return as soon as the request is accepted. Pass `--wait` to block until the server settles into a stable state (`on` or `off`) instead, which is useful in scripts and CI pipelines where the next step depends on the server being ready. ```shell theme={null} lsh servers create --project --site --plan --operating_system --hostname --wait ``` The wait fails fast if the server enters a failed deployment state, and `--timeout` (default `10m`) caps how long it waits — on timeout the command exits with a non-zero status. Progress is written to stderr while the final server state goes to stdout, so `-o json`, `-o yaml`, and `-o csv` are still honored. ```shell theme={null} lsh servers create ... --wait --timeout 30s ``` **Power on, off, or reboot a server** ```shell theme={null} lsh servers power-on lsh servers power-off lsh servers reboot ``` Each power action is its own subcommand. Pass `--wait` to block until the server reaches the target power state — `on` for `power-on` and `reboot`, `off` for `power-off` — instead of returning as soon as the request is accepted. `power-on` and `power-off` return immediately when the server is already in the target state, while `reboot` waits to observe the power cycle. As with provisioning, `--timeout` (default `10m`) caps the wait, progress is written to stderr, and the wait fails fast if the server enters a failed deployment state. ```shell theme={null} lsh servers reboot --wait ``` **Boot a server into rescue mode** ```shell theme={null} lsh servers rescue-mode lsh servers exit-rescue-mode ``` `rescue-mode` reboots the server into a lightweight recovery environment, and `exit-rescue-mode` reboots it back into its installed operating system. Both accept `--wait`: `rescue-mode` waits for the server to reach the `rescue_mode` state, and `exit-rescue-mode` waits for it to settle back to `on` or `off`. The API doesn't return the rescue login credentials — find them on the server's page in the dashboard. See [Rescue mode](/docs/servers/rescue-mode) for the full recovery workflow. **Lock or unlock a server** ```shell theme={null} lsh servers lock lsh servers unlock ``` Locking a server prevents destructive actions such as deletion, reinstall, and power changes. Unlock it to allow those actions again. **Schedule deletion** ```shell theme={null} lsh servers schedule-deletion ``` **Unschedule deletion** ```shell theme={null} lsh servers unschedule-deletion ``` **Update a server** ```shell theme={null} lsh servers update ``` ## SSH Keys The `lsh ssh-keys` commands manage your team's SSH keys at the account level. To manage the keys inside a specific project, use [`lsh projects ssh-keys`](#project-ssh-keys) instead. The legacy `ssh_keys` name still works as a hidden alias. **List SSH keys** ```shell theme={null} lsh ssh-keys list ``` Filter by tag with `--tags `. Lists paginate automatically; use `--page-size`, `--max-items`, or `--no-paginate` to control paging. `ls` is available as an alias. **Retrieve an SSH key** ```shell theme={null} lsh ssh-keys get ``` **Create an SSH key** ```shell theme={null} lsh ssh-keys create --name --public-key "ssh-ed25519 AAAA..." ``` Both `--name` and `--public-key` are required. **Update an SSH key** ```shell theme={null} lsh ssh-keys update --name ``` Only the flags you pass are changed. Pass `--name` to rename the key and `--tags ` (repeatable) to associate tags. **Delete an SSH key** ```shell theme={null} lsh ssh-keys delete ``` `rm` is available as an alias. **Manage a project's SSH keys** ```shell theme={null} lsh projects ssh-keys list --project lsh projects ssh-keys get --project lsh projects ssh-keys create --project --name --public-key "ssh-ed25519 AAAA..." lsh projects ssh-keys delete --project ``` The `projects ssh-keys` commands (`list`, `get`, `create`, and `delete`) manage SSH keys scoped to a project. `create` adds a new key to the project and `delete` removes it entirely, rather than detaching a team key. Commands default to the active project, so `--project` is optional once one is set. ## Storage Filesystems Manage file storage volumes in a project. Filesystems are created from the dashboard; the CLI lists, resizes, and deletes them. **List filesystems** ```shell theme={null} lsh storage-filesystems list --project ``` `ls` is available as an alias. Pass `--project` to filter to a single project. **Resize a filesystem** ```shell theme={null} lsh storage-filesystems update --size ``` Size is the only field you can update. `--size` is required and must be a positive number of GB; otherwise the command fails before making any request. **Delete a filesystem** ```shell theme={null} lsh storage-filesystems delete ``` `rm` is available as an alias. ## Storage Objects Manage S3-compatible object storage buckets in a project. **List buckets** ```shell theme={null} lsh storage-objects list --project ``` `ls` is available as an alias. Pass `--project` to filter to a single project. **Retrieve a bucket** ```shell theme={null} lsh storage-objects get ``` **Create a bucket** ```shell theme={null} lsh storage-objects create --project --name --region ``` `--project`, `--name`, and `--region` are required. `--region` takes a site slug (for example, `DAL`). Optionally pass `--storage-class` (`standard` or `high_performance`), `--versioning` to enable object versioning, and `--locking` to enable object lock (WORM). Object lock requires versioning, so `--locking` enables it automatically. ```shell theme={null} lsh storage-objects create --project my-project --name logs --region DAL --storage-class high_performance --versioning ``` **Delete a bucket** ```shell theme={null} lsh storage-objects delete ``` `rm` is available as an alias. ## Tags **Create a Tag** ```shell theme={null} lsh tags create ``` **Delete Tag** ```shell theme={null} lsh tags destroy ``` **List all Tags** ```shell theme={null} lsh tags list ``` **Update Tag** ```shell theme={null} lsh tags update ``` The `lsh tags` commands manage the tags themselves. To attach a tag to a resource, pass `--tags` to that resource's own update command: ```shell theme={null} lsh servers update --id --tags lsh projects update --id --tags ``` ## Traffic **Show traffic consumption** ```shell theme={null} lsh traffic list --project ``` Shows bandwidth consumption per region for a project, mirroring the dashboard: inbound and outbound totals, the quota, and how much of it has been used. Units follow the project's billing method — TB for volume billing, Mbps for 95th-percentile billing. A project is required; in an interactive terminal you're prompted to pick one when `--project` is omitted. The range defaults to the last 7 days. Override it with `--since` and `--until`, which accept a duration (`24h`, `7d`, `2w`) or an ISO date (`2026-06-01`). The range applies to consumption only — the quota column always reflects the current limit. Pass `--daily` for the day-by-day breakdown behind the dashboard chart. ```shell theme={null} lsh traffic list --project my-project --daily lsh traffic list --project my-project --since 30d lsh traffic list --project my-project --since 2026-05-01 --until 2026-06-01 ``` **Show traffic quota** ```shell theme={null} lsh traffic quota ``` Shows the traffic quota of each project, per region. Pass `--project` to filter to a single project. ## Teams Team and member operations are interactive: when you omit an argument or required flag, the CLI prompts you for it in the terminal. **List your teams** ```shell theme={null} lsh teams list ``` **Create a team** ```shell theme={null} lsh teams create --name --currency ``` **Update a team** ```shell theme={null} lsh teams update --name ``` **List members of the current team** ```shell theme={null} lsh teams members list ``` **Invite a user to the current team** ```shell theme={null} lsh teams members add --email --role ``` Roles: `owner`, `administrator`, `collaborator` or `billing`. **Remove a user from the current team** ```shell theme={null} lsh teams members remove ``` ## User Data The `lsh user-data` commands manage your team's [user data](/docs/servers/user-data) scripts at the account level. To manage the user data inside a specific project, use [`lsh projects user-data`](#project-user-data) instead. The API stores user data content base64-encoded. To keep things simple, `--content` takes plain text and encodes it for you, while `--content-base64` passes an already-encoded value through unchanged. The two flags are mutually exclusive. **List user data** ```shell theme={null} lsh user-data list ``` `ls` is available as an alias. Lists show a compact table without the base64 content, and paginate automatically; use `--page-size`, `--max-items`, or `--no-paginate` to control paging. **Retrieve a user data entry** ```shell theme={null} lsh user-data get ``` The details view decodes and shows the cloud-init content, and is scrollable for longer scripts. **Create a user data entry** ```shell theme={null} lsh user-data create --description --content "#cloud-config" ``` `--description` is required. Pass the script with either `--content` (plain text) or `--content-base64` (already encoded). **Update a user data entry** ```shell theme={null} lsh user-data update --description ``` Only the flags you pass are changed. Provide at least one of `--description` or `--content`/`--content-base64`. **Delete a user data entry** ```shell theme={null} lsh user-data delete ``` `rm` is available as an alias. **Manage a project's user data** ```shell theme={null} lsh projects user-data list --project lsh projects user-data get --project lsh projects user-data create --project --description --content "#cloud-config" lsh projects user-data update --project --description lsh projects user-data delete --project ``` The `projects user-data` commands manage user data scoped to a project, with the same `--content` and `--content-base64` handling as the account-level commands. Commands default to the active project, so `--project` is optional once one is set. Unlike the other list commands, `projects user-data list` returns a single page; the pagination flags are accepted but have no effect. ## Virtual Machines `vm` and `vms` are available as aliases: `lsh vm list`, `lsh vms get `. **List virtual machines** ```shell theme={null} lsh virtual-machines list ``` Lists every virtual machine in the team. Filter with `--project ` and `--tags ` (repeatable or comma-separated). **Retrieve a virtual machine** ```shell theme={null} lsh virtual-machines get ``` **Create a virtual machine** ```shell theme={null} lsh virtual-machines create --plan --project ``` `--plan` and `--project` are required. Pass the plan ID (`plan_xxx`) — virtual machine plans have no slug. Optional flags: `--name` (hostname), `--region` (site slug, e.g. `DAL`; defaults to `DAL`), `--os` (operating system slug), `--ssh-keys` (SSH key IDs, repeatable), `--user-data` (a user data record reference such as `ud_xxx`, applied as cloud-init), and `--tags` (tag IDs, repeatable). By default the command returns as soon as the request is accepted. Pass `--wait` to block until the VM reaches the `Running` state instead. `--timeout` (default `10m`) caps the wait; on timeout the command exits with a non-zero status. Progress is written to stderr and the final state to stdout, so `-o json`, `-o yaml`, and `-o csv` are honored. ```shell theme={null} lsh virtual-machines create --plan --project --region DAL --name my-vm --wait ``` **Update a virtual machine** ```shell theme={null} lsh virtual-machines update --name ``` Updates the virtual machine's name or tags. Pass `--name` and/or `--tags` (tag IDs; replaces all existing tags) — at least one is required. **Run a power action** ```shell theme={null} lsh virtual-machines action --action ``` `--action` is required and must be one of `power_on`, `power_off`, or `reboot`. **Delete a virtual machine** ```shell theme={null} lsh virtual-machines delete ``` `rm` is available as an alias: `lsh virtual-machines rm `. ## Virtual Networks **Creates a virtual network** ```shell theme={null} lsh virtual_networks create ``` **Delete a virtual network** ```shell theme={null} lsh virtual_networks destroy ``` **Retrieve a virtual network** ```shell theme={null} lsh virtual_networks get ``` **List virtual networks** ```shell theme={null} lsh virtual_networks list ``` **Update a virtual network** ```shell theme={null} lsh virtual_networks update ``` ## Virtual Networks Assignments **Assign a server to a virtual network** ```shell theme={null} lsh assignments virtual_networks create ``` **Unassign a server from a virtual network** ```shell theme={null} lsh assignments virtual_networks destroy ``` **List assignments** ```shell theme={null} lsh assignments virtual_networks list ``` ## Help * Use `lsh -h` to get a list of all available commands * To see how to use a command, use `lsh -h` The CLI also ships built-in help topics with longer guides: ```shell theme={null} lsh authentication # How to sign in: tokens, profiles, env vars lsh profiles # How profiles map to teams lsh automation # Run lsh non-interactively (CI, scripts, AI agents) lsh output-formats # Render results as table, JSON, YAML or CSV (with JMESPath queries) ``` See [Output formats & automation](/docs/cli/output-formats) for the full guide to machine-readable output, `--query` filtering, and pagination.