-o json or -o yaml with any command for machine-readable output. Run gitpod help or add --help to any command for details.
Environment commands
| Command | Description |
|---|---|
gitpod environment list | List your environments |
gitpod environment create <repo-url> | Create a new environment |
gitpod environment start <id> | Start an environment |
gitpod environment stop <id> | Stop an environment |
gitpod environment delete <id> | Delete an environment |
gitpod environment ssh <id> | SSH into an environment |
gitpod environment ssh-config | Configure SSH for direct access |
gitpod environment logs <id> | View environment logs |
gitpod environment keep-alive | Keep environment alive while a process runs |
Partial environment IDs
Instead of typing full UUIDs, use any substring of an environment ID:Port commands
| Command | Description |
|---|---|
gitpod environment port list | List open ports |
gitpod environment port open <port> | Open a port (supports --name) |
gitpod environment port close <port> | Close a port |
Automation commands
| Command | Description |
|---|---|
gitpod automations init | Initialize automations config |
gitpod automations update automations.yaml | Update automations from file |
gitpod automations task list | List tasks |
gitpod automations task start <ref> | Start a task |
gitpod automations task logs <ref> | View task logs |
gitpod automations service list | List services |
gitpod automations service start <ref> | Start a service |
Webhook commands
| Command | Description |
|---|---|
gitpod webhook create | Create a webhook (--name, --type, --scope, --provider) |
gitpod webhook secret get <id> | Get the signing secret for a webhook |
Dotfiles commands
| Command | Description |
|---|---|
gitpod user dotfiles get | View current dotfiles config |
gitpod user dotfiles set --repository <url> | Set dotfiles repository |
gitpod user dotfiles set | Clear dotfiles config |
-o json and -o yaml output. See dotfiles documentation.
Project and group commands
| Command | Description |
|---|---|
gitpod project list | List projects |
gitpod project create <repo-url> | Create a project |
gitpod group list | List groups |
gitpod group create --name "<name>" | Create a group |
Identity commands
| Command | Description |
|---|---|
gitpod whoami | Show current user and access level |
gitpod login | Authenticate via browser |
gitpod login --token "<token>" | Authenticate with PAT |
Configuration commands
| Command | Description |
|---|---|
gitpod config context list | List CLI contexts |
gitpod config context use <name> | Switch context |
Shell completion
Version and updates
| Command | Description |
|---|---|
gitpod version | Show CLI version |
gitpod version update | Update to latest version |
gitpod version update --verify-slsa | Update with SLSA verification |
gitpod config set --verify-slsa=true | Enable SLSA verification for all future updates |
gitpod config set --autoupdate=true | Enable automatic updates |
~/.gitpod/configuration.yaml.
Related
- CLI installation and setup — install, authenticate, and connect
- automations.yaml schema — task and service configuration
- Environment variables — variable behavior and availability