DevGrid CLI

The DevGrid CLI is a command-line wrapper for the DevGrid API. Use it to sync project configuration from a local devgrid.yml file, send deployment and build events, and automate CI/CD workflows.

Authentication

The CLI uses OAuth bearer tokens as the primary authentication method. You can log in once and reuse cached credentials locally, pass credentials per command for CI pipelines, or continue using a legacy API key (deprecated).

See Setup to install the CLI and authenticate, and Commands for the full command reference including login, logout, and auth status.

What you need in your repo

Place a devgrid.yml file in your repository root. The CLI reads this file to know which applications and components to create or update on the DevGrid platform.

Typical workflow

1. Install the CLI
2. Authenticate with devgrid login (or configure CI credentials)
3. Create or edit devgrid.yml — see devgrid.yml reference
4. Validate with devgrid lint
5. Preview changes with devgrid dry_run
6. Apply with devgrid sync

Related pages

• Setup — download, install, and authenticate
• Commands — full command reference
• devgrid.yml — configuration file format
• Troubleshooting — common errors and fixes