Installing Atlas

Install Atlas Locally

To get started with your Atlas evaluation, install the Atlas CLI on your local machine.

macOS + Linux

To download and install the latest release of the Atlas CLI, simply run the following in your terminal:

curl -sSf https://atlasgo.sh | sh

Homebrew

Get the latest release with Homebrew:

brew install ariga/tap/atlas

Docker

To pull the Atlas image and run it as a Docker container:

docker pull arigaio/atlas
docker run --rm arigaio/atlas --help

If the container needs access to the host network or a local directory, use the --net=host flag and mount the desired directory:

docker run --rm --net=host \
  -v $(pwd)/migrations:/migrations \
  arigaio/atlas migrate apply \
  --url "mysql://root:pass@:3306/test"

Windows

Download the latest release and move the atlas binary to a file location on your system PATH.

CI

GitHub Actions

Use the setup-atlas action to install Atlas in your GitHub Actions workflow:

- uses: ariga/setup-atlas@v0
  with:
    cloud-token: ${{ secrets.ATLAS_CLOUD_TOKEN }}

Other CI Platforms

For other CI/CD platforms, use the installation script. See the CI/CD integrations for more details.

Manual Installation

If you want to manually install the Atlas CLI, pick one of the below builds suitable for your system.

MacOS

AMD 64 (md5/sha256)

ARM 64 (md5/sha256)

Linux

AMD 64 (md5/sha256)

ARM 64 (md5/sha256)

Windows

AMD 64 (md5/sha256)

Using a coding agent?

Install the atlas-onboard skill and the database skill for your database: atlas-postgres for PostgreSQL, or atlas-mysql for MySQL and MariaDB. One install command adds them, with the other Atlas skills. atlas-onboard takes your repository through the same path as this guide, and the database skill holds its rules on the dev database, URL scope, roles and grants, and lint findings.

Custom Driver Builds

Oracle, Snowflake, Google Cloud Spanner, and Databricks require a driver-specific build. All other drivers (PostgreSQL, MySQL, MariaDB, SQLite, SQL Server, ClickHouse, Redshift, CockroachDB) are included in the standard install above.

Oracle

curl -sSf https://atlasgo.sh | ATLAS_FLAVOR="oracle" sh

Snowflake

curl -sSf https://atlasgo.sh | ATLAS_FLAVOR="snowflake" sh

Spanner

curl -sSf https://atlasgo.sh | ATLAS_FLAVOR="spanner" sh

Databricks

curl -sSf https://atlasgo.sh | ATLAS_FLAVOR="databricks" sh

Create an Atlas Account

To get the most of your Atlas evaluation, create an Atlas account and use the CLI to log in.

It is possible to use Atlas without logging in, but you will only be able to use a subset of its full feature set. For a more detailed comparison of the features available to logged-in and anonymous users, see the Atlas Feature Comparison guide.

Data Privacy

We do not collect your schemas or any data from your database unless you explicitly decide send it to us. To learn more about how the CLI handles your data head over to the CLI Data Privacy section.

To log in to your account or create a new one, run the following command and follow the instructions:

atlas login