Metadata-Version: 2.5
Name: flowfield-core
Version: 0.1.0
Summary: Shared task feeds and parallel workers for agent software development
Project-URL: Repository, https://github.com/flowfield-sh/flowfield-core
Project-URL: Issues, https://github.com/flowfield-sh/flowfield-core/issues
License-Expression: Apache-2.0
License-File: LICENSE
Requires-Python: >=3.12
Requires-Dist: anyio<5,>=4.5
Requires-Dist: fastapi<1,>=0.115
Requires-Dist: httpx<1,>=0.28
Requires-Dist: mcp<2,>=1.28
Requires-Dist: packaging<27,>=24
Requires-Dist: pydantic<3,>=2.10
Requires-Dist: rich<15,>=13.9
Requires-Dist: sse-starlette<4,>=3.4
Requires-Dist: typer<1,>=0.15
Requires-Dist: uvicorn<1,>=0.34
Description-Content-Type: text/markdown

<h1 align="center">Flowfield</h1>

<p align="center"><strong>Plan with your coding agent. Follow every task in one shared feed.</strong></p>

<p align="center">
  <a href="https://pypi.org/project/flowfield-core/"><img src="https://img.shields.io/pypi/v/flowfield-core?logo=pypi&amp;logoColor=white&amp;color=2563eb" alt="PyPI version"></a>
  <a href="https://github.com/flowfield-sh/flowfield-core/actions/workflows/tests.yml"><img src="https://img.shields.io/github/actions/workflow/status/flowfield-sh/flowfield-core/tests.yml?branch=main&amp;label=tests" alt="Tests"></a>
  <a href="https://github.com/flowfield-sh/flowfield-core/blob/main/docs/getting-started.mdx"><img src="https://img.shields.io/badge/docs-getting%20started-2563eb" alt="Documentation"></a>
</p>

![Flowfield board with priorities, questions and results ready for review](https://raw.githubusercontent.com/flowfield-sh/flowfield-core/main/docs/images/board-overview.png)

Flowfield runs agreed work in parallel and brings progress, questions, answers and results
together for your review. Keep talking to your coordinator while workers implement tasks;
use the board to see what matters and what needs you.

- **Shared task feeds.** Intent, worker activity, questions, testing and results stay together.
- **Parallel work.** Independent tasks run in separate checkouts; dependencies hold work until it's ready.
- **Explicit review.** Inspect or try an exact result, request changes, then approve its delivery to your project.

## Install

```sh
uv tool install --python 3.12 flowfield-core
flowfield serve
```

Open [localhost:8765](http://127.0.0.1:8765). The browser UI is included.
See [Installation](https://github.com/flowfield-sh/flowfield-core/blob/main/docs/installation.mdx) for the pip alternative.

From an existing project directory:

```sh
flowfield project init
flowfield project guidance preview
flowfield project guidance install
flowfield integration connect codex
```

Start a fresh coding conversation and ask it to read your Flowfield board.
Managed work uses your installed, signed-in Codex CLI and an explicitly selected worker
model. Codex is the first supported harness; further integrations are planned.

## Documentation

[Getting Started](https://github.com/flowfield-sh/flowfield-core/blob/main/docs/getting-started.mdx) · [Concepts](https://github.com/flowfield-sh/flowfield-core/blob/main/docs/concepts.mdx) ·
[CLI](https://github.com/flowfield-sh/flowfield-core/blob/main/docs/cli.mdx) · [Agent integrations](https://github.com/flowfield-sh/flowfield-core/blob/main/docs/integrations/overview.mdx)

## Build from source

Requires Python 3.12+, uv, Node 24+ and pnpm 11.19.0.

```sh
make setup
pnpm --dir web build
uv run flowfield serve
```

See [CONTRIBUTING.md](https://github.com/flowfield-sh/flowfield-core/blob/main/CONTRIBUTING.md) for checks and issue reporting.
Report vulnerabilities through [private security reporting](https://github.com/flowfield-sh/flowfield-core/security/advisories/new).

## License

[Apache License 2.0](https://github.com/flowfield-sh/flowfield-core/blob/main/LICENSE).
