Skip to content

docs: list all 8 human task types in README #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
George-iam merged 1 commit into from
Mar 19, 2026
Merged

docs: list all 8 human task types in README #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 22 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,13 @@ axme-examples/
│ ├── human/
│ │ ├── cli/ # CLI approval (axme tasks approve)
│ │ ├── email/ # Email magic link approval
│ │ └── form/ # Structured form approval
│ │ ├── form/ # Structured form with required fields
│ │ ├── confirmation/ # Confirm real-world action completed
│ │ ├── assignment/ # Assign work to a person or team
│ │ ├── review/ # Code/document review with approve/reject
│ │ ├── clarification/ # Request clarification (comment required)
│ │ ├── manual-action/ # Physical/manual action (evidence required)
│ │ └── override/ # Override policy gate (comment required)
│ ├── internal/
│ │ ├── delay/ # Step deadline enforcement
│ │ ├── notification/ # Owner notification + ack
Expand Down Expand Up @@ -128,13 +134,21 @@ AXME_TO_AGENT=agent://org/workspace/compliance-checker-agent \
| `delivery/http` | AXME POSTs to agent's callback URL | Yes (HTTP server) |
| `delivery/inbox` | reply_to inbox — disconnect-safe | Yes |

### Human Approval

| Example | Approval method |
|---------|----------------|
| `human/cli` | `axme tasks approve <id>` from terminal |
| `human/email` | One-click magic link in email |
| `human/form` | Structured form with required fields |
### Human-in-the-Loop (8 Task Types)

All human task examples send an email with a magic link to a web task page. The page renders task-specific UI based on `task_type`.

| Example | Task type | What the human does |
|---------|-----------|-------------------|
| `human/cli` | `approval` | Approve/reject from CLI (`axme tasks approve`) |
| `human/email` | `approval` | Approve/reject via email magic link |
| `human/form` | `form` | Fill structured form with required fields |
| `human/confirmation` | `confirmation` | Confirm a real-world action was completed |
| `human/assignment` | `assignment` | Assign work to a person (with form fields) |
| `human/review` | `review` | Review and approve, request changes, or reject |
| `human/clarification` | `clarification` | Provide clarification (comment required) |
| `human/manual-action` | `manual_action` | Complete a physical task, attach evidence |
| `human/override` | `override` | Override a policy gate (comment required) |

### Internal Runtime

Expand Down
Loading