We use cookies to understand how people use Depot.
Overview

Quickstart

Installing the CLI

For Mac, you can install the CLI with Homebrew:

brew install depot/tap/depot

For Linux, you can install the CLI with our installation script:

# Install the latest version
curl -L https://depot.dev/install-cli.sh | sh

# Install a specific version
curl -L https://depot.dev/install-cli.sh | sh -s 0.25.0

For all other platforms, you can download the binary directly from the latest release.

Creating a project

Projects typically represent a single Dockerfile or repository.

  1. Go to your organizations inside of Depot
  2. Click on the Create Project button
  3. Enter a project name
  4. Choose your connection type, Depot Hosted or Self-Hosted
  5. Click Create Project

Running a local build

  1. Run depot login to authenticate with your Depot account
  2. cd to your project directory
  3. Run depot init to link the local directory with a Depot project - this will create a depot.json file in the current directory
  4. Run depot build -t repo/image:tag .

Running a build in CI

  1. cd to your project directory
  2. Run depot init to link the local directory with a Depot project - this will create a depot.json file in the current directory
  3. Commit your depot.json file to your repository
  4. Create a Depot project token
  5. Configure your CI provider to use your project token
  6. Update your CI workflow to set the DEPOT_TOKEN environment variable to your project token
env:
  DEPOT_TOKEN: ${{ secrets.DEPOT_TOKEN }}
  1. Update your CI workflow to use depot build instead of docker build.
- run: docker build -t ...
+ run: depot build -t ...