Community Edition
Atlas is available in two editions: the standard distribution (the standard Atlas CLI), which
includes all database features and integrations and unlocks Atlas Pro
capabilities after atlas login, and the Community Edition, a minimal build distributed under
the Apache 2.0 license.
For most users we recommend the standard distribution below. If you specifically need a fully open-source build, see Installing the Community Edition.
Installing Standard Atlas
To download and install the latest release of the standard Atlas CLI, use one of the options below.
This is the recommended build for most users - it supports every database driver and feature, and
unlocks Atlas Pro features such as migration linting, testing, and CI/CD integration after running
atlas login.
- macOS + Linux
- Homebrew
- Docker
- Windows
- CI
- Manual Installation
To download and install the latest release of the Atlas CLI, simply run the following in your terminal:
curl -sSf https://atlasgo.sh | sh
Get the latest release with Homebrew:
brew install ariga/tap/atlas
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"
Download the latest release and move the atlas binary to a file location on your system PATH.
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.
Community Edition vs. Atlas
The Community Edition is built directly from the Atlas GitHub repository and is licensed under the Apache 2.0 license. It includes the core schema management engine but omits many commands, database features, drivers, and integrations that are available in the standard Atlas distribution.
The following table summarizes the differences:
| Capability | Community | Atlas |
|---|---|---|
| License | Apache 2.0 | Atlas EULA |
| Core schema management (MySQL, PostgreSQL, SQLite, MariaDB) | ✅ | ✅ |
Versioned migrations (migrate diff, apply, status) | ✅ | ✅ |
Advanced migration commands (checkpoint, down, rebase, edit, rm) | ☒ | ✅ |
Migration linting (migrate lint, schema lint) | ☒ | ✅ |
Declarative workflows (schema plan, validate) | ☒ | ✅ |
| Pre-migration checks, hooks & approval policies | ☒ | ✅ |
| Schema drift detection | ☒ | ✅ |
Atlas Registry (migrate push, schema push) | ☒ | ✅ |
Testing framework (migrate test, schema test) | ☒ | ✅ |
| Database objects (views, triggers, functions, sequences, partitions, RLS, and more) | ☒ | ✅ |
| Additional drivers (SQL Server, ClickHouse, Redshift, Aurora DSQL, CockroachDB, YugabyteDB, Oracle, Spanner, Snowflake, Databricks, Azure Fabric) | ☒ | ✅ |
| Integrations (Kubernetes Operator, Terraform, GitHub Actions, IDE plugins, Go SDK) | ☒ | ✅ |
License
The Community Edition of Atlas is licensed under the Apache 2.0 license. The standard distribution
is built from the same open-source codebase plus some additional proprietary features, and is free
to download and use under the terms of the Atlas EULA.
Running atlas login unlocks Atlas Pro features such as migration linting,
testing, and CI/CD integration. New users get a free 30-day trial, after which a license is required
to continue using Atlas Pro.
Features Unavailable in the Community Edition
The Community Edition does not support the following commands and integrations:
Versioned Migrations
migrate lint- Lint the migration directory for destructive or unsafe changes.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 Atlas Registry.migrate test- Run tests using the Atlas Testing Framework.
Declarative Migrations
schema lint- Run schema linting.schema test- Run tests using the Atlas Testing Framework.schema plan- Pre-plan declarative migrations.schema push- Push a new version to Atlas Registry.schema validate- Validate a schema definition
Schema Governance
The Community Edition does not include Atlas's schema governance and "gatekeeper" capabilities that guard changes before they reach production:
- Migration linting - Detect destructive and unsafe changes using Atlas's analyzers.
- Pre-migration checks - Assertions that must pass before a migration is applied.
- Pre/post migration hooks - Run custom commands around migration execution.
- Migration approval policies - Require reviewer sign-off before applying a migration.
- Schema drift detection - Detect when a database has drifted from its desired schema.
Integrations and Providers
- Atlas Kubernetes Operator
- Atlas Terraform Provider
- Atlas Action
- Atlas CircleCI Orb
- Atlas JetBrains Plugin
- Atlas VSCode Extension
- Atlas Neovim LSP
- Atlas Go SDK
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
- Composite types
- Table Partitioning
Drivers
The following drivers are not supported in the Community Edition:
- SQL Server
- ClickHouse
- Redshift
- Aurora DSQL
- CockroachDB
- Azure HorizonDB
- YugabyteDB
- Oracle
- Spanner
- Snowflake
- Databricks
- Azure Fabric
Installing the Community Edition
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
- Docker
- Windows
- Manual Installation
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
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"
Download the latest release and move the atlas binary to a file location on your system PATH.