Skip to content

CLI

orbiter

Orbiter is a CLI that converts other workflows to Airflow Projects.

Usage:

orbiter [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--version boolean Show the version and exit. False
--help boolean Show this message and exit. False

analyze

Analyze workflows in an --input-dir against a --ruleset and write analysis to an --output-file.

Provide a specific ruleset with the --ruleset flag, or follow the prompt when given.

Translations must already be installed with orbiter install.

Run orbiter list-rulesets to see available rulesets.

Usage:

orbiter analyze [OPTIONS]

Options:

Name Type Description Default
--input-dir directory Directory containing workflows to translate. Will prompt, if not given. None
-r, --ruleset text Qualified name of a TranslationRuleset. Will prompt, if not given. None
--format choice (json | csv | md) [optional] format for analysis output md
-o, --output-file filename File to write to, defaults to stdout -
--help boolean Show this message and exit. False

document

Write Translation documentation as HTML.

Translations must already be installed with orbiter install.

Run orbiter list-rulesets to see available rulesets.

Usage:

orbiter document [OPTIONS]

Options:

Name Type Description Default
-r, --ruleset text Translation module to document (e.g orbiter_translation.oozie.xml_demo), can be supplied multiple times. Note: do not include .translation_ruleset at the end, to document the full module. Will prompt, if not given. None
--output-file, -o filename HTML file to write to. Defaults to translation_ruleset.html. Use - to write to stdout translation_ruleset.html
--help boolean Show this message and exit. False

install

Install a new Translation Ruleset from a repository.

Run orbiter list-rulesets to see available rulesets.

Usage:

orbiter install [OPTIONS]

Options:

Name Type Description Default
-r, --repo choice (astronomer-orbiter-translations | orbiter-community-translations) Choose a repository to install. Will prompt, if not given. None
-k, --key text [Optional] License Key to use for the translation ruleset. Should look like AAAA-BBBB-1111-2222-3333-XXXX-YYYY-ZZZZ None
--help boolean Show this message and exit. False

list-rulesets

List available Translation Rulesets.

More info available in our docs: https://astronomer.github.io/orbiter/origins/#supported-origins.

Usage:

orbiter list-rulesets [OPTIONS]

Options:

Name Type Description Default
--help boolean Show this message and exit. False

translate

Translate workflows in an --input-dir to an --output-dir Airflow Project.

Translations must already be installed with orbiter install

Provide a specific ruleset with the --ruleset flag, or follow the prompt when given.

Run orbiter list-rulesets to see available rulesets.

Formats output with Ruff (https://astral.sh/ruff), by default.

Usage:

orbiter translate [OPTIONS]

Options:

Name Type Description Default
--input-dir directory Directory containing workflows to translate. Will prompt, if not given. None
--output-dir directory Directory to write translated workflows to /home/runner/work/orbiter/orbiter/output
-r, --ruleset text Qualified name of a TranslationRuleset. Will prompt, if not given. None
--format / --no-format boolean [optional] format the output with Ruff True
--help boolean Show this message and exit. False

Logging

You can alter the verbosity of the CLI by setting the LOG_LEVEL environment variable. The default is INFO.

export LOG_LEVEL=DEBUG

Autocomplete

Auto-completion is available for the CLI. To enable it, run the following command or place it in .bashrc or .zshrc:

Bash

eval "$(_ORBITER_COMPLETE=bash_source orbiter)"

ZSH

eval "$(_ORBITER_COMPLETE=zsh_source orbiter)"