launchflow

LaunchFlow CLI.

Usage:

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

Options:

  • --disable-usage-statistics / --no-disable-usage-statistics: If true no usage statistics will be collected. [default: no-disable-usage-statistics]
  • --log-level TEXT
  • --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
  • cloud: Commands for interacting with LaunchFlow Cloud.
  • connect: Connect your LaunchFlow account to a cloud provider (AWS or GCP) or retrieve connection info with the --status / -s flag.
  • create: Create any resources that are not already created.
  • deploy: Deploy a service to a project / environment.
  • destroy: Destroy all resources in the project / environment.
  • environments: Interact with your LaunchFlow environments.
  • import
  • init: Initialize a new launchflow project.
  • login: Login to LaunchFlow. If you haven't signup this will create a free account for you.
  • logout: Logout of LaunchFlow.
  • logs: Fetch the logs for a given operation.
  • projects: Interact with your LaunchFlow projects.
  • promote: Promote a service. This will take the image that is running in from_environment and promote it to a service in to_environment.
  • resources: Commands for viewing resources managed by LaunchFlow
  • run: Run a command against an environment.

Sample commands:

lf run dev -- ./run.sh - Runs ./run.sh against dev environment resources.

  • secrets: Commands for managing secrets in LaunchFlow
  • services: Commands for viewing services managed by LaunchFlow
  • version: Print the version of launchflow.

launchflow accounts

Commands for managing accounts in LaunchFlow

Usage:

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

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]

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]

Options:

  • --help: Show this message and exit.

launchflow cloud

Commands for interacting with LaunchFlow Cloud.

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

  • connect: Connect an environment to LaunchFlow.

For GCP this will create a service account that will be able to deploy your services, and allow LaunchFlow Cloud to use the service account to trigger deployments.

launchflow cloud connect

Connect an environment to LaunchFlow.

For GCP this will create a service account that will be able to deploy your services, and allow LaunchFlow Cloud to use the service account to trigger deployments.

Usage:

1
$ launchflow cloud connect [OPTIONS] [ENVIRONMENT]

Arguments:

  • [ENVIRONMENT]: The environment to connect.

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]

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] [ENVIRONMENT]

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.

Options:

  • --resource TEXT: Resource name to create. If none we will scan the directory for available resources. This can be specified multiple times to create multiple resources. [default: <class 'list'>]
  • --service TEXT: Service name to create. If none we will scan the directory for available services. This can be specified multiple times to create multiple services. [default: <class 'list'>]
  • --scan-directory TEXT: Directory to scan for resources. Defaults to the current working directory. [default: .]
  • -y, --auto-approve: Auto approve resource creation.
  • --local: Create only local resources.
  • --launchflow-api-key TEXT: API key to use for this request. If not set will fallback to your user local credentials from lf login
  • -v, --verbose: If set all logs will be written to stdout.
  • --help: Show this message and exit.

launchflow deploy

Deploy a service to a project / environment.

Usage:

1
$ launchflow deploy [OPTIONS] [ENVIRONMENT]

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.

Options:

  • --service TEXT: A list of service names to deploy. This can be specified multiple times to deploy multiple services. If not provided all services will be deployed. [default: <class 'list'>]
  • -y, --auto-approve: Auto approve the deployment.
  • --launchflow-api-key TEXT: API key to use for this request. If not set will fallback to your user local credentials from lf 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.
  • --build-local: Build the Docker image locally.
  • --skip-create: Skip the Resource creation step.
  • --help: Show this message and exit.

launchflow destroy

Destroy all resources in the project / environment.

Usage:

1
$ launchflow destroy [OPTIONS] [ENVIRONMENT]

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.

Options:

  • --resource TEXT: Resource name to destroy. If none we will scan the directory for available resources. This can be specified multiple times to destroy multiple resources. [default: <class 'list'>]
  • --service TEXT: Service name to destroy. If none we will scan the directory for available services. This can be specified multiple times to destroy multiple services. [default: <class 'list'>]
  • --local: Only destroy local resources.
  • -y, --auto-approve: Auto approve resource destruction.
  • -v, --verbose: If set all logs will be written to stdout.
  • --launchflow-api-key TEXT: API key to use for this request. If not set will fallback to your user local credentials from lf login
  • --help: Show this message and exit.

launchflow environments

Interact with your LaunchFlow environments.

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

  • create: Create a new environment in the current project.
  • delete: Delete an environment.
  • get: Get information about a specific environment.
  • list: List all environments in the current directory's project.
  • unlock: Force unlock an environment.

launchflow environments create

Create a new environment in the current project.

Usage:

1
$ launchflow environments create [OPTIONS] [NAME]

Arguments:

  • [NAME]: The environment name.

Options:

  • --env-type [development|production]: The environment type (development or production).
  • --cloud-provider [gcp|aws]: The cloud provider.
  • --gcp-project-id TEXT: The GCP project ID to import.
  • --gcp-organization-name TEXT: The GCP organization name (organization/XXXXXX) to place newly create GCP projects in. If not provided you will be prompted to select an organization.
  • --gcp-service-account-email TEXT: The GCP service account email to import for the environment.
  • -y, --auto-approve: Auto approve environment creation.
  • --help: Show this message and exit.

launchflow environments delete

Delete an environment.

Usage:

1
$ launchflow environments delete [OPTIONS] [NAME]

Arguments:

  • [NAME]: The environment name.

Options:

  • --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]
  • -y, --auto-approve: Auto approve environment deletion.
  • --help: Show this message and exit.

launchflow environments get

Get information about a specific environment.

Usage:

1
$ launchflow environments get [OPTIONS] [NAME]

Arguments:

  • [NAME]: The environment name.

Options:

  • -f, --format [default|yaml]: Output format [default: default]
  • -e, --expand: List resources and services in the environment
  • --help: Show this message and exit.

launchflow environments list

List all environments in the current directory's project.

Usage:

1
$ launchflow environments list [OPTIONS]

Options:

  • -f, --format [default|yaml]: Output format [default: default]
  • -e, --expand: List resources and services in the environments
  • --help: Show this message and exit.

launchflow environments unlock

Force unlock an environment.

Usage:

1
$ launchflow environments unlock [OPTIONS] NAME

Arguments:

  • NAME: The environment to unlock. [required]

Options:

  • -y, --auto-approve: Auto approve environment force unlock.
  • --help: Show this message and exit.

launchflow import

Usage:

1
$ launchflow import [OPTIONS] [ENVIRONMENT]

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.

Options:

  • --resource TEXT: Resource name to import. If none we will scan the directory for available resources.
  • --scan-directory TEXT: Directory to scan for resources. Defaults to the current working directory. [default: .]
  • --help: Show this message and exit.

launchflow init

Initialize a new launchflow project.

Usage:

1
$ launchflow init [OPTIONS]

Options:

  • -b, --backend [local|gcs|lf]: The backend to use for the project.
  • --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]

Options:

  • --help: Show this message and exit.

launchflow logout

Logout of LaunchFlow.

Usage:

1
$ launchflow logout [OPTIONS]

Options:

  • --help: Show this message and exit.

launchflow logs

Fetch the logs for a given operation.

Usage:

1
$ launchflow logs [OPTIONS] [OPERATION_ID]

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]...

Options:

  • --help: Show this message and exit.

Commands:

  • create: Create a new project in your account.
  • delete: Delete a 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]

Arguments:

  • [PROJECT]: The project name.

Options:

  • -y, --auto-approve: Auto approve project creation.
  • --help: Show this message and exit.

launchflow projects delete

Delete a project.

Usage:

1
$ launchflow projects delete [OPTIONS] NAME

Arguments:

  • NAME: The project name. [required]

Options:

  • -y, --auto-approve: Auto approve project deletion.
  • --help: Show this message and exit.

launchflow projects list

Lists all current projects in your account.

Usage:

1
$ launchflow projects list [OPTIONS]

Options:

  • --help: Show this message and exit.

launchflow promote

Promote a service. This will take the image that is running in from_environment and promote it to a service in to_environment.

Usage:

1
$ launchflow promote [OPTIONS] FROM_ENVIRONMENT TO_ENVIRONMENT

Arguments:

  • FROM_ENVIRONMENT: The environment to promote from. [required]
  • TO_ENVIRONMENT: The environment to promote to [required]

Options:

  • --service TEXT: A list of service names to promote. This can be specified multiple times to promote multiple services. If not provided all services will be promoted. [default: <class 'list'>]
  • -y, --auto-approve: Auto approve the deployment.
  • --launchflow-api-key TEXT: API key to use for this request. If not set will fallback to your user local credentials from lf login
  • --promote-local / --no-promote-local: Promote the service locally. If true this will move the docker image to the new environment locally instead of on Cloud Build or Code Build. [default: no-promote-local]
  • --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 resources

Commands for viewing resources managed by LaunchFlow

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

  • list: List all resources in a project/environment.
  • unlock: Force unlock a resource.

launchflow resources list

List all resources in a project/environment.

Usage:

1
$ launchflow resources list [OPTIONS] [ENVIRONMENT]

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.

Options:

  • -f, --format [default|yaml]: Output format [default: default]
  • --help: Show this message and exit.

launchflow resources unlock

Force unlock a resource.

Usage:

1
$ launchflow resources unlock [OPTIONS] ENVIRONMENT RESOURCE

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]
  • RESOURCE: The resource to unlock. [required]

Options:

  • -y, --auto-approve: Auto approve environment force unlock.
  • --help: Show this message and exit.

launchflow run

Run a command against an environment.

Sample commands:

lf run dev -- ./run.sh - Runs ./run.sh against dev environment resources.

Usage:

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

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: .]
  • --disable-run-cache: Disable the run cache, Resource outputs will always be fetched.
  • --launchflow-api-key TEXT: API key to use for this request. If not set will fallback to your user local credentials from lf login
  • --help: Show this message and exit.

launchflow secrets

Commands for managing secrets in LaunchFlow

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

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

launchflow secrets set

Set the value of a secret managed by LaunchFlow.

Usage:

1
$ launchflow secrets set [OPTIONS] RESOURCE_NAME SECRET_VALUE

Arguments:

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

Options:

  • --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. [required]
  • --help: Show this message and exit.

launchflow services

Commands for viewing services managed by LaunchFlow

Usage:

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

Options:

  • --help: Show this message and exit.

Commands:

  • list: List all services in a project/environment.
  • unlock: Force unlock a service.

launchflow services list

List all services in a project/environment.

Usage:

1
$ launchflow services list [OPTIONS] [ENVIRONMENT]

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.

Options:

  • -f, --format [default|yaml]: Output format [default: default]
  • --help: Show this message and exit.

launchflow services unlock

Force unlock a service.

Usage:

1
$ launchflow services unlock [OPTIONS] ENVIRONMENT SERVICE

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]
  • SERVICE: The service to unlock. [required]

Options:

  • -y, --auto-approve: Auto approve environment force unlock.
  • --help: Show this message and exit.

launchflow version

Print the version of launchflow.

Usage:

1
$ launchflow version [OPTIONS]

Options:

  • --help: Show this message and exit.