CLI Reference¶
flowdapt¶
Usage:
flowdapt [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--version, -v |
boolean | Show the flowdapt version and exit. | None |
--app-dir, -d |
path | The application directory path. | None |
--config, -c |
text | The configuration file path relative to the config directory. | flowdapt.yaml |
--env |
text | Load a .env file in the configuration. | [] |
--dev |
boolean | Use flowdapt in development mode. | False |
-o, --override |
text | Configuration overrides. | [] |
--install-completion |
choice (bash | zsh | fish | powershell | pwsh) |
Install completion for the specified shell. | None |
--show-completion |
choice (bash | zsh | fish | powershell | pwsh) |
Show completion for the specified shell, to copy it or customize the installation. | None |
--help |
boolean | Show this message and exit. | False |
config¶
Commands to manage the Configuration
Usage:
flowdapt config [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
get¶
Get the specified key from the configuration file.
Usage:
flowdapt config get [OPTIONS] KEY
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
set¶
Set the specified key to the specified value in the configuration file.
Usage:
flowdapt config set [OPTIONS] KEY VALUE
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
show¶
Show the resolved Configuration
Use --json to render the configuration as JSON. Defaults to --yaml.
Usage:
flowdapt config show [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--json / --yaml |
boolean | N/A | False |
--raw |
boolean | N/A | False |
--help |
boolean | Show this message and exit. | False |
unset¶
Unset the specified key from the configuration file.
Usage:
flowdapt config unset [OPTIONS] KEY
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
db¶
Utility commands for the database
Usage:
flowdapt db [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
current¶
Get the current database revision ID
Usage:
flowdapt db current [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
downgrade¶
Downgrade the database to the specified revision.
Usage:
flowdapt db downgrade [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--rev, -r |
text | The revision ID to downgrade to. | _required |
--help |
boolean | Show this message and exit. | False |
generate¶
Generate a database revision
Usage:
flowdapt db generate [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--title, -t |
text | The revision title. | _required |
--help |
boolean | Show this message and exit. | False |
upgrade¶
Upgrade the database to the specified revision.
Usage:
flowdapt db upgrade [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--rev, -r |
text | The revision ID to upgrade to. | head |
--help |
boolean | Show this message and exit. | False |
run¶
Run the flowdapt server
Usage:
flowdapt run [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--run-migrations / --no-migrations |
boolean | Run database migrations when starting the server. | True |
--help |
boolean | Show this message and exit. | False |