eraspace 0.1.0 → 0.3.0

package/README.md

@@ -1,6 +1,6 @@
 # eraspace
 
-Build and deploy realtime apps written in TypeScript. The server runs on the BEAM with Postgres storage, live queries
+Build and deploy realtime apps written in TypeScript. The server runs in V8 with Postgres storage, live queries
 and WebSockets; the client is Preact. Apps need no `package.json`, `tsconfig.json` or `node_modules`: the CLI bundles
 the SDK, Preact and TypeScript.
 
@@ -23,16 +23,38 @@ sign in and claim it (`eraspace auth login`, then `eraspace claim`).
 | --- | --- |
 | `new <name>` / `init` | Create an app in a new directory or the current one |
 | `typecheck` | Typecheck `server/`, `client/` and `shared/` |
-| `deploy` | Build the client, compile the server and deploy |
-| `dev` | Deploy, then redeploy on every save |
-| `call <fn> '<json>'...` | Call a query, mutation or action |
-| `logs` | Read handler logs (`--follow` to stream) |
+| `deploy` | Build the client, compile the server and deploy (`--delete-table <table>=<rows>` confirms deleting a removed table; `--shadow` first reruns the app's live queries on the new code and reports which results change or start throwing, and `--fail-on-query-errors` refuses the deploy if any would throw) |
+| `dev` | Deploy, then redeploy whenever `server/`, `client/`, `shared/` or `.env.eraspace.server` change |
+| `call <fn> '<json>'...` | Call a query, mutation or action, each argument a JSON value |
+| `profile [app] --seconds <n>` | Sample the app's server CPU time and write a `.cpuprofile` (TypeScript positions) for Chrome DevTools, printing the top functions by self time (`--out <file>`) |
+| `explain <fn> '<json>'...` | Run a query once and print the rows it scanned and kept, with an index for each scan it filtered in JavaScript (`--json` for the full report) |
+| `logs [app]` | Read handler logs (`--follow` to stream) |
+| `changes` | Print recent committed row changes as NDJSON (`--since <commit>`, `--limit <rows>`) |
+| `undo <commit> --yes` | Put every row changed after a commit back as it was; the undo is a commit too, so it can be undone |
 | `inspect` | Show the schema, functions and deploys |
-| `auth login` / `claim` | Sign in, and take ownership of an unclaimed app |
+| `auth login` / `logout` / `whoami` | Sign in with your browser, sign out, or show who you are |
+| `claim` | Take ownership of this checkout's unclaimed app |
+| `apps` | List your apps |
+| `names` / `names add` / `names rm` | List, add or remove the app's names |
+| `inspection public\|private [app]` | Open or close inspection and logs to everyone |
+| `archive` / `restore [app]` | Stop serving an app and keep its data, or serve it again |
+| `terminate [app] --yes` | Stop an app permanently: its data is kept but it accepts no more deploys |
+| `token create` / `list` / `revoke` | Manage API tokens for one app, or for all your apps with `--personal` |
 
-`eraspace --help` and `eraspace <command> --help` list every flag.
+Commands act on the app bound to the current checkout. Pass `--app <name or id>` or set `ERASPACE_APP` to choose
+another. `eraspace --help` and `eraspace <command> --help` list every flag.
+
+## CI
+
+Create a token with `eraspace token create` (add `--read` for inspection and logs only), then set `ERASPACE_TOKEN` and
+`ERASPACE_TOKEN_API=<platform origin>` in CI. The CLI never sends the token to any other origin.
 
 ## Platform
 
 The CLI deploys to the hosted eraspace platform by default. Set `ERASPACE_URL` or pass `--url` to use another one, such
 as a local platform at `http://localhost:4000`.
+
+## Upgrading from 0.1
+
+0.2 targets the V8 platform and its JSON socket protocol. Apps deployed with 0.1 are not carried over: deploy them
+afresh with 0.2, which also rebuilds their browser bundles against the new SDK.