Skip to content

Commit 3ccd4ac

Browse files
authored
README: plain-English intro and command-selection table (#4)
- 'In plain words': what it does / why it matters for AI work / what a run leaves behind, written for non-technical readers. - 'Which command, when': one-line purpose for each piw command. Co-authored-by: Ali Abassi <ali-abassi@users.noreply.github.com>
1 parent 02a8243 commit 3ccd4ac

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,33 @@ validated YAML → deterministic DAG → node output → code-owned gate
2222
Core is deliberately not another all-in-one agent platform. It is the portable
2323
execution contract underneath one.
2424

25+
## In plain words
26+
27+
- **What it does.** You write your steps in one small text file
28+
(`steps.yaml`)—a numbered checklist. `piw` runs the steps in the right
29+
order, tests each step's output before moving on, retries what failed, and
30+
stops where a human must decide. If it stops, `piw resume` picks up exactly
31+
where it left off.
32+
- **Why that matters for AI work.** Agents sometimes skip steps or declare
33+
unfinished work done. Here a model may *write* a step's content, but plain
34+
code decides what runs next, and a real test (the `gate`) decides pass or
35+
fail—a model cannot talk its way past it.
36+
- **What you get afterwards.** Every run is an ordinary folder holding the
37+
exact input, every step's output, what each step cost, and a full timeline.
38+
No server, no database, no dashboard.
39+
40+
## Which command, when
41+
42+
| You want to | Run |
43+
|---|---|
44+
| Start a new workflow file | `piw create NAME` |
45+
| Check the file is valid (free, nothing executes) | `piw validate NAME --strict` |
46+
| See the step order before running | `piw graph NAME` |
47+
| Execute the workflow | `piw run NAME --input "..." --strict --json` |
48+
| See what a run did, produced, and cost | `piw inspect NAME --json` |
49+
| Continue a stopped or failed run | `piw resume NAME RUN_ID --json` |
50+
| Check your machine is ready | `piw doctor` |
51+
2552
## Try it in two minutes
2653

2754
Install `piw` (the **p**i **w**orkflow command) from the v0.1.0 release:

0 commit comments

Comments
 (0)