Quick start¶
This walkthrough verifies the CLI, workflow discovery, input validation, dependency ordering, and result serialization. It does not need a provider credential.
1. Install¶
Requirements: Python 3.11+, Node.js 22.22.2+, and npm. CI uses Node 22. Node
20.19+ or 22.12+ is enough for npm run dev and npm run build, but the UI
test dependencies (Vitest 5, jsdom 30) need Node 22.22.2+, 24.15+, or 26+.
Windows (PowerShell with just):
git clone https://github.com/tafreeman/agentic-runtime-platform.git
cd agentic-runtime-platform
just setup
.\.venv\Scripts\Activate.ps1
just setup creates .venv and installs into it, but it does not activate the
environment in your shell. Activate it as above, or call
.\.venv\Scripts\agentic.exe explicitly.
Linux or macOS (the justfile uses PowerShell, so use the manual path):
git clone https://github.com/tafreeman/agentic-runtime-platform.git
cd agentic-runtime-platform
python -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install -e . -c ci-constraints.txt
python -m pip install \
-e "./agentic-workflows-v2[dev,server,langchain,tracing]" \
-c ci-constraints.txt
python -m pip install -e "./agentic-v2-eval[dev]" -c ci-constraints.txt
npm --prefix agentic-workflows-v2/ui install
The root tools package is installed first, and the langchain extra provides
the default named-workflow adapter. The same steps, with a PowerShell variant,
are in Installation.
Verify the CLI:
2. Create the input file¶
agentic run --input accepts a JSON file path, not inline JSON. The
deterministic workflow requires one string named input_text. The repository
ships a ready-made input at
agentic-workflows-v2/tests/fixtures/deterministic_input.json that you can
pass directly. To create your own:
Bash:
PowerShell:
Use -Encoding ascii (or the shipped fixture) here. Windows PowerShell 5.1
writes a byte-order mark with -Encoding utf8, and the CLI rejects a
BOM-prefixed file with Unexpected UTF-8 BOM. PowerShell 7 does not add one.
3. Run the workflow¶
Bash:
PowerShell:
The expected status is:
The run also prints the workflow outputs, processed_text and step_count.
test_deterministic has two tier-0 agent steps:
step1reads and processesinput_text.step2waits forstep1and counts the processed characters.
Tier-0 agents run deterministic Python handlers on both execution engines, so
test_deterministic never calls a model. AGENTIC_NO_LLM=1 is a safeguard
here: it replaces every model call with fixed placeholder text
(PlaceholderChatModel on the LangGraph path, a mock backend on the native
path), which protects you from an accidental provider call if you move on to
an LLM-backed workflow. It does not test response quality. The command may log
input-mapping or tool-provider warnings while still completing successfully.
Add --verbose to print the execution plan and step result table:
4. Save the result¶
Use --output to write a JSON summary of the run. A relative path works the
same in every shell:
PowerShell:
Whichever engine ran, the file holds the CLI summary, not the full
WorkflowResult model:
workflow_name;status, lowercase (for examplesuccess);outputs, the workflow's declared outputs (processed_textandstep_countfortest_deterministic);steps, a map of step name tostatus,outputs, anderror;errors; andelapsed_seconds.
Model fields such as run_id, overall_status, step_results, and
final_output are not written. Inspect the result:
PowerShell:
5. Check both adapters¶
The named workflow path defaults to LangGraph. Run the same definition through the native engine:
Or compare both:
Both runs should succeed. A failed side makes agentic compare exit non-zero.
6. Confirm the approval gate fails closed¶
High-impact tools (shell, file_write, build_app, http_post, and
others) need approval from a registered ApprovalProvider. A fresh install
registers none, so the call is denied before the tool body runs. From the
repository root, with the environment active:
See Known limitations section 4.3 for what the gate covers today.
7. Validate another workflow¶
Validation checks schema, dependencies, cycles, and LangGraph compilation without calling a provider:
Do not use placeholder mode as proof that an LLM-backed workflow produces valid business output. The placeholder is fixed text. Workflows that require JSON, source code, tool calls, or typed artifacts can fail or produce unresolved outputs by design.
For a real model-backed run:
- copy
.env.exampleto.env; - set one supported provider credential;
- unset
AGENTIC_NO_LLM; and - supply the inputs required by the selected workflow.
See Configuration and No-LLM mode.
8. Open the dashboard¶
On Windows, just dev starts the backend and the UI, and just dev-stop
stops both. Without just, use two terminals with the environment active.
Terminal 1:
PowerShell:
Terminal 2:
The UI is at http://127.0.0.1:5173 and the API at http://127.0.0.1:8010
(OpenAPI at /docs). Vite proxies /api and /ws to port 8010 by default.
agentic serve itself defaults to port 8000, so pass --port 8010 to match
the proxy. The five-minute demo walks through the dashboard.