​
Install the CLI

The CLI can be installed via pip:

pip install launchflow

If you ever need help with any command you can add --help to print out the documentation for that command.

Some examples:

launch --help
launch auth --help
launch auth login --help

​
Login with the CLI

To login to LaunchFlow cloud using the CLI run the following command:

launch auth login

This will prompt you to login in using either GitHub or Google.

If you don’t have an account this will create one for you.

​
Signup For a Standard Subscription

To launch your first deployment you’ll need to signup for a standard subscription.

By signing up you will get a free 50 dollar credit.

You can do this by running:

launch accounts upgrade

This will generate a URL for you to upgrade your account.

​
Launch your First Deployment

To launch your first deployment simply create a new BuildFlow project using the BuildFlow CLI in a directory of your choosing:

buildflow init

This will create a simple HTTP serve that displays a “Hello World” message.

To launch the deployment run the following command in the same directory that you ran buildflow init in:

launch deployments submit

This will deploy your project to LaunchFlow cloud, and spit out a deployment ID and other useful commands to track the progress of the deployment. For instance, you can track the progress using the launch deployments ping command:

launch deployments ping $DEPLOYMENT_ID

Once the deployment is running you should be able to find the URL of the HTTP server using the launch deployments ping command and visiting the URL in your browser:

Deployments
-----------
-   id: deployment_37019776288
    ...
    url: https://<PROJECT-NAME>-<DEPLOYMENT_ID_NUMBER>.dev.launchflow.app
    ...

When you’re done you can drain or stop you deployment using the launch deployments drain or launch deployments stop commands respectively. Drain will ensure all active requests complete before stopping the deployment, while stop will immediately stop the deployment.

launch deployments drain

launch deployment stop

​
What’s Next?

Now that you’ve launched your first deployment, you can follow the BuildFlow docs to add even more functionality to your project, and update your existing deployment using the launch deployments update command.

Getting StartedAccounts