| commit | aae8a3820daabeb55726de998bce5328fbe22419 | [log] [tgz] |
|---|---|---|
| author | Xuannan <suxuannan95@gmail.com> | Sat Oct 04 20:04:36 2025 +0800 |
| committer | GitHub <noreply@github.com> | Sat Oct 04 20:04:36 2025 +0800 |
| tree | b7b181d4a557527df0647916528ac71d1df60e22 | |
| parent | 69e8c965e182dd1b7cd91bcf8e2bdf02a75abc64 [diff] |
[docs] Update workflow agent quickstart with overview and code walkthrough (#244)
Apache Flink Agents is an Agentic AI framework based on Apache Flink.
Prerequisites for building Flink Agents:
To clone from git, enter:
git clone https://github.com/apache/flink-agents.git
To build Flink Agents Java part, run:
cd flink-agents mvn clean install -DskipTests
cd python # Install uv (fast Python package manager) pip install uv # Create env and install build dependencies uv sync --extra build # Build sdist and wheel into python/dist/ uv run python -m build # Install the built wheel into the environment uv pip install dist/*.whl
cd python # Install project (editable) with 'build' extra/tools pip install -e .[build] # Build sdist and wheel into python/dist/ python -m build # Install the built wheel into the environment python -m pip install dist/*.whl
This will also package flink-agents jars in wheel, which is necessary when run agent as pyflink job.
# Build java and python bash -x tools/build.sh # Skip building java (must be built already) bash -x tools/build.sh -p
See the Apache Flink website for how to join the slack workspace. We use #flink-agents-dev for developement related discussions.
There is a weekly online sync. Everyone is welcome to join. Please find the schedule, agenda for the next sync, and records of previous syncs in this github discussion page.