CLI
TachyonCMS ships as one binary, tachyon. It serves the API, runs migrations and moves collection schemas in and out of JSON files.
Commands
Section titled “Commands”| Command | What it does |
|---|---|
tachyon serve |
Runs pending migrations, then serves the API. The Docker image runs this by default. |
tachyon migrate |
Runs pending migrations and exits. |
tachyon schema export |
Writes every collection’s schema as JSON. |
tachyon schema diff |
Shows what applying a schema file would change, without changing anything. |
tachyon schema apply |
Applies a schema file. Changes that delete or retype data need --yes. |
Schema files walks through export, diff and apply with examples.
Global options
Section titled “Global options”--config <CONFIG> names the config file, tachyon.toml by default. It works on every command, before or after the subcommand. Every setting can also come from a TACHYON_* environment variable; the configuration reference lists them.
tachyon --version prints the version, and --help on any command prints the text shown on its page.
About these pages
Section titled “About these pages”Each command page holds the exact --help output of the release binary these docs cover. CI regenerates them from that binary and fails if they differ. The tachyon page has the top-level help.