Flow CLI $ SDK for flowpad
Project description
Flow CLI
A local desktop CLI and UI for FlowPad — manage hooks, traces, and agentic workflows from your terminal.
Quick Start
pip install flowpad
flow # prints version
flow start # launches the UI server and opens browser
Requirements
- Python >= 3.10
- Node.js (for frontend development)
- uv (for backend dependency management)
Installation
Install from PyPI:
pip install flowpad
Install a specific version:
pip install flowpad==0.1.5
Install from GitHub (latest):
pip install git+https://github.com/langware-labs/flow-cli.git
Verify the installation:
flow
# => flow 0.1.5
Uninstallation
pip uninstall flowpad
CLI Commands
| Command | Description |
|---|---|
flow |
Print version |
flow start |
Start the UI server and open browser |
flow trace |
Start server and trace hook events in real-time |
flow setup <agent> |
Setup FlowPad for a coding agent (e.g. claude-code) |
flow hooks set |
Install Flow hooks into Claude Code settings |
flow hooks list |
List configured hooks |
flow hooks clear |
Remove Flow hooks from Claude Code settings |
flow config list |
List configuration values |
flow config set key=value |
Set a configuration value |
flow auth login |
Login to FlowPad (opens browser or accepts API key) |
flow auth logout |
Logout and remove stored credentials |
flow ping <string> |
Send a test ping to the local server |
Development
Backend
uv sync # install Python dependencies
python minihub/run.py # start backend server on port 9007
The backend serves the API at http://localhost:9007. Bootstrap endpoint: http://localhost:9007/api/v1/graph/bootstrap
Frontend
cd minihub/ui
npm install # install Node dependencies
npm run dev # start Vite dev server on port 4097
The frontend runs at http://localhost:4097 and proxies API calls to the backend.
Running Tests
# Backend API tests
python -m pytest tests/api/ -v
# Backend SDK unit tests
cd flow-sdk/python && python -m pytest tests/ -v
# Frontend build + lint
cd minihub/ui && npm run build && npm run lint
Deployment
Use the deploy script to bump version, tag, push, and validate:
./scripts/deploy_to_github.sh # runs tests first
./scripts/deploy_to_github.sh --skip-tests # skip tests
This will:
- Increment the patch version in
_version.py - Run tests (unless
--skip-tests) - Commit and tag the release
- Push to GitHub
- Install from GitHub and validate the version
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file flowpad-0.1.5.tar.gz.
File metadata
- Download URL: flowpad-0.1.5.tar.gz
- Upload date:
- Size: 13.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ec91295ea6aff48fd7036a9c69747e7180792dfc8021cf60a7ea66c51263774f
|
|
| MD5 |
56a6b0210fedb663cab706a9199baea9
|
|
| BLAKE2b-256 |
7865b1a07ebdb9234721b4232848e51f33f371a496d50d3512781aa21844f9bd
|
File details
Details for the file flowpad-0.1.5-py3-none-any.whl.
File metadata
- Download URL: flowpad-0.1.5-py3-none-any.whl
- Upload date:
- Size: 14.9 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2a98efb7e8678a395abe8fbc66763ac57bb4d97f22f9d549ef17cd6498e2afed
|
|
| MD5 |
48931bd63c708c258baab75f4eae1a14
|
|
| BLAKE2b-256 |
d09e56b23802c98c49b37943689069aa0885575a49d960b1a7211eba35794baa
|