@maxceem/agw 0.1.8 → 0.1.10

package/README.md

@@ -27,18 +27,26 @@ Add a provider. Paste its API key into the hidden prompt.
 agw provider add --type openai
 ```
 
-Add an app. It uses every provider you have added.
+Add an app. It uses every provider you have added. A server app is created with
+an application key, written to a private file; an iOS app authenticates with
+App Attest instead and ships no key.
 
 ```sh
+agw app add --type server --name "My backend"
 agw app add --type ios --team-id ABCDE12345 --bundle-id com.example.app
 ```
 
-Print the Swift code that calls the gateway from that app.
+Creating an app prints the request it can send. To print it again — as curl for
+a server app, as Swift for an iOS one:
 
 ```sh
-agw app snippet <app-id> --provider openai
+agw app snippet <app-id>
+agw app snippet <app-id> --provider openai   # when several could serve it
 ```
 
+The example is written from the app's own providers and models, and uses named
+placeholders such as `PROVIDER_SLUG` for anything not configured yet.
+
 ## Self-host on Cloudflare
 
 The package drives Wrangler and installs the gateway release of its own version.
@@ -80,7 +88,10 @@ The whole documentation is also published as
 [agents.md](https://docs.appaigateway.com/agents.md).
 
 **Output.** Add `--json` for exactly one JSON document on stdout; progress goes
-to stderr. Add `--no-input` to fail instead of prompting.
+to stderr. Without `--json`, output is plain text and a failure is printed to
+stderr, so stdout carries only the command's own output. Colour is used only
+when the destination is a terminal, and `NO_COLOR` turns it off. Add
+`--no-input` to fail instead of prompting.
 
 ```json
 { "schemaVersion": 1, "ok": true,  "context": { "url": "...", "accountId": "..." }, "result": { } }
@@ -118,14 +129,42 @@ overwritten. `app validate --file` checks a file without touching the account.
 Windows), mode 0700. Do not delete it to fix an authentication error; run
 `agw account login` instead. Output files are never overwritten.
 
-## Contributing
+## Local development
+
+The source lives in `cli/` of the
+[main repository](https://github.com/maxceem/app-ai-gateway). Clone it and run
+`pnpm install`.
+
+From the repository root, `pnpm cli:dev` is `agw` built from your own source
+instead of an installed copy. It rebuilds before every run, so your latest edit
+is always the one that runs.
+
+```sh
+pnpm cli:dev account login
+pnpm cli:dev provider add --type openai
+pnpm cli:dev app list
+```
+
+It keeps its state in `.agw-dev/`, separate from the state an installed `agw`
+uses. To start again from nothing:
+
+```sh
+pnpm cli:dev:reset
+```
+
+Deploying needs the gateway itself built too, once per change to the Worker,
+console or migrations:
+
+```sh
+pnpm --filter @maxceem/agw release:build
+pnpm cli:dev deployment setup --name my-gateway --no-domain
+```
 
-The CLI lives in `cli/` of the
-[main repository](https://github.com/maxceem/app-ai-gateway). From the repo root:
+Type-check and test:
 
 ```sh
-pnpm run cli:check   # type-check and bundle
-pnpm run cli:test    # run the CLI tests
+pnpm run cli:check
+pnpm run cli:test
 ```
 
 ## License