openmates 0.12.0 → 0.14.0-alpha.0

package/README.md

@@ -6,10 +6,12 @@ Terminal CLI and Node.js SDK for OpenMates. Use it to pair-login, create or cont
 
 ```bash
 npm install -g openmates
-openmates chats list
+openmates
 openmates login
 ```
 
+Run plain `openmates` in an interactive terminal to open the full-screen chat UI. Use `/examples` to browse public example chats, type into any example to continue it as a new real or anonymous chat, `/login` for pair-auth, `/signup` for guided account creation, and `/embed <id>` to jump to full embed details. If stdin or stdout is redirected, plain `openmates` prints a script-friendly quickstart instead of entering the TUI.
+
 Without a session, `openmates chats list`, `show`, and `open` display clearly labeled public example chats from the web app. Login uses pair-auth: the CLI shows a QR code or PIN, and you approve it in the web app. To create a new account from the terminal, run `openmates signup`; passwords and recovery secrets are collected through hidden prompts, never command-line flags.
 
 ## First Commands
@@ -19,17 +21,22 @@ openmates whoami --json
 openmates chats list
 openmates chats show example-gigantic-airplanes
 openmates chats new "Help me plan my day"
+openmates chats new "Review @./src/app.ts"
 openmates chats send --chat <chat-id> "continue"
+openmates embeds show <embed-id>
 openmates apps list
 openmates apps ai ask "What is Docker?"
 openmates apps code run --language python --code 'print("Hello")'
 openmates settings account export data --json
+openmates learning-mode status --json
 openmates settings memories list --json
 openmates docs list
+openmates remote-access start --path ./my-repo --source-id repo-1 --local-only
+openmates benchmark model google/gemini-3.5-flash --dry-run --json
 openmates server install
 ```
 
-Run `openmates --help` or `openmates <command> --help` for the full command surface.
+Run `openmates --help` or `openmates <command> --help` for the full command surface. Benchmark commands also support `openmates benchmark --help` for suite, comparison, judge, and spend-confirmation options.
 
 ## Environments
 
@@ -48,13 +55,37 @@ After `openmates server install`, fresh CLI commands default to that self-hosted
 
 Predefined settings commands are supported; raw `settings get/post/patch/delete` passthrough is intentionally unavailable. High-risk or browser-only flows such as passkey management, password changes, API key creation, device approvals, and card checkout stay in the web app. The code-level guard is `BLOCKED_SETTINGS_MUTATE_PATHS` in `src/client.ts`.
 
+`openmates remote-access` is a local Project source bridge. It stores source metadata under `~/.openmates/remote-sources.json`, searches with `rg` inside the approved source root, and does not upload repository files by default.
+
 ## SDK
 
+The package also exports a lazy API-key SDK. Create an API key in OpenMates under Settings > Developers > API Keys, then set `OPENMATES_API_KEY` or pass `apiKey` explicitly. New SDK devices must be approved in Settings > Developers > Devices before API-key calls are allowed.
+
 ```ts
-import { OpenMatesClient } from "openmates";
+import { OpenMates } from "openmates";
 
-const client = OpenMatesClient.load();
-const chats = await client.listChats();
+const om = new OpenMates({ apiKey: process.env.OPENMATES_API_KEY });
+
+const search = await om.apps.web.search({
+  requests: [{ query: "OpenMates SDK examples" }],
+});
 ```
 
-Source docs: `docs/user-guide/cli/` in the OpenMates repository.
+SDK methods authenticate lazily; there is no `connect()` call.
+
+```ts
+const latestChats = await om.chats.list(); // defaults to 10
+const allChats = await om.chats.list({ limit: 0 });
+
+await om.chats.send("Summarize this release note draft.");
+
+await om.chats.send("Create a project kickoff checklist.", { saveToAccount: true });
+
+await om.billing.overview();
+await om.billing.invoices();
+await om.docs.search("api keys");
+```
+
+New SDK chats are non-persistent by default. Use `saveToAccount: true` only when you intentionally want the chat saved to the OpenMates account.
+
+Source docs: `docs/user-guide/developers/sdk.md` in the OpenMates repository.