From dc4e76f8327b8988a819f1853d5933e8aafc5e49 Mon Sep 17 00:00:00 2001
From: Ofek <obenyaish@gmail.com>
Date: Sun, 31 May 2026 16:32:37 +0300
Subject: [PATCH] docs: rewrite README as a standard npm CLI readme

---
 README.md | 86 ++++++++++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 79 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 54e383b..decab0f 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,91 @@
 # @getdial/cli
 
-The Dial CLI.
+The official command-line interface for [Dial](https://getdial.ai) — a communication stack for AI agents. Provision phone numbers, send SMS, place AI voice calls, and react to inbound events, all from your terminal. The CLI wraps the [Dial REST API](https://docs.getdial.ai) so you never have to write HTTP code.
 
-Install via the bootstrap script:
+## Installation
+
+Install globally from npm:
 
 ```bash
-curl -fsSL https://dial.up.railway.app/install | bash
+npm install -g @getdial/cli
 ```
 
-Or directly from npm:
+Or use the bootstrap script, which installs the CLI and walks you through sign-up:
 
 ```bash
-npm install -g @getdial/cli
+curl -fsSL https://getdial.ai/install | bash
+```
+
+Requires **Node.js 22+**.
+
+## Quick start
+
+```bash
+dial signup you@example.com      # email a 6-digit sign-up code
+dial onboard --code 123456       # verify the code and provision your account
+dial doctor                      # check account state and what to do next
+```
+
+Once onboarded, your API key is saved locally and the CLI uses it automatically.
+
+```bash
+# Send an SMS
+dial message --to +14155550123 --body "Hello from Dial"
+
+# Place an AI voice call
+dial call --to +14155550123 --system-prompt "You are a helpful scheduling assistant."
+
+# Wait for an inbound event (e.g. a verification code)
+dial wait-for message.received --field to=+14155550123
 ```
 
-Requires Node 22+.
+## Commands
+
+| Command | Description |
+| --- | --- |
+| `dial doctor` | Report account state and what to do next. |
+| `dial signup <email>` | Email a 6-digit sign-up code. |
+| `dial onboard --code <code>` | Verify the code and finish onboarding. |
+| `dial number list` | List the phone numbers on your account. |
+| `dial number purchase` | Purchase an additional phone number. |
+| `dial message` | Send an SMS. |
+| `dial message list` | List recent messages. |
+| `dial call` | Place an outbound AI voice call. |
+| `dial call list` | List recent calls. |
+| `dial call get <id>` | Fetch a single call — status, duration, transcript. |
+| `dial wait-for <event>` | Block until a matching account event arrives. |
+| `dial listen install` | Install the background event daemon. |
+| `dial listen status` | Report the daemon's state and recent events. |
+| `dial listen uninstall` | Stop and remove the daemon. |
+| `dial local-target add url <url>` | Fan out events to a local HTTP endpoint. |
+| `dial local-target add cmd <path>` | Run an executable once per event. |
+| `dial local-target list` | List registered fan-out targets. |
+| `dial local-target remove <id>` | Unregister a fan-out target. |
+
+Run `dial --help` for the full command tree, or `dial <command> --help` for a specific command's flags. Every command accepts `--json` for machine-readable output.
+
+## Configuration
+
+| Variable | Description |
+| --- | --- |
+| `DIAL_API_URL` | Target a non-default Dial deployment. |
+
+Your API key is stored at `~/.local/share/dial/auth.json` (honoring `XDG_DATA_HOME`).
+
+## Use from an AI agent
+
+The CLI ships with a [skill](https://docs.getdial.ai/integrations/tools/cli-skill) that teaches AI coding agents how to drive `dial`. Install it into your agent's config during onboarding:
+
+```bash
+dial onboard --code 123456 --agent claude-code
+```
+
+Supported agents: `claude-code`, `cursor`, `codex`, `opencode`, `pi`, `openclaw`, `nanoclaw`, `hermes`.
+
+## Documentation
+
+Full documentation lives at **[docs.getdial.ai](https://docs.getdial.ai)** — including the [CLI reference](https://docs.getdial.ai/documentation/cli/commands) and the [listen service](https://docs.getdial.ai/documentation/cli/listen-service) guide.
+
+## License
 
-See `docs/superpowers/specs/2026-05-25-dial-cli-and-listen-service-design.md` for design.
+MIT