CLI¶
orbiter¶
Orbiter is a CLI that converts other workflows to Airflow Projects.
Usage:
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
Provide a specific ruleset with the --ruleset flag.
Run orbiter list-rulesets to see available rulesets.
INPUT_DIR defaults to $CWD/workflow.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-r, --ruleset |
text | Qualified name of a TranslationRuleset | _required |
--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 |
install¶
Install a new Translation Ruleset from a repository
Usage:
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
Usage:
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.
Provide a specific ruleset with the --ruleset flag.
Run orbiter list-rulesets to see available rulesets.
INPUT_DIR defaults to $CWD/workflow.
OUTPUT_DIR defaults to $CWD/output
Formats output with Ruff (https://astral.sh/ruff), by default.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-r, --ruleset |
text | Qualified name of a TranslationRuleset | _required |
--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.