Install buildflow

pip install buildflow

LaunchFlow offers a free VSCode extension that can help you get started even quicker!

Create a new project

Once installed you will now have access to the buildflow CLI tool. First create a directory for your project and then run the init command which will prompt you to enter a project name.

mkdir my-project-dir
cd my-project-dir
buildflow init

The init command creates a basic structure for your project. You are of course free to change this in any way you like.

If you want to just get started quickly you can run start your project with:

buildflow run

Then you can visit http://localhost:8000 to see your project running.

Directory Structure

At the root level there are three important files:

  • buildflow.yml - This is the main configuration file for your project. It contains all the information about your project and how it should be built.
  • - This is the entry point to your project and where your Flow is initialized.
  • requirements.txt - This is where you can specify any Python dependencies your project has.

Below the root level we have:

Project Code Directory

This is the directory where your project code lives. It will match the name of your project. You can put any files you want in here and they will be available to your project. We create a couple directories for you:

  • processors: This is where you can put any custom processors you want to use in your project. In here you will see we have defined a for a service in your project and a file for a custom endpoint processor.
  • resources: This is where you can define any custom primitive resources that your project will need. Note it is empty right now since your initial project is so simple.


This is a hidden directory that contains all the build artifacts for your project. You can general ignore this directory and it will be automatically generated for you. If you are using github you probably want to put this in your .gitignore file.

Running your project

Simply run:

buildflow run

Then you can visit http://localhost:8000 to see your project running.