Skip to content

Commit 96c7261

Browse files
Merge pull request #352 from depot/claude/issue-351-20250521_125038
Update README with new commands and parameters
2 parents be49c42 + ae92faf commit 96c7261

File tree

1 file changed

+101
-1
lines changed

1 file changed

+101
-1
lines changed

README.md

Lines changed: 101 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,22 @@ Official CLI for [Depot](https://depot.dev) - you can use the CLI to build Docke
2020
- [Flags for `build`](#flags-for-build)
2121
- [`depot cache`](#depot-cache)
2222
- [`depot cache reset`](#depot-cache-reset)
23+
- [`depot exec`](#depot-exec)
2324
- [`depot gocache`](#depot-gocache)
2425
- [`depot configure-docker`](#depot-configure-docker)
2526
- [`depot list`](#depot-list)
2627
- [`depot list projects`](#depot-list-projects)
2728
- [`depot list builds`](#depot-list-builds)
29+
- [`depot projects`](#depot-projects)
30+
- [`depot projects create`](#depot-projects-create)
31+
- [`depot projects list`](#depot-projects-list)
2832
- [`depot init`](#depot-init)
2933
- [`depot login`](#depot-login)
3034
- [`depot logout`](#depot-logout)
35+
- [`depot pull`](#depot-pull)
36+
- [`depot push`](#depot-push)
37+
- [`depot pull-token`](#depot-pull-token)
38+
- [`depot version`](#depot-version)
3139
- [Contributing](#contributing)
3240
- [License](#license)
3341

@@ -266,6 +274,30 @@ Reset the cache of a specific project ID
266274
depot cache reset --project 12345678910
267275
```
268276

277+
### `depot exec`
278+
279+
Execute a command with an injected BuildKit connection. This command launches a remote machine in Depot's infrastructure, establishes a connection to it, and makes this connection available to the specified command through an environment variable.
280+
281+
**Example**
282+
283+
```shell
284+
# Run a command with access to a remote BuildKit instance
285+
depot exec --platform linux/amd64 docker build .
286+
287+
# Run a Dagger command using Depot's infrastructure
288+
depot exec dagger run ...
289+
```
290+
291+
#### Flags for `exec`
292+
293+
| Name | Description |
294+
| ------------- | ----------------------------------------------------------------- |
295+
| `env-var` | Environment variable name for the BuildKit connection (default: "BUILDKIT_HOST") |
296+
| `platform` | Platform to execute the command on (linux/amd64 or linux/arm64) |
297+
| `project` | Depot project ID |
298+
| `progress` | Set type of progress output ("auto", "plain", "tty") |
299+
| `token` | Depot token |
300+
269301
### `depot gocache`
270302

271303
Configure Go tools to use Depot Cache. The Go tools will use the remote cache service to store and retrieve build artifacts.
@@ -366,6 +398,43 @@ Output builds in JSON for the project in the current directory.
366398
depot list builds --output json
367399
```
368400

401+
### `depot projects`
402+
403+
Create and manage Depot projects.
404+
405+
#### `depot projects create`
406+
407+
Create a new Depot project. This command creates a new project in your Depot account with the specified configuration.
408+
409+
**Example**
410+
411+
```shell
412+
# Create a project with default settings
413+
depot projects create
414+
415+
# Create a project with custom settings
416+
depot projects create --organization your-org-id --region us-west-2 --cache-storage-policy 100
417+
```
418+
419+
#### Flags for `projects create`
420+
421+
| Name | Description |
422+
| --------------------- | ------------------------------------------------------------ |
423+
| `organization` / `-o` | Depot organization ID |
424+
| `region` | Build data storage region (default: "us-east-1") |
425+
| `cache-storage-policy`| Build cache to keep per architecture in GB (default: 50) |
426+
| `token` | Depot API token |
427+
428+
#### `depot projects list`
429+
430+
List Depot projects. This command is functionally identical to `depot list projects` and provides an interactive listing of your Depot projects.
431+
432+
**Example**
433+
434+
```shell
435+
depot projects list
436+
```
437+
369438
### `depot init`
370439

371440
Initialize an existing Depot project in the current directory. The CLI will display an interactive list of your Depot projects for you to choose from, then write a `depot.json` file in the current directory with the contents `{"projectID": "xxxxxxxxxx"}`.
@@ -419,10 +488,41 @@ Push an image from the Depot registry to a destination registry.
419488
depot push --tag repo:tag <BUILD_ID>
420489
```
421490

491+
### `depot pull-token`
492+
493+
Create a new pull token for the Depot registry. This command outputs a token string that can be used to authenticate with the Depot registry to pull images, which is useful in CI/CD environments or when direct authentication isn't possible.
494+
495+
**Example**
496+
497+
```shell
498+
# Create a pull token for a specific build
499+
depot pull-token <BUILD_ID>
500+
501+
# Create a pull token for a specific project
502+
depot pull-token --project <PROJECT_ID>
503+
```
504+
505+
#### Flags for `pull-token`
506+
507+
| Name | Description |
508+
| ---------- | ------------------ |
509+
| `project` | Depot project ID |
510+
| `token` | Depot API token |
511+
512+
### `depot version`
513+
514+
Display version information for the Depot CLI, including the version number, build date, and a link to the corresponding GitHub release.
515+
516+
**Example**
517+
518+
```shell
519+
depot version
520+
```
521+
422522
## Contributing
423523

424524
PR contributions are welcome! The CLI codebase is evolving rapidly, but we are happy to work with you on your contribution.
425525

426526
## License
427527

428-
MIT License, see `LICENSE`
528+
MIT License, see `LICENSE`

0 commit comments

Comments
 (0)