apiblaze 0.4.0 → 0.4.1

package/README.md

@@ -1,44 +1,38 @@
 # apiblaze
 
-CLI for [APIblaze](https://apiblaze.com) — instantly tunnel localhost to your APIblaze projects during development.
+CLI for [APIblaze](https://apiblaze.com) — turn any backend into a managed API: add a key, auth, rate limits, a spec, and your own domain, in seconds.
 
-## Installation
+## Install
 
 ```bash
-npm install -g apiblaze
+npx apiblaze --help        # run without installing
+npm install -g apiblaze    # or install globally
 ```
 
-Or run without installing:
+Requires Node.js 18+.
+
+## Quick start
+
+The easiest way is to just chat with it:
 
 ```bash
-npx apiblaze --help
+npx apiblaze agent
 ```
 
-## Requirements
+> Talk in plain English — "make an API for httpbin.org", "rate-limit it to 50/sec",
+> "give me a key". It does the work and shows what each step costs.
 
-- Node.js 18+
-
-## Quick start
+Prefer commands? A few one-liners:
 
 ```bash
-# Create a proxy (no account needed)
+# Make an API in one line — no account needed (prints a claim URL)
 npx apiblaze create --target https://api.example.com
 
-# Optional: sign in if you want it under your team
-npx apiblaze login
-
-# Create a proxy under your team
-npx apiblaze create --name myapi --target https://api.example.com --auth api_key
-
-# Start a dev tunnel (defaults to port 3000)
-npx apiblaze dev
-
-# Or specify a port
+# Run your localhost through a public URL
 npx apiblaze dev 3000
 
-# Stream full request/response traffic to a file (JSON lines)
-npx apiblaze dev 3000 --capture-file traffic.jsonl
-
+# Sign in to manage APIs under your team
+npx apiblaze login
 ```
 
 ## Help
@@ -59,64 +53,62 @@ apiblaze throttle myapi --rate 50 --verbose
 
 ## Commands
 
-### Account & basics
+### Chat (the easy way)
 
-| Command | Description |
+| Command | What it does |
 |---|---|
-| `apiblaze login` | Authenticate with your APIblaze account |
-| `apiblaze logout` | Sign out and remove stored credentials |
-| `apiblaze whoami` | Show the signed-in identity and active team |
-| `apiblaze team [team]` | Switch the active team |
-| `apiblaze projects` | List your team's proxies |
-| `apiblaze create [options]` | Create a new API proxy (anonymous if not logged in) |
-| `apiblaze claim [code]` | Claim an anonymously-created proxy into your team |
-| `apiblaze dev [port]` | Start a dev tunnel for your localhost projects |
-
-### Manage a proxy
-
-| Command | Description |
-|---|---|
-| `apiblaze delete <project> [version]` | Delete a proxy (full cascade) — shows impact, then confirms |
-| `apiblaze target <project> --url <u> [--env <e>]` | Set the target URL (per-environment with `--env`, else project-level) |
-| `apiblaze throttle <project> [--rate n] [--quota n] [--period daily\|weekly\|monthly]` | Set rate limits + quota |
-| `apiblaze rename <project> --display-name <name>` | Change the display name |
-| `apiblaze spec get <project>` | Print the current OpenAPI document |
-| `apiblaze spec set <project> --file <path>` | Replace the OpenAPI spec from a local file |
+| `apiblaze agent` | Chat about anything — create, configure, and inspect your APIs |
+| `apiblaze agent openapi <project>` | Chat to build your API spec from real traffic |
+| `apiblaze agent authz <project>` | Chat to design and turn on access rules |
+| `apiblaze agent mcp <project>` | Chat to build an MCP server for your API |
+
+Every chat turn shows its cost.
 
-### Custom domains
+### Getting started
 
-| Command | Description |
+| Command | What it does |
 |---|---|
-| `apiblaze domain add <project> --domain <host>` | Register a custom hostname (prints DNS records; does not poll) |
-| `apiblaze domain list <project>` | List custom domains |
-| `apiblaze domain status <project> --id <domainId>` | Check a domain's validation status |
-| `apiblaze domain rm <project> --id <domainId>` | Remove a custom domain |
-| `apiblaze domain set-base <project> [--env <e>]` | Point the bare `{project}` hostname at a (version, env) |
+| `apiblaze create --target <url>` | Make an API from a backend (no account needed) |
+| `apiblaze dev [port]` | Put your localhost behind a public URL |
+| `apiblaze login` / `logout` | Sign in / out |
+| `apiblaze whoami` | Who am I, and which team |
+| `apiblaze team [name]` | Switch team |
+| `apiblaze projects` | List your APIs |
+| `apiblaze claim [code]` | Claim an API you made before signing in |
 
-### Tenants & keys
+### Manage an API
 
-| Command | Description |
+| Command | What it does |
 |---|---|
-| `apiblaze tenant list` | List tenants in your team |
-| `apiblaze tenant create --name <display> [--slug <s>]` | Create a tenant |
-| `apiblaze tenant attach <project> --tenant <slug>` | Attach a tenant to a proxy |
-| `apiblaze tenant cors --tenant <slug> --origins <a,b>` | Set the CORS allow-list for a tenant |
-| `apiblaze tenant delete <slug>` | Delete a tenant (full cascade) |
-| `apiblaze key list` | List control-plane developer keys |
-| `apiblaze key mint [--desc <text>] [--expires-days <n>]` | Mint a consumer-admin key (secret shown once) |
-| `apiblaze key revoke <keyId>` | Revoke a developer key |
-
-### Design assistants (chat)
-
-| Command | Description |
+| `apiblaze target <project> --url <url> [--env <e>]` | Change where it forwards requests |
+| `apiblaze throttle <project> [--rate n] [--quota n] [--period daily\|weekly\|monthly]` | Set rate limits and quotas |
+| `apiblaze rename <project> --display-name <name>` | Rename it |
+| `apiblaze spec get <project>` | Print its OpenAPI spec |
+| `apiblaze spec set <project> --file <path>` | Replace its OpenAPI spec from a file |
+| `apiblaze delete <project>` | Delete it and everything under it (asks first) |
+
+### Your own domain
+
+| Command | What it does |
 |---|---|
-| `apiblaze agent` | Chat with a producer assistant that can create/manage your proxies, tenants, keys, domains, and specs. Billed per turn (cost shown). |
-| `apiblaze authz <project>` | Design API authorization interactively, then publish + enable it |
-| `apiblaze openapi <project>` | Design your OpenAPI spec from captured traffic, then publish it |
-| `apiblaze mcp <project>` | Design an MCP server from the spec + traffic, then publish it |
+| `apiblaze domain add <project> --domain <host>` | Add your domain (shows the DNS records to set) |
+| `apiblaze domain status <project> --id <id>` | Check if it's verified yet |
+| `apiblaze domain list <project>` / `rm <project> --id <id>` | List / remove |
+| `apiblaze domain set-base <project> [--env <e>]` | Pick which version/env your main URL serves |
 
-> Most management commands accept `--team <id\|name>` (defaults to your active team),
-> `--apiversion <version>`, and `--json` (machine-readable output for scripts).
+### Users & keys
+
+| Command | What it does |
+|---|---|
+| `apiblaze tenant create --name <name>` | Create a tenant (a separate group of your API's users) |
+| `apiblaze tenant attach <project> --tenant <slug>` | Give a proxy its own set of users |
+| `apiblaze tenant cors --tenant <slug> --origins <a,b>` | Set which websites can call it |
+| `apiblaze tenant list` / `delete <slug>` | List / delete |
+| `apiblaze key mint [--desc <text>]` | Make a key to manage your account from scripts |
+| `apiblaze key list` / `revoke <id>` | List / revoke |
+
+> See what any command does under the hood with `--verbose`. Most management
+> commands take `--team`, `--apiversion`, and `--json`.
 
 ## How it works
 

package/dist/index.js

@@ -28,7 +28,7 @@ var import_commander = require("commander");
 var import_chalk25 = __toESM(require("chalk"));
 
 // package.json
-var version = "0.4.0";
+var version = "0.4.1";
 
 // src/types.ts
 var ApiError = class extends Error {
@@ -2637,6 +2637,23 @@ program.command("create").description("Create a new API proxy (no login needed \
     process.exit(1);
   }
 });
+var agent = program.command("agent").description("Chat with an assistant that builds and runs your APIs (billed per turn)").option("--team <id|name>", "Team to work in (defaults to your active team)").action(action((opts) => runAgent(opts)));
+agent.command("authz").description("Chat to design and turn on access rules for an API").argument("<project>", "Project name or id").argument("[apiVersion]", "API version (defaults to the project's)").action(action((project, apiVersion) => runAuthz(project, apiVersion)));
+agent.command("openapi").description("Chat to build your API spec from real traffic").argument("<project>", "Project name or id").argument("[apiVersion]", "API version (defaults to the project's)").action(action((project, apiVersion) => runOpenapi(project, apiVersion)));
+agent.command("mcp").description("Chat to build an MCP server for an API").argument("<project>", "Project name or id").argument("[apiVersion]", "API version (defaults to the project's)").option("--environment <env>", "Environment to publish (default: prod)").action(action((project, apiVersion, opts) => runMcp(project, apiVersion, opts)));
+program.command("dev").description("Put your localhost behind a public URL (dev tunnel)").argument("[port]", "Local port to tunnel (positional; overrides --port)").option("-p, --port <number>", "Local port to tunnel", "3000").option("-o, --capture-file <path>", "Stream full request/response traffic to a file (JSON lines)").action(async (port, opts) => {
+  try {
+    const resolved = parseInt(port ?? opts.port, 10);
+    if (Number.isNaN(resolved)) {
+      console.error(import_chalk25.default.red(`Invalid port: ${port ?? opts.port}`));
+      process.exit(1);
+    }
+    await runDev({ port: resolved, captureFile: opts.captureFile });
+  } catch (err) {
+    printError(err);
+    process.exit(1);
+  }
+});
 program.command("logout").description("Sign out \u2014 remove stored credentials from this machine").action(async () => {
   try {
     await runLogout();
@@ -2677,100 +2694,47 @@ program.command("projects").description("List the projects in your team").action
     process.exit(1);
   }
 });
-program.command("authz").description("Design API authorization interactively (chat), then publish + enable it").argument("<project>", "Project name or id (see `apiblaze projects`)").argument("[apiVersion]", "API version (defaults to the project's version)").action(async (project, apiVersion) => {
-  try {
-    await runAuthz(project, apiVersion);
-  } catch (err) {
-    printError(err);
-    process.exit(1);
-  }
-});
-program.command("openapi").description("Design your OpenAPI spec from captured traffic interactively (chat), then publish it").argument("<project>", "Project name or id (see `apiblaze projects`)").argument("[apiVersion]", "API version (defaults to the project's version)").action(async (project, apiVersion) => {
-  try {
-    await runOpenapi(project, apiVersion);
-  } catch (err) {
-    printError(err);
-    process.exit(1);
-  }
-});
-program.command("mcp").description("Design an MCP server from the spec + traffic interactively (chat), then publish it").argument("<project>", "Project name or id (see `apiblaze projects`)").argument("[apiVersion]", "API version (defaults to the project's version)").option("--environment <env>", "Environment to publish (default: prod)").action(async (project, apiVersion, opts) => {
-  try {
-    await runMcp(project, apiVersion, opts);
-  } catch (err) {
-    printError(err);
-    process.exit(1);
-  }
-});
-program.command("dev").description("Start a dev tunnel for your localhost projects").argument("[port]", "Local port to tunnel (positional; overrides --port)").option("-p, --port <number>", "Local port to tunnel", "3000").option("-o, --capture-file <path>", "Stream full request/response traffic to a file (JSON lines)").action(async (port, opts) => {
-  try {
-    const resolved = parseInt(port ?? opts.port, 10);
-    if (Number.isNaN(resolved)) {
-      console.error(import_chalk25.default.red(`Invalid port: ${port ?? opts.port}`));
-      process.exit(1);
-    }
-    await runDev({ port: resolved, captureFile: opts.captureFile });
-  } catch (err) {
-    printError(err);
-    process.exit(1);
-  }
-});
-program.command("delete").description("Delete a proxy (full cascade) \u2014 shows impact, then confirms").argument("<project>", "Project name or id (see `apiblaze projects`)").argument("[version]", "API version (defaults to the first match)").option("--team <id|name>", "Team the project is in (defaults to active team)").option("-y, --yes", "Skip the confirmation prompt").option("--json", "Output machine-readable JSON").action(action((project, version2, opts) => runDelete(project, version2, opts)));
-program.command("target").description("Set a proxy's target URL (per-environment with --env, else project-level)").argument("<project>", "Project name or id").requiredOption("--url <url>", "Target URL to forward to").option("--env <env>", "Environment to scope the target to (e.g. prod, dev)").option("--team <id|name>", "Team the project is in").option("--apiversion <version>", "API version (defaults to the first match)").option("--json", "Output machine-readable JSON").action(action((project, opts) => runTargetSet(project, opts)));
-program.command("throttle").description("Set per-proxy throttling (rate limits + quota)").argument("<project>", "Project name or id").option("--rate <n>", "User rate limit (requests/sec)").option("--end-user-rate <n>", "Per-end-user rate limit (requests/sec)").option("--quota <n>", "Proxy quota (requests/period)").option("--period <p>", "Quota period: daily | weekly | monthly").option("--team <id|name>", "Team the project is in").option("--apiversion <version>", "API version").option("--json", "Output machine-readable JSON").action(action((project, opts) => runThrottleSet(project, opts)));
+program.command("delete").description("Delete a proxy and everything under it (asks first)").argument("<project>", "Project name or id (see `apiblaze projects`)").argument("[version]", "API version (defaults to the first match)").option("--team <id|name>", "Team the project is in (defaults to active team)").option("-y, --yes", "Skip the confirmation prompt").option("--json", "Output machine-readable JSON").action(action((project, version2, opts) => runDelete(project, version2, opts)));
+program.command("target").description("Change where a proxy forwards requests").argument("<project>", "Project name or id").requiredOption("--url <url>", "Target URL to forward to").option("--env <env>", "Environment to scope the target to (e.g. prod, dev)").option("--team <id|name>", "Team the project is in").option("--apiversion <version>", "API version (defaults to the first match)").option("--json", "Output machine-readable JSON").action(action((project, opts) => runTargetSet(project, opts)));
+program.command("throttle").description("Set rate limits and quotas for a proxy").argument("<project>", "Project name or id").option("--rate <n>", "User rate limit (requests/sec)").option("--end-user-rate <n>", "Per-end-user rate limit (requests/sec)").option("--quota <n>", "Proxy quota (requests/period)").option("--period <p>", "Quota period: daily | weekly | monthly").option("--team <id|name>", "Team the project is in").option("--apiversion <version>", "API version").option("--json", "Output machine-readable JSON").action(action((project, opts) => runThrottleSet(project, opts)));
 program.command("rename").description("Change a proxy's display name").argument("<project>", "Project name or id").requiredOption("--display-name <name>", "New human-friendly display name").option("--team <id|name>", "Team the project is in").option("--apiversion <version>", "API version").option("--json", "Output machine-readable JSON").action(action((project, opts) => runRename(project, opts)));
-var domain = program.command("domain").description("Manage custom domains for a proxy");
-domain.command("add").description("Register a custom hostname (prints DNS records; does not poll)").argument("<project>", "Project name or id").requiredOption("--domain <host>", "Custom hostname to add").option("--tenant <slug>", "Tenant to scope the domain to").option("--team <id|name>", "Team the project is in").option("--apiversion <version>", "API version").option("--json", "Output machine-readable JSON").action(action((project, opts) => runDomainAdd(project, opts)));
+var domain = program.command("domain").description("Use your own domain for a proxy");
+domain.command("add").description("Add your own domain (shows the DNS records to set)").argument("<project>", "Project name or id").requiredOption("--domain <host>", "Custom hostname to add").option("--tenant <slug>", "Tenant to scope the domain to").option("--team <id|name>", "Team the project is in").option("--apiversion <version>", "API version").option("--json", "Output machine-readable JSON").action(action((project, opts) => runDomainAdd(project, opts)));
 domain.command("list").description("List custom domains for a proxy").argument("<project>", "Project name or id").option("--team <id|name>", "Team the project is in").option("--apiversion <version>", "API version").option("--json", "Output machine-readable JSON").action(action((project, opts) => runDomainList(project, opts)));
 domain.command("status").description("Check a custom domain's validation status").argument("<project>", "Project name or id").requiredOption("--id <domainId>", "Domain id (see `domain list`)").option("--team <id|name>", "Team the project is in").option("--apiversion <version>", "API version").option("--json", "Output machine-readable JSON").action(action((project, opts) => runDomainStatus(project, opts)));
 domain.command("rm").description("Remove a custom domain").argument("<project>", "Project name or id").requiredOption("--id <domainId>", "Domain id (see `domain list`)").option("--team <id|name>", "Team the project is in").option("--apiversion <version>", "API version").action(action((project, opts) => runDomainRemove(project, opts)));
-domain.command("set-base").description("Point the bare {project} hostname at a (version, env)").argument("<project>", "Project name or id").option("--env <env>", "Environment (default: prod)").option("--team <id|name>", "Team the project is in").option("--apiversion <version>", "API version").action(action((project, opts) => runDomainSetBase(project, opts)));
-var tenant = program.command("tenant").description("Manage tenants (consumer scopes) for your team/proxies");
+domain.command("set-base").description("Choose which version/environment your main URL serves").argument("<project>", "Project name or id").option("--env <env>", "Environment (default: prod)").option("--team <id|name>", "Team the project is in").option("--apiversion <version>", "API version").action(action((project, opts) => runDomainSetBase(project, opts)));
+var tenant = program.command("tenant").description("Manage tenants \u2014 separate groups of your API's users");
 tenant.command("list").description("List tenants in your team").option("--team <id|name>", "Team (defaults to active team)").option("--json", "Output machine-readable JSON").action(action((opts) => runTenantList(opts)));
 tenant.command("create").description("Create a tenant in your team").requiredOption("--name <display>", "Display name").option("--slug <tenant_name>", "Explicit tenant slug (generated if omitted)").option("--team <id|name>", "Team (defaults to active team)").option("--json", "Output machine-readable JSON").action(action((opts) => runTenantCreate(opts)));
 tenant.command("attach").description("Attach a tenant to a proxy").argument("<project>", "Project name or id").requiredOption("--tenant <slug>", "Tenant slug to attach").option("--auth-config <id>", "Auth config id to bind").option("--team <id|name>", "Team the project is in").option("--apiversion <version>", "API version").option("--json", "Output machine-readable JSON").action(action((project, opts) => runTenantAttach(project, opts)));
 tenant.command("delete").description("Delete a tenant (full cascade)").argument("<slug>", "Tenant slug to delete").option("--team <id|name>", "Team (defaults to active team)").option("-y, --yes", "Skip the confirmation prompt").action(action((slug, opts) => runTenantDelete(slug, opts)));
 tenant.command("cors").description("Set the CORS allow-list for a tenant").requiredOption("--tenant <slug>", "Tenant slug").option("--origins <list>", 'Comma-separated origins (or "*"); empty clears').option("--team <id|name>", "Team (defaults to active team)").action(action((opts) => runTenantCors(opts)));
-var key = program.command("key").description("Manage control-plane developer keys (consumer-admin) for curl-based management");
+var key = program.command("key").description("Create keys to manage your account from scripts or curl");
 key.command("list").description("List developer keys in your team").option("--team <id|name>", "Team (defaults to active team)").option("--json", "Output machine-readable JSON").action(action((opts) => runKeyList(opts)));
 key.command("mint").description("Mint a consumer-admin developer key (secret shown once)").option("--desc <text>", "Description").option("--expires-days <n>", "Expiry in days (default 90 server-side)").option("--team <id|name>", "Team (defaults to active team)").option("--json", "Output machine-readable JSON").action(action((opts) => runKeyMint(opts)));
 key.command("revoke").description("Revoke a developer key").argument("<keyId>", "Key id (see `key list`)").option("--team <id|name>", "Team (defaults to active team)").action(action((keyId, opts) => runKeyRevoke(keyId, opts)));
-var spec = program.command("spec").description("Inspect / regenerate a proxy OpenAPI spec (author it conversationally with `apiblaze openapi`)");
+var spec = program.command("spec").description("View or update a proxy's OpenAPI spec (or build one by chatting: apiblaze agent openapi)");
 spec.command("get").description("Print the current OpenAPI document").argument("<project>", "Project name or id").option("--team <id|name>", "Team the project is in").option("--apiversion <version>", "API version").option("--json", "Compact JSON output").action(action((project, opts) => runSpecGet(project, opts)));
 spec.command("set").description("Replace the stored OpenAPI spec from a local file").argument("<project>", "Project name or id").requiredOption("--file <path>", "OpenAPI JSON or YAML file to upload").option("--team <id|name>", "Team the project is in").option("--apiversion <version>", "API version").option("--json", "Output machine-readable JSON").action(action((project, opts) => runSpecSet(project, opts)));
-program.command("agent").description("Chat with a producer assistant that can create/manage your proxies, tenants, keys, domains, and specs (billed per turn)").option("--team <id|name>", "Team to operate in (defaults to active team)").action(action((opts) => runAgent(opts)));
 program.addHelpText(
   "after",
   `
 Examples:
-  # No account needed \u2014 create an anonymous proxy, get a claim URL:
-  $ npx apiblaze create --target https://api.example.com
-
-  # Non-interactive (CI / scripts):
-  $ npx apiblaze create --target https://api.example.com --name myapi --json
+  # Just talk to it \u2014 create, configure, inspect your APIs by chatting:
+  $ npx apiblaze agent
 
-  # Sign in, then create under your team:
-  $ npx apiblaze login
-  $ npx apiblaze create --name myapi --target https://api.example.com --auth api_key
+  # Make an API in one line (no account needed; prints a claim URL):
+  $ npx apiblaze create --target https://api.example.com
 
-  # Dev tunnel \u2014 auto-creates a proxy if none point here, and captures
-  # traffic (full headers + body, secrets masked) until your server is up:
+  # Run your localhost through a public URL:
   $ npx apiblaze dev 3000
-  $ npx apiblaze dev 3000 --capture-file traffic.jsonl
 
-  # Manage your proxies (require login; --verbose prints the equivalent API calls):
-  $ npx apiblaze projects
-  $ npx apiblaze target myapi --url https://api.example.com --env prod
-  $ npx apiblaze throttle myapi --rate 50 --quota 100000 --period daily
-  $ npx apiblaze rename myapi --display-name "My API"
+  # Or drive it yourself (add --verbose to see the equivalent API calls):
+  $ npx apiblaze target myapi --url https://api.example.com
+  $ npx apiblaze throttle myapi --rate 50
   $ npx apiblaze domain add myapi --domain api.mysite.com
-  $ npx apiblaze tenant create --name "Acme"   &&  npx apiblaze tenant attach myapi --tenant acme
-  $ npx apiblaze key mint --desc "ci key"
-  $ npx apiblaze spec set myapi --file ./openapi.json
   $ npx apiblaze delete myapi --verbose
-  $ npx apiblaze whoami | team | logout
-
-  # Or just chat (billed per turn):
-  $ npx apiblaze agent
 `
 );
 function printError(err) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apiblaze",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Dev tunnel CLI for APIblaze — route localhost projects through your APIblaze endpoints",
   "keywords": [
     "apiblaze",