Skip to main content

CLI Reference

Introduction​

This document serves as reference documentation for all available commands in the Atlas CLI. Similar information can be obtained by running any atlas command with the -h or --help flags.

For a more detailed introduction to the CLI capabilities, head over to the Getting Started page.

Distributed Binaries​

Starting v0.3.0, ΦΏthe distributed binaries include code for a Management UI wrapping the core atlas engine that is not currently released publicly. The binaries themselves are still released under the same Apache License 2.0.

Building from Source​

If you would like to build Atlas from source without the UI code run:

go get ariga.io/atlas/cmd/atlas

atlas env​

Print atlas environment variables.

Usage​

atlas env

Details​

'atlas env' prints atlas environment information.

Every set environment param will be printed in the form of NAME=VALUE.

List of supported environment parameters:

  • ATLAS_NO_UPDATE_NOTIFIER: On any command, the CLI will check for new releases using the GitHub API. This check will happen at most once every 24 hours. To cancel this behavior, set the environment variable "ATLAS_NO_UPDATE_NOTIFIER".

atlas migrate​

Manage versioned migration files

Usage​

atlas migrate

Details​

'atlas migrate' wraps several sub-commands for migration management.

Flags​

      --dir string           select migration directory using URL format (default "file://migrations")
--env string set which env from the project file to use
--force force a command to run on a broken migration directory state
--format string set migration file format (default "atlas")
--schema strings set schema names
--var stringToString input variables (default [])

atlas migrate diff​

Compute the diff between the migration directory and a connected database and create a new migration file.

Usage​

atlas migrate diff [flags]

Details​

'atlas migrate diff' uses the dev-database to re-run all migration files in the migration directory and compares it to a given desired state and create a new migration file containing SQL statements to migrate the migration directory state to the desired schema. The desired state can be another connected database or an HCL file.

Example​

  atlas migrate diff --dev-url mysql://user:pass@localhost:3306/dev --to mysql://user:pass@localhost:3306/dbname
atlas migrate diff --dev-url mysql://user:pass@localhost:3306/dev --to file://atlas.hcl

Flags​

      --dev-url string   [driver://username:password@address/dbname?param=value] select a data source using the URL format
--to string [driver://username:password@address/dbname?param=value] select a data source using the URL format
--verbose enable verbose logging

atlas migrate hash​

Hash (re-)creates an integrity hash file for the migration directory.

Usage​

atlas migrate hash

Details​

'atlas migrate hash' computes the integrity hash sum of the migration directory and stores it in the atlas.sum file. This command should be used whenever a manual change in the migration directory was made.

Example​

  atlas migrate hash --force

atlas migrate new​

Creates a new empty migration file in the migration directory.

Usage​

atlas migrate new

Details​

'atlas migrate new' creates a new migration according to the configured formatter without any statements in it.

Example​

  atlas migrate new my-new-migration

atlas migrate validate​

Validates the migration directories checksum and SQL statements.

Usage​

atlas migrate validate [flags]

Details​

'atlas migrate validate' computes the integrity hash sum of the migration directory and compares it to the atlas.sum file. If there is a mismatch it will be reported. If the --dev-url flag is given, the migration files are executed on the connected database in order to validate SQL semantics.

Example​

  atlas migrate validate
atlas migrate validate --dir /path/to/migration/directory
atlas migrate validate --dir /path/to/migration/directory --dev-url mysql://user:pass@localhost:3306/dev

Flags​

      --dev-url string   [driver://username:password@address/dbname?param=value] select a data source using the URL format

atlas schema​

Work with atlas schemas.

Usage​

atlas schema

Details​

The atlas schema command groups subcommands for working with Atlas schemas.

Flags​

      --env string           set which env from the project file to use
--var stringToString input variables (default [])

atlas schema apply​

Apply an atlas schema to a target database.

Usage​

atlas schema apply [flags]

Details​

'atlas schema apply' plans and executes a database migration to bring a given database to the state described in the Atlas schema file. Before running the migration, Atlas will print the migration plan and prompt the user for approval.

If run with the "--dry-run" flag, atlas will exit after printing out the planned migration.

Example​

  atlas schema apply -u "mysql://user:pass@localhost/dbname" -f atlas.hcl
atlas schema apply -u "mysql://localhost" -f atlas.hcl --schema prod --schema staging
atlas schema apply -u "mysql://user:pass@localhost:3306/dbname" -f atlas.hcl --dry-run
atlas schema apply -u "mariadb://user:pass@localhost:3306/dbname" -f atlas.hcl
atlas schema apply --url "postgres://user:pass@host:port/dbname?sslmode=disable" -f atlas.hcl
atlas schema apply -u "sqlite://file:ex1.db?_fk=1" -f atlas.hcl

Flags​

  -f, --file string      [/path/to/file] file containing the HCL schema.
-u, --url string URL to the database using the format:
[driver://username:password@address/dbname?param=value]
-s, --schema strings Set schema names.
--dev-url string URL for the dev database. Used to validate schemas and calculate diffs
before running migration.
--dry-run Dry-run. Print SQL plan without prompting for execution.
--auto-approve Auto approve. Apply the schema changes without prompting for approval.
-w, --web Open in a local Atlas UI.
--addr string used with -w, local address to bind the server to. (default ":5800")
--verbose enable verbose logging

atlas schema diff​

Calculate and print the diff between two schemas.

Usage​

atlas schema diff [flags]

Details​

'atlas schema diff' connects to two given databases, inspects them, calculates the difference in their schemas, and prints a plan of SQL statements to migrate the "from" database to the schema of the "to" database.

Flags​

      --from string   [driver://username:password@protocol(address)/dbname?param=value] Select data source using the url format
--to string [driver://username:password@protocol(address)/dbname?param=value] Select data source using the url format

atlas schema fmt​

Formats Atlas HCL files

Usage​

atlas schema fmt [path ...]

Details​

'atlas schema fmt' formats all ".hcl" files under the given path using canonical HCL layout style as defined by the github.com/hashicorp/hcl/v2/hclwrite package. Unless stated otherwise, the fmt command will use the current directory.

After running, the command will print the names of the files it has formatted. If all files in the directory are formatted, no input will be printed out.

atlas schema inspect​

Inspect a database's and print its schema in Atlas DDL syntax.

Usage​

atlas schema inspect [flags]

Details​

'atlas schema inspect' connects to the given database and inspects its schema. It then prints to the screen the schema of that database in Atlas DDL syntax. This output can be saved to a file, commonly by redirecting the output to a file named with a ".hcl" suffix:

atlas schema inspect -u "mysql://user:pass@localhost:3306/dbname" > atlas.hcl

This file can then be edited and used with the atlas schema apply command to plan and execute schema migrations against the given database. In cases where users wish to inspect all multiple schemas in a given database (for instance a MySQL server may contain multiple named databases), omit the relevant part from the url, e.g. "mysql://user:pass@localhost:3306/". To select specific schemas from the databases, users may use the "--schema" (or "-s" shorthand) flag.

Example​

  atlas schema inspect -u "mysql://user:pass@localhost:3306/dbname"
atlas schema inspect -u "mariadb://user:pass@localhost:3306/" --schema=schemaA,schemaB -s schemaC
atlas schema inspect --url "postgres://user:pass@host:port/dbname?sslmode=disable"
atlas schema inspect -u "sqlite://file:ex1.db?_fk=1"

Flags​

      --addr string      Used with -w, local address to bind the server to (default ":5800")
-s, --schema strings Set schema name
-u, --url string [driver://username:password@protocol(address)/dbname?param=value] Select data source using the url format
-w, --web Open in a local Atlas UI

atlas version​

Prints this Atlas CLI version information.

Usage​

atlas version

atlas serve​

Run Atlas web UI in a standalone mode

Usage​

atlas serve [flags]

Details​

'atlas serve' runs the Atlas web UI in a standalone mode with optional persistent storage. If you do not specify the storage, it will be stored in-memory. Atlas encrypts sensitive data such as passwords using the generated keyset.json.

Flags​

--addr string       listen address for atlas serve (default ":5800")
--storage string data store url using the dsn format:
[driver://username:password@protocol(address)/dbname?param=value] (default "in-memory")
-h, --help help for serve