wirl 0.1.1 → 0.2.0

package/README.md

@@ -1,106 +1,55 @@
-# Wirl
+# wirl
 
-Email sequence automation for developers.
-
-## Installation
+Deploy an internal app somewhere real, privately. One command puts the folder you are in on a URL that only your company can open.
 
 ```bash
-npm install wirl
-```
-
-## Quick Start
-
-```typescript
-import Wirl from 'wirl';
-
-const wirl = new Wirl({
-  apiKey: 'sk_test_...',
-  baseUrl: 'https://your-wirl-instance.vercel.app'
-});
-
-// Track events
-await wirl.track({
-  email: 'user@example.com',
-  event: 'user.signup',
-  properties: { plan: 'pro' }
-});
-
-// Update contact properties
-await wirl.identify({
-  email: 'user@example.com',
-  properties: {
-    name: 'John Doe',
-    company: 'Acme Inc'
-  }
-});
-
-// Manually trigger a sequence
-await wirl.trigger({
-  email: 'user@example.com',
-  sequence: 'Welcome Sequence'
-});
-
-// Remove from a sequence
-await wirl.exit({
-  email: 'user@example.com',
-  sequence: 'Welcome Sequence'
-});
+npm install -g https://app.wirl.dev/cli/wirl.tgz
+wirl login                # a link and a code; approve in the browser
+wirl init my-tool --server
+cd my-tool
+wirl dev                  # runs it here, signed in as a stub user
+wirl preview              # a private address to look at it before it is live
+wirl deploy               # builds, scans, deploys; prints the URL
+wirl share dana@company.com
 ```
 
-## API
+Install it from wirl itself, as above, and run plain `wirl`. Do not run `npx wirl`: that name on npm belongs to an unrelated older package today, and `npx` would fetch that one.
 
-### `new Wirl(options)`
+Sign in with your work Google account and you are in your company's workspace. Anything a colleague deploys there is yours to open, and nobody outside the company can. A personal account gets a space of its own.
 
-| Option | Type | Required | Description |
-|--------|------|----------|-------------|
-| `apiKey` | string | Yes | Your Wirl API key |
-| `baseUrl` | string | No | API base URL (default: `https://api.wirl.dev`) |
+## What an app is
 
-### `wirl.track(params)`
+A static folder needs nothing. A server-side app is one JavaScript module exporting `fetch(request, env)`:
 
-Track an event for a contact. Creates the contact if they don't exist.
+- `env.DB` is a SQLite database that belongs to this app, in D1's prepared-statement shape. Rolling back code never rolls back data.
+- `x-wirl-user-id`, `x-wirl-role` and `x-wirl-org` say who the visitor is. wirl sets them after verifying the person; the browser cannot forge them.
+- Third-party APIs are called by their real URL. Declare the connection in `wirl.json`, and wirl attaches the key on the way out. The key never reaches the app, the agent that wrote it, or this machine.
+- A `public_paths` entry in `wirl.json` opens one path to the internet with no sign-in — for a Slack, Stripe or GitHub webhook — and wirl checks the sender's signature before the app is ever called.
 
-```typescript
-await wirl.track({
-  email: 'user@example.com',
-  event: 'purchase.completed',
-  properties: { amount: 99.99 }
-});
-```
+`wirl dev` runs the same bundle under Node, with the same database shape and headers, so what you see locally is what ships.
 
-### `wirl.identify(params)`
+## For coding agents
 
-Create or update a contact with properties.
+`wirl init` writes `.claude/skills/wirl/SKILL.md` so Claude Code knows wirl is there. Agents that speak MCP can connect directly:
 
-```typescript
-await wirl.identify({
-  email: 'user@example.com',
-  properties: { name: 'John', plan: 'enterprise' }
-});
+```bash
+claude mcp add --transport http wirl https://app.wirl.dev/mcp
 ```
 
-### `wirl.trigger(params)`
+That opens the browser once to sign in. The token an agent gets can deploy, roll back and pull, and cannot share apps, change who can open them, or touch connections, members or tokens. Ticking one box at consent grants full access. See the docs for what each scope covers.
 
-Manually enroll a contact in a sequence.
+## Everything else
 
-```typescript
-await wirl.trigger({
-  email: 'user@example.com',
-  sequence: 'Onboarding'
-});
+```bash
+wirl --help
 ```
 
-### `wirl.exit(params)`
+Orgs, members, connections, transfer, move, versions, rollback, pull, previews, logs, schedules, run.
 
-Remove a contact from an active sequence.
+## Requirements
 
-```typescript
-await wirl.exit({
-  email: 'user@example.com',
-  sequence: 'Onboarding'
-});
-```
+Node 22.13 or later. Credentials live in `~/.config/wirl/credentials.json` after `wirl login`, or in `WIRL_TOKEN` for CI and sandboxes.
 
-## License
+Docs: https://docs.wirl.dev. Site: https://wirl.dev. Issues: https://github.com/Brycce/wirl-platform/issues.
 
-MIT
+wirl is a hosted service; use of the CLI is governed by the terms at https://wirl.dev/terms.