CLI Reference

This section provides a comprehensive reference for the FlowerPower Command Line Interface (CLI).

Main Commands

flowerpower init

Initialize a new FlowerPower project.

This command creates a new FlowerPower project with the necessary directory structure and configuration files. If no project name is provided, the current directory name will be used as the project name.

Usage

flowerpower init [options]

Options

Name	Type	Description	Default
--name	str	Name of the FlowerPower project to create. If not provided, current directory name is used.	None
--base-dir	str	Base directory where the project will be created. If not provided, uses current working directory.	None
--storage-options	str	Storage options as JSON or Python dict string; parsed to dict.	None

Examples

$ flowerpower init

# Create a project with a specific name

$ flowerpower init --name my-awesome-project

# Create a project in a specific location

$ flowerpower init --name my-project --base-dir /path/to/projects

---

flowerpower ui

Start the Hamilton UI web application.

This command launches the Hamilton UI, which provides a web interface for visualizing and interacting with your FlowerPower pipelines. The UI allows you to explore pipeline execution graphs and view results.

Usage

flowerpower ui [options]

Options

Name	Type	Description	Default
--port	int	Port to run the UI server on	8241
--base-dir	str	Base directory where the UI will store its data	~/.hamilton/db
--no-migration	bool	Skip running database migrations on startup	False
--no-open	bool	Prevent automatically opening the browser	False
--settings	str	Settings profile to use (mini, dev, prod)	"mini"
--config	str	Optional custom configuration file path	None

Note: Requires sf-hamilton[ui]. If not installed, the command prints guidance to install it.

Examples

$ flowerpower ui

# Run the UI on a specific port

$ flowerpower ui --port 9000

# Use a custom data directory

$ flowerpower ui --base-dir ~/my-project/.hamilton-data

# Start without opening a browser

$ flowerpower ui --no-open

# Use production settings

$ flowerpower ui --settings prod

---