Skip to main content

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

Prerequisites (Windows)

This repo uses git symlinks. On Windows, enable symlink support so they are checked out correctly:

# Enable symlinks globally (requires Developer Mode or elevated shell)
git config --global core.symlinks true

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:

  1. Increment the patch version in _version.py
  2. Run tests (unless --skip-tests)
  3. Commit and tag the release
  4. Push to GitHub
  5. Install from GitHub and validate the version

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flowpad-0.1.12.tar.gz (15.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flowpad-0.1.12-py3-none-any.whl (16.0 MB view details)

Uploaded Python 3

File details

Details for the file flowpad-0.1.12.tar.gz.

File metadata

  • Download URL: flowpad-0.1.12.tar.gz
  • Upload date:
  • Size: 15.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for flowpad-0.1.12.tar.gz
Algorithm Hash digest
SHA256 d42728c18850d335c88eb1f4471a5da0689333511412a864cc55bee392d52931
MD5 9cffe8ef6ae7046b4b38e7911c053fbf
BLAKE2b-256 d7001da9550fe0fc0a4266fd3e24d043a94145dffd95f370703bfa3fdd273c20

See more details on using hashes here.

File details

Details for the file flowpad-0.1.12-py3-none-any.whl.

File metadata

  • Download URL: flowpad-0.1.12-py3-none-any.whl
  • Upload date:
  • Size: 16.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for flowpad-0.1.12-py3-none-any.whl
Algorithm Hash digest
SHA256 cb542deaa16c915c14713e398f42fe1f72c88269cd47d9a65dafee9de5058a3a
MD5 00d3a6dd9d36d7ec491504bb9da36682
BLAKE2b-256 a7f54ba18a5df6658a0284083e4d52150bfb367fbec3fdb8d21a6c7453683c1d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page