Skip to content

Commit cd75c57

Browse files
George-iamclaude
andauthored
Improve examples README for HN launch (#36)
- Add one-liner explaining what AXME is after title - Add Related Repositories table with links to all repos - Integrate Alpha Access into Quick Start as step 0 - Add brief explanations for Model B (ScenarioBundle) and Model A (Direct API) - Explain AXME_CLI_SECRET_STORAGE=file with inline comment and add to env vars table - Replace em dashes with regular dashes throughout Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 179f33f commit cd75c57

1 file changed

Lines changed: 43 additions & 10 deletions

File tree

README.md

Lines changed: 43 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,38 @@
11
# AXME Examples
22

3-
Production-ready examples for the AXME platform — all delivery bindings, human approval flows, internal runtime, durability scenarios, and multi-agent orchestration.
3+
AXME is a coordination infrastructure for durable execution - submit once, track lifecycle, complete later. These examples show every capability in runnable form.
4+
5+
Production-ready examples for the AXME platform - all delivery bindings, human approval flows, internal runtime, durability scenarios, and multi-agent orchestration.
46

57
Each example is available in **5 languages**: Python, TypeScript, Go, Java, .NET.
68

9+
## Related Repositories
10+
11+
| Repository | Description |
12+
|------------|-------------|
13+
| [axme](https://github.com/AxmeAI/axme) | Main project and overview |
14+
| [axme-spec](https://github.com/AxmeAI/axme-spec) | Protocol specification |
15+
| [axme-docs](https://github.com/AxmeAI/axme-docs) | Documentation |
16+
| [axme-cli](https://github.com/AxmeAI/axme-cli) | CLI tool |
17+
| [axme-sdk-python](https://github.com/AxmeAI/axme-sdk-python) | Python SDK |
18+
| [axme-sdk-typescript](https://github.com/AxmeAI/axme-sdk-typescript) | TypeScript SDK |
19+
| [axme-sdk-go](https://github.com/AxmeAI/axme-sdk-go) | Go SDK |
20+
| [axme-sdk-java](https://github.com/AxmeAI/axme-sdk-java) | Java SDK |
21+
| [axme-sdk-dotnet](https://github.com/AxmeAI/axme-sdk-dotnet) | .NET SDK |
22+
723
## Quick Start
824

925
```bash
26+
# 0. Get access - install the CLI and log in
27+
# curl -fsSL https://raw.githubusercontent.com/AxmeAI/axme-cli/main/install.sh | sh
28+
# (open a new terminal after install)
29+
# Contact: hello@axme.ai
30+
1031
# 1. Install the CLI + SDK
1132
pip install axme
1233

1334
# 2. Log in
14-
export AXME_CLI_SECRET_STORAGE=file
35+
export AXME_CLI_SECRET_STORAGE=file # Use file-based storage for headless/CI environments
1536
axme login
1637

1738
# 3. Run any scenario (provisions agents, sends intent, watches lifecycle)
@@ -83,7 +104,9 @@ examples/delivery/stream/
83104

84105
## Running Examples
85106

86-
### Model B — ScenarioBundle (recommended)
107+
### Model B - ScenarioBundle (recommended)
108+
109+
Model B uses a declarative `scenario.json` file that the CLI provisions end-to-end: agents, intents, and lifecycle - no manual API calls needed.
87110

88111
Most examples use `scenario.json` + the AXME CLI:
89112

@@ -109,9 +132,11 @@ cd lang/java && mvn -q compile exec:java \
109132
cd lang/dotnet && dotnet run -p:ExampleClass=AxmeExamples.Delivery.StreamAgent
110133
```
111134

112-
### Model A — Direct API (no ScenarioBundle)
135+
### Model A - Direct API (no ScenarioBundle)
136+
137+
Model A gives you full programmatic control - your code creates intents, manages agents, and handles lifecycle directly via the SDK.
113138

114-
Model A examples use the SDK directly the initiator creates intents via API:
139+
Model A examples use the SDK directly - the initiator creates intents via API:
115140

116141
```bash
117142
# Start agent
@@ -129,10 +154,10 @@ AXME_TO_AGENT=agent://org/workspace/compliance-checker-agent \
129154

130155
| Example | Pattern | Agent needed? |
131156
|---------|---------|:------------:|
132-
| `delivery/stream` | SSE persistent connection real-time delivery | Yes |
133-
| `delivery/poll` | Periodic polling batch/serverless friendly | Yes |
157+
| `delivery/stream` | SSE persistent connection - real-time delivery | Yes |
158+
| `delivery/poll` | Periodic polling - batch/serverless friendly | Yes |
134159
| `delivery/http` | AXME POSTs to agent's callback URL | Yes (HTTP server) |
135-
| `delivery/inbox` | reply_to inbox disconnect-safe | Yes |
160+
| `delivery/inbox` | reply_to inbox - disconnect-safe | Yes |
136161

137162
### Human-in-the-Loop (8 Task Types)
138163

@@ -154,7 +179,7 @@ All human task examples send an email with a magic link to a web task page. The
154179

155180
| Example | What it demonstrates |
156181
|---------|---------------------|
157-
| `internal/delay` | Step deadline (120s) agent must respond in time |
182+
| `internal/delay` | Step deadline (120s) - agent must respond in time |
158183
| `internal/notification` | Built-in notification to service owner |
159184
| `internal/escalation` | Reminders + timeout escalation chain |
160185
| `internal/human_approval` | Pure human gate, no agent (scenario-only) |
@@ -203,8 +228,16 @@ All examples use AXME SDK v0.1.2:
203228
| `AXME_API_KEY` | Yes | Service account or workspace API key |
204229
| `AXME_BASE_URL` | No | Default: `https://api.cloud.axme.ai` |
205230
| `AXME_AGENT_ADDRESS` | No | Agent address (bare name or full `agent://...`) |
231+
| `AXME_CLI_SECRET_STORAGE` | No | Set to `file` for headless/CI environments (default: OS keychain) |
206232

207233
## Alpha Access
208234

209-
Install the CLI and log in: `curl -fsSL https://raw.githubusercontent.com/AxmeAI/axme-cli/main/install.sh | sh` (open a new terminal, then `axme login`)
235+
Install the CLI and log in:
236+
237+
```bash
238+
curl -fsSL https://raw.githubusercontent.com/AxmeAI/axme-cli/main/install.sh | sh
239+
# Open a new terminal after install
240+
axme login
241+
```
242+
210243
Contact: hello@axme.ai

0 commit comments

Comments
 (0)