openmates 0.11.0-alpha.3 → 0.11.0-alpha.31

package/README.md

@@ -1,46 +1,51 @@
 # openmates
 
-OpenMates npm CLI + SDK (pair-auth login only).
+Terminal CLI and Node.js SDK for OpenMates. Use it to pair-login, create or continue encrypted chats, run app skills, manage safe account settings, browse docs, and administer self-hosted installs.
 
 ## Install
 
 ```bash
 npm install -g openmates
+openmates chats list
+openmates login
 ```
 
-## Environment
-
-The CLI auto-derives the web app URL from the API URL so the pair token always lands on the right backend.
+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.
 
-| Target               | Command prefix                                                                    |
-| -------------------- | --------------------------------------------------------------------------------- |
-| Production (default) | _(none)_                                                                          |
-| Dev server           | `OPENMATES_API_URL=https://api.dev.openmates.org`                                 |
-| Self-hosted          | `OPENMATES_API_URL=https://api.example.com OPENMATES_APP_URL=https://example.com` |
-
-## CLI Commands
+## First Commands
 
 ```bash
-openmates login
 openmates whoami --json
 openmates chats list
-openmates chats new "Hello"
+openmates chats show example-gigantic-airplanes
+openmates chats new "Help me plan my day"
 openmates chats send --chat <chat-id> "continue"
-openmates apps list --api-key <key>
-openmates apps ai ask "What is Docker?" --api-key <key>
-openmates settings get /v1/settings/export-account-data --json
+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 settings memories list --json
+openmates docs list
+openmates server install
 ```
 
-## Safety Limits
+Run `openmates --help` or `openmates <command> --help` for the full command surface.
 
-The CLI intentionally blocks endpoint writes for:
+## Environments
 
-- API key creation
-- Password setup/update
-- 2FA setup/provider changes
+The CLI derives the web app URL from the API URL so pair-auth lands on the matching backend.
 
-See `src/client.ts` (`BLOCKED_SETTINGS_POST_PATHS`).
+| Target | Command prefix |
+| --- | --- |
+| Production | _(none)_ |
+| Dev server | `OPENMATES_API_URL=https://api.dev.openmates.org` |
+| Self-hosted | `OPENMATES_API_URL=https://api.example.com OPENMATES_APP_URL=https://example.com` |
+
+You can also pass `--api-url <url>` per command. App-skill execution can use your logged-in session, `--api-key <key>`, or `OPENMATES_API_KEY`.
+
+## Safety Limits
+
+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`.
 
 ## SDK
 
@@ -48,4 +53,7 @@ See `src/client.ts` (`BLOCKED_SETTINGS_POST_PATHS`).
 import { OpenMatesClient } from "openmates";
 
 const client = OpenMatesClient.load();
+const chats = await client.listChats();
 ```
+
+Source docs: `docs/user-guide/cli/` in the OpenMates repository.