launchflow

LaunchFlow CLI.

Usage:

1
$ launchflow [OPTIONS] COMMAND [ARGS]...
content_copy

Options:

• --install-completion: Install completion for the current shell.
• --show-completion: Show completion for the current shell, to copy it or customize the installation.
• --help: Show this message and exit.

Commands:

• accounts: Commands for managing accounts in LaunchFlow
• clean: Clean up any resources that are not in the...
• config: Commands for interacting with your local...
• connect: Connect your LaunchFlow account to a cloud...
• create: Create any resources that are not already...
• deploy: Deploy a service to a project / environment.
• destroy: Destroy all resources in the project /...
• environments: Interact with your LaunchFlow environments.
• init: Initialize a new launchflow project.
• login: Login to LaunchFlow.
• logout: Logout of LaunchFlow.
• logs: Fetch the logs for a given operation.
• projects: Interact with your LaunchFlow projects.
• resources: Commands for managing resources in LaunchFlow
• run: Run a command against a remote environment...
• secrets: Commands for managing secrets in LaunchFlow
• services: Commands for managing services in LaunchFlow

launchflow accounts

Commands for managing accounts in LaunchFlow

Usage:

1
$ launchflow accounts [OPTIONS] COMMAND [ARGS]...
content_copy

Options:

• --help: Show this message and exit.

Commands:

• get: Get information about a specific account.
• list: List accounts that you have access to.

launchflow accounts get

Get information about a specific account.

Usage:

1
$ launchflow accounts get [OPTIONS] [ACCOUNT_ID]
content_copy

Arguments:

• [ACCOUNT_ID]: [default: The account ID to fetch. Format: account_123]

Options:

• --help: Show this message and exit.

launchflow accounts list

List accounts that you have access to.

Usage:

1
$ launchflow accounts list [OPTIONS]
content_copy

Options:

• --help: Show this message and exit.

launchflow clean

Clean up any resources that are not in the current directory but are part of the project / environment.

Usage:

1
$ launchflow clean [OPTIONS]
content_copy

Options:

• --scan-directory TEXT: Directory to scan for resources. Defaults to the current working directory. [default: .]
• --project TEXT: The project name to use. If not specified, we will check your local config, if not in your config it will be selected interactively.
• --environment TEXT: The environment name to use. If not specified, we will check your local config, if not in your config it will be selected interactively.
• --help: Show this message and exit.

launchflow config

Commands for interacting with your local LaunchFlow configuration.

Usage:

1
$ launchflow config [OPTIONS] COMMAND [ARGS]...
content_copy

Options:

• --help: Show this message and exit.

Commands:

• get: Print out the current LaunchFlow config.
• set-account: Set the default account ID for the...

launchflow config get

Print out the current LaunchFlow config.

Usage:

1
$ launchflow config get [OPTIONS]
content_copy

Options:

• --help: Show this message and exit.

launchflow config set-account

Set the default account ID for the LaunchFlow CLI.

Usage:

1
$ launchflow config set-account [OPTIONS] [ACCOUNT_ID]
content_copy

Arguments:

• [ACCOUNT_ID]: The account ID to set as the default. If not provided, you will be prompted to select one.

Options:

• --help: Show this message and exit.

launchflow connect

Connect your LaunchFlow account to a cloud provider (AWS or GCP) or retrieve connection info with the --status / -s flag.

Usage:

1
$ launchflow connect [OPTIONS] [ACCOUNT_ID]
content_copy

Arguments:

• [ACCOUNT_ID]: The account ID to fetch. Of the format acount_123

Options:

• --provider [gcp|aws|azure]: The cloud provider to setup your account with.
• -s, --status: Only print out connection status instead of instructions for connecting.
• --help: Show this message and exit.

launchflow create

Create any resources that are not already created.

Usage:

1
$ launchflow create [OPTIONS] [RESOURCE]
content_copy

Arguments:

• [RESOURCE]: Resource to create. If none we will scan the directory for resources.

Options:

• --project TEXT: The project name to use. If not specified, we will check your local config, if not in your config it will be selected interactively.
• --environment TEXT: The environment name to use. If not specified, we will check your local config, if not in your config it will be selected interactively.
• --scan-directory TEXT: Directory to scan for resources. Defaults to the current working directory. [default: .]
• -y, --auto-approve: Auto approve resource creation.
• --api-key TEXT: API key to use for this request. If not set will fallback to your user local credentials from launchflow login
• --help: Show this message and exit.

launchflow deploy

Deploy a service to a project / environment.

Usage:

1
$ launchflow deploy [OPTIONS]
content_copy

Options:

• --project TEXT: The project name to use. If not specified, we will check your local config, if not in your config it will be selected interactively.
• --environment TEXT: The environment name to use. If not specified, we will check your local config, if not in your config it will be selected interactively.
• --service TEXT: The service name to use. If not specified, we will check your local config, if not in your config it will be selected interactively.
• -y, --auto-approve: Auto approve the deployment.
• --api-key TEXT: API key to use for this request. If not set will fallback to your user local credentials from launchflow login
• --scan-directory TEXT: Directory to scan for resources. Defaults to the current working directory. [default: .]
• -v, --verbose: Verbose output. Will include all options provided to your service.
• --help: Show this message and exit.

launchflow destroy

Destroy all resources in the project / environment.

Usage:

1
$ launchflow destroy [OPTIONS]
content_copy

Options:

• --project TEXT: The project name to use. If not specified, we will check your local config, if not in your config it will be selected interactively.
• --environment TEXT: The environment name to use. If not specified, we will check your local config, if not in your config it will be selected interactively.
• --help: Show this message and exit.

launchflow environments

Interact with your LaunchFlow environments.

Usage:

1
$ launchflow environments [OPTIONS] COMMAND [ARGS]...
content_copy

Options:

• --help: Show this message and exit.

Commands:

• create: Create a new environment in a LaunchFlow...
• delete: Delete an environment.
• get: Get information about a specific environment.
• list: List all environments in a LaunchFlow...

launchflow environments create

Create a new environment in a LaunchFlow project.

Usage:

1
$ launchflow environments create [OPTIONS] [NAME]
content_copy

Arguments:

• [NAME]: The environment name.

Options:

• --project TEXT: The project to create the environments in.
• --env-type [development|production]: The environment type (development or production).
• --help: Show this message and exit.

launchflow environments delete

Delete an environment.

Usage:

1
$ launchflow environments delete [OPTIONS] NAME
content_copy

Arguments:

• NAME: The environment name. [required]

Options:

• --project TEXT: The project the environment is in.
• --detach / --no-detach: If true we will not clean up any of the cloud resources associated with the environment and will simply delete the record from LaunchFlow. [default: no-detach]
• --help: Show this message and exit.

launchflow environments get

Get information about a specific environment.

Usage:

1
$ launchflow environments get [OPTIONS] NAME
content_copy

Arguments:

• NAME: The environment name. [required]

Options:

• --project TEXT: The project the environment is in.
• --help: Show this message and exit.

launchflow environments list

List all environments in a LaunchFlow project.

Usage:

1
$ launchflow environments list [OPTIONS]
content_copy

Options:

• --project TEXT: The project to list environments for.
• --help: Show this message and exit.

launchflow init

Initialize a new launchflow project.

Usage:

1
$ launchflow init [OPTIONS] [DIRECTORY]
content_copy

Arguments:

• [DIRECTORY]: Directory to initialize launchflow.

Options:

• --account-id TEXT: Account ID to use for this project. Defaults to the account ID set in the config.
• --help: Show this message and exit.

launchflow login

Login to LaunchFlow. If you haven't signup this will create a free account for you.

Usage:

1
$ launchflow login [OPTIONS]
content_copy

Options:

• --help: Show this message and exit.

launchflow logout

Logout of LaunchFlow.

Usage:

1
$ launchflow logout [OPTIONS]
content_copy

Options:

• --help: Show this message and exit.

launchflow logs

Fetch the logs for a given operation.

Usage:

1
$ launchflow logs [OPTIONS] [OPERATION_ID]
content_copy

Arguments:

• [OPERATION_ID]: The operation ID to fetch logs for.

Options:

• --help: Show this message and exit.

launchflow projects

Interact with your LaunchFlow projects.

Usage:

1
$ launchflow projects [OPTIONS] COMMAND [ARGS]...
content_copy

Options:

• --help: Show this message and exit.

Commands:

• create: Create a new project in your account.
• delete: Delete a project.
• get: Get information about a specific project.
• list: Lists all current projects in your account.

launchflow projects create

Create a new project in your account.

Usage:

1
$ launchflow projects create [OPTIONS] [PROJECT_NAME]
content_copy

Arguments:

• [PROJECT_NAME]: The name of the project to create.

Options:

• --account-id TEXT: The account ID to fetch. Of the format acount_123. Defaults to the account in your config file.
• --help: Show this message and exit.

launchflow projects delete

Delete a project.

Usage:

1
$ launchflow projects delete [OPTIONS] NAME
content_copy

Arguments:

• NAME: The project name. [required]

Options:

• --help: Show this message and exit.

launchflow projects get

Get information about a specific project.

Usage:

1
$ launchflow projects get [OPTIONS] PROJECT_NAME
content_copy

Arguments:

• PROJECT_NAME: [required]

Options:

• --help: Show this message and exit.

launchflow projects list

Lists all current projects in your account.

Usage:

1
$ launchflow projects list [OPTIONS]
content_copy

Options:

• --help: Show this message and exit.

launchflow resources

Commands for managing resources in LaunchFlow

Usage:

1
$ launchflow resources [OPTIONS] COMMAND [ARGS]...
content_copy

Options:

• --help: Show this message and exit.

Commands:

• delete: Delete a resource.
• get: Fetch information about a resource.
• list: List all resources in a project/environment.

launchflow resources delete

Delete a resource.

Usage:

1
$ launchflow resources delete [OPTIONS] RESOURCE_NAME
content_copy

Arguments:

• RESOURCE_NAME: Resource to delete. [required]

Options:

• --project TEXT: The project name to use. If not specified, we will check your local config, if not in your config it will be selected interactively.
• --environment TEXT: The environment name to use. If not specified, we will check your local config, if not in your config it will be selected interactively.
• --help: Show this message and exit.

launchflow resources get

Fetch information about a resource.

Usage:

1
$ launchflow resources get [OPTIONS] RESOURCE_NAME
content_copy

Arguments:

• RESOURCE_NAME: Resource to fetch information for. [required]

Options:

• --project TEXT: The project name to use. If not specified, we will check your local config, if not in your config it will be selected interactively.
• --environment TEXT: The environment name to use. If not specified, we will check your local config, if not in your config it will be selected interactively.
• --help: Show this message and exit.

launchflow resources list

List all resources in a project/environment.

Usage:

1
$ launchflow resources list [OPTIONS]
content_copy

Options:

• --project TEXT: The project name to use. If not specified, we will check your local config, if not in your config it will be selected interactively.
• --environment TEXT: The environment name to use. If not specified, we will check your local config, if not in your config it will be selected interactively.
• --help: Show this message and exit.

launchflow run

Run a command against a remote environment OR local-enabled resources.

Sample commands:

launchflow run dev -- ./run.sh - Runs ./run.sh against dev environment resources. launchflow run local -- ./run.sh - Runs ./run.sh with local resources, using the environment from launchflow.yaml as a fallback for resources that aren't local enabled (e.g. anything in launchflow.aws or launchflow.gcp). - The environment MUST be specified in the launchflow.yaml if non-local resources are created in infra.py.

Usage:

1
$ launchflow run [OPTIONS] ENVIRONMENT [ARGS]...
content_copy

Arguments:

• ENVIRONMENT: The environment name to use. If not specified, we will check your local config, if not in your config it will be selected interactively. [required]
• [ARGS]...: Additional command to run

Options:

• --scan-directory TEXT: Directory to scan for resources. Defaults to the current working directory. [default: .]
• --help: Show this message and exit.

launchflow secrets

Commands for managing secrets in LaunchFlow

Usage:

1
$ launchflow secrets [OPTIONS] COMMAND [ARGS]...
content_copy

Options:

• --help: Show this message and exit.

Commands:

• set: Set the value of a secret managed by...

launchflow secrets set

Set the value of a secret managed by LaunchFlow.

Usage:

1
$ launchflow secrets set [OPTIONS] RESOURCE_NAME SECRET_VALUE
content_copy

Arguments:

• RESOURCE_NAME: Resource to fetch information for. [required]
• SECRET_VALUE: The value to set for the secret. [required]

Options:

• --project TEXT: The project name to use. If not specified, we will check your local config, if not in your config it will be selected interactively.
• --environment TEXT: The environment name to use. If not specified, we will check your local config, if not in your config it will be selected interactively.
• --help: Show this message and exit.

launchflow services

Commands for managing services in LaunchFlow

Usage:

1
$ launchflow services [OPTIONS] COMMAND [ARGS]...
content_copy

Options:

• --help: Show this message and exit.

Commands:

• delete: Delete a service.
• get: Fetch information about a service.
• list: List all services in a project/environment.

launchflow services delete

Delete a service.

Usage:

1
$ launchflow services delete [OPTIONS] SERVICE_NAME
content_copy

Arguments:

• SERVICE_NAME: Service to delete. [required]

Options:

• --project TEXT: The project name to use. If not specified, we will check your local config, if not in your config it will be selected interactively.
• --environment TEXT: The environment name to use. If not specified, we will check your local config, if not in your config it will be selected interactively.
• --help: Show this message and exit.

launchflow services get

Fetch information about a service.

Usage:

1
$ launchflow services get [OPTIONS] SERVICE_NAME
content_copy

Arguments:

• SERVICE_NAME: Service to fetch information for. [required]

Options:

• --project TEXT: The project name to use. If not specified, we will check your local config, if not in your config it will be selected interactively.
• --environment TEXT: The environment name to use. If not specified, we will check your local config, if not in your config it will be selected interactively.
• --help: Show this message and exit.

launchflow services list

List all services in a project/environment.

Usage:

1
$ launchflow services list [OPTIONS]
content_copy

Options:

• --project TEXT: The project name to use. If not specified, we will check your local config, if not in your config it will be selected interactively.
• --environment TEXT: The environment name to use. If not specified, we will check your local config, if not in your config it will be selected interactively.
• --help: Show this message and exit.