Skip to main content

Core multi-agent collaboration and audit layer for AI-assisted engineering teams.

Project description

ForkFlux

Core server for ForkFlux, the self-hosted multi-agent collaboration and audit layer for AI-assisted engineering teams.

ForkFlux is the stateful, self-hosted coordination and audit layer behind ForkFlux. It gives engineering teams and their isolated AI agents a shared, machine-readable system for delegating work, retaining handoff context and artifacts, tracking dependencies and lifecycle transitions, and recording the outcome of each job.

Use this package when you need the ForkFlux service itself: a FastAPI application backed by PostgreSQL or SQLite, a bundled dashboard when built assets are present, and a CLI for database initialization, server startup, role and agent management, job inspection, and metrics.

What it provides

  • Shared, auditable job queue for agent-to-agent work delegation.
  • Atomic claims so only one agent can own a published job at a time.
  • Structured handoffs through context payloads, constraints, and artifacts.
  • Lifecycle and dependency tracking for published, pending, in-progress, blocked, completed, failed, and cancelled work.
  • Job revision and retry workflows, including rejection records and focused reopen context.
  • Role-aware routing, agent identity, and API-token management.
  • Dashboard-facing endpoints for jobs, agents, roles, and the active profile.

Package

pip install forkflux

The installed CLI entry point is:

forkflux --help

Common commands:

forkflux init                 # apply database migrations
forkflux serve                # run the API on 0.0.0.0:8000
forkflux stats                # show recent queue and handoff metrics
forkflux agents-role list     # list configured target roles
forkflux agent list           # list registered agents and roles
forkflux job list             # inspect jobs from the CLI

forkflux quickstart is the automated local demo command. It creates example roles and agents, installs workflow helpers, and registers MCP servers with two detected supported assistant CLIs. Use the main repository documentation for the complete quickstart and manual setup paths.

Configuration and API

Set DATABASE_URL to use a specific database. The API accepts sqlite+aiosqlite and PostgreSQL URLs. Without it, the CLI uses SQLite and resolves the database from the current project (.forkflux/forkflux.db) or the platform's application-data directory.

The FastAPI application is exposed as forkflux_api.main:app. Its default base URL is http://127.0.0.1:8000; API routes are under /api/v1, with separate /mcp and /ui route groups. The health endpoint is GET /api/v1/health and returns HTTP 204.

For endpoint schemas and authenticated MCP workflows, see the API reference and MCP integration guide.

Development

From this directory:

uv sync
uv run pytest tests/test_health.py -v

The test suite separates service unit tests from repository and endpoint integration tests. PostgreSQL-backed integration tests use the repository's test fixtures and testcontainers configuration.

Runtime requirements

  • Python 3.14+

See the main ForkFlux repository for local Docker setup, MCP integration, and end-to-end handoff examples.

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

forkflux-1.1.2.tar.gz (186.8 kB view details)

Uploaded Source

Built Distribution

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

forkflux-1.1.2-py3-none-any.whl (212.5 kB view details)

Uploaded Python 3

File details

Details for the file forkflux-1.1.2.tar.gz.

File metadata

  • Download URL: forkflux-1.1.2.tar.gz
  • Upload date:
  • Size: 186.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.0 {"installer":{"name":"uv","version":"0.12.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for forkflux-1.1.2.tar.gz
Algorithm Hash digest
SHA256 81ace8117f042543772041a7264290580fe4fc356d460e0f77a59756fb9bdd7e
MD5 c455532681937f992f2bbf4ebc95e05e
BLAKE2b-256 31da44b9338e0cf01bcde27b47bd5bc0e587d3c9491fdb39e27181da71434e7b

See more details on using hashes here.

File details

Details for the file forkflux-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: forkflux-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 212.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.0 {"installer":{"name":"uv","version":"0.12.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for forkflux-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4b1d7e5c23c449c12bb1cb284cc03767823c1e4cfca76327eb22a5a882fe966b
MD5 8b32e40fb635f7fcd45856e14be74c5c
BLAKE2b-256 a6314c5e64dad8626ef298b435d1e6564d94d227e7335c84eec2b8d230dc210e

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