Community Edition

Obtaining Community Binaries

Users that want to use the Community Edition of Atlas which is built directly from the Atlas GitHub repository and licensed under the Apache 2.0 license can do so by following the instructions below.

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 -s -- --community

Docker

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

docker pull arigaio/atlas:latest-community
docker run --rm arigaio/atlas:latest-community --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:latest-community 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.

Manual Installation

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

• MacOS
  • amd64 (md5 / sha256)
  • arm64 (md5 / sha256)
• Windows
  • amd64 (md5 / sha256)
• Linux
  • amd64 (md5 / sha256)
  • arm64 (md5 / sha256)

Community vs Other Editions

License

The Community Edition of Atlas is licensed under the Apache 2.0 license, while the Open Edition is based on both the open-source codebase with some additional proprietary features. Usage of the Open Edition is free under the terms of the Atlas EULA.

Features Unavailable in the Community Edition

Some commands are only available in the Open and Pro Editions:

Versioned Migrations

• migrate checkpoint - Create a checkpoint for the current state of the database.
• migrate down - Roll back the last migration.
• migrate rebase - Reverting applied migration files from the database.
• migrate edit - Edit a migration file.
• migrate rm - Remove a migration file.
• migrate push - Push the migration files to the Schema Registry.
• migrate test - Run tests using the Atlas Testing Framework.

To use these features, please use the Open or Pro Edition of Atlas.

Declarative Migrations

• schema test - Run tests using the Atlas Testing Framework.

Database Features

The following database features are not supported in the Community Edition:

• Views
• Triggers
• Functions and Procedures
• Materialized Views
• Row-level security (RLS)
• Domain types
• Extensions
• Sequences

Drivers

The following drivers are not supported in the Community Edition:

• SQL Server
• ClickHouse
• Redshift