@getoatmilk/cli 0.3.5 → 0.3.7

package/README.md

@@ -22,17 +22,32 @@ GitHub release also has standalone binaries for macOS, Linux and Windows that do
 checksums.
 
 `oatmilk update` installs the newest version the way oatmilk was installed. When one is out, the app shows `↑ 0.3.0 ⌃U`
-at the top right; `⌃U` installs it. `oatmilk update auto|notify|off` chooses whether it updates by itself.
+at the top right; `⌃U` installs it. `oatmilk update auto|notify|off` chooses whether it updates by itself. The app
+doesn't look by itself when everything runs on this computer, and never with `--offline`.
 
 ## First run
 
 The first time you run `oatmilk`, it asks one question: how you want to use Oatmilk.
 
+After sign-in, review **Models and data** for your workspace, one step at a time. People upgrading an already
+signed-in CLI also see this review. You can choose an existing company, create one, or open a personal workspace.
+Administrators choose shared AI defaults and the data-placement plan. Each computer keeps its own local model
+connection. The screen shows **Books** and **AI** separately, so local AI with online books is clear.
+
+Press **Ctrl+K** and search for `local`, `models`, `offline` or `setup` to find these settings. Use `oatmilk settings`
+for a text readout or `oatmilk settings setup` to review them again. A local-only model choice stops when that model
+is unavailable; it never falls back to an online model. Chat titles come from the first message without an AI call.
+
+To move existing data, sign in to both installations and run `oatmilk migrate plan --to <host> --to-org <id>`.
+The job copies and verifies records and files before cutover, and can resume after an interruption. Changing a
+setting alone keeps the books where they are. The source copy is retained until you separately close it.
+
 | Choice | What it does |
 | --- | --- |
-| **Sign in to Oatmilk** | Your account at getoatmilk.com, nothing to install. When Ollama or LM Studio runs a model that calls tools, it offers to run Ask AI on it, so your questions stay on this computer while your books stay in Oatmilk. |
-| **Keep everything on this computer** | Your account, books, files and every model here, with no sign-up. Needs Docker; the first start takes about 10 minutes. |
-| **More options** | Choose for each part (sign-in, books, files, Ask AI and agents, classifiers, reading documents, email, web research: here, in the cloud, or off), your own cloud services with AI here, or an Oatmilk your team runs. |
+| **Sign in to Oatmilk** | Use your Oatmilk account. Nothing to install. When Ollama or LM Studio runs a model that calls tools, it offers to run Ask AI on it, so your questions stay on this computer while your books stay in Oatmilk Cloud. |
+| **Make an Oatmilk account** | New here? Make one in your browser, then come back and sign in. You may wait on a short waitlist; the app says so, and `r` checks again. |
+| **Keep everything on this computer** | No account needed. Needs Docker, Bun and Ollama or LM Studio; the first start takes about 10 minutes. Setup checks for them before it asks anything, and `⌃C` stops it. |
+| **More options** | Choose for each part (sign-in, books, files, Ask AI and agents, classifiers, reading documents, email, web research: here, with your own cloud services, or off), your own cloud services with AI here, or an Oatmilk your team runs. |
 
 Every step shows where you are (`2/5`), and the setup says how local it is in words (`85% local`). For the local
 choices, setup finds Ollama or LM Studio, picks models that fit (a chat model that calls tools and reads images, and a
@@ -52,16 +67,32 @@ oatmilk models                                  # Ollama and LM Studio here, and
 oatmilk models test | pull tev1 | use --models lmstudio --restart
 ```
 
-Running it locally needs Docker and [Bun](https://bun.sh), and Oatmilk's source: setup uses the checkout you're in, or
-downloads one with git. Cloud keys for a mix (Clerk, PostgreSQL, S3, AI Gateway, Resend, Tavily) are asked for in the
+Running it locally needs Docker and [Bun](https://bun.sh), and Oatmilk's source: setup uses the checkout you're in (or
+`--source <folder>`), or downloads one with git. Cloud keys for a mix (Clerk, PostgreSQL, S3, AI Gateway, Resend, Tavily) are asked for in the
 setup screens, or read from the environment with `--yes`. They're kept only in the local Oatmilk's own settings file.
 
+## Send email
+
+Oatmilk Cloud sends its own email. An Oatmilk you run sends it with [Resend](https://resend.com): make an API key at
+resend.com/api-keys and verify the domain you send from at resend.com/domains, then:
+
+```sh
+oatmilk email use resend --from mail.example.com   # paste the key when asked; it never shows on screen
+oatmilk email test you@example.com                  # send a test and wait to see it leave
+oatmilk email                                       # who sends it, from where, and the last email
+oatmilk email off                                   # stop sending (the saved key goes too)
+```
+
+The key is kept only in that Oatmilk's settings file. On a server set up with `bun run self-host setup`, run it in the
+Oatmilk folder there, or pass `--source <folder>`.
+
 ## Sign in
 
 ```sh
+oatmilk signup             # no account yet: make one in your browser, then sign in here (or: login --new)
 oatmilk login              # opens your browser; approve, then come back to the terminal
 oatmilk login --device     # SSH or no browser: sign in on any device, paste back the code
-oatmilk login --api-key    # paste an API key from Settings › Developer (or pipe it in)
+oatmilk login --api-key    # paste an API key from Developers › API keys (or pipe it in)
 oatmilk whoami             # who, which company, which permissions
 oatmilk orgs use "Contoso" # switch company
 oatmilk login --password   # an account on your own Oatmilk, with its email and password
@@ -71,6 +102,10 @@ oatmilk logout             # sign out and revoke the token
 On an Oatmilk that setup made on this computer, the terminal signs itself in with the account's saved password.
 `oatmilk logout` forgets that password too, so you stay signed out until `oatmilk login --password`.
 
+Oatmilk Cloud may put a new account on a short waitlist. Until you're in, `oatmilk login` keeps you signed in and says
+you're on the waitlist (or gives you the form at `https://app.getoatmilk.com/join` to ask for access), and the app
+shows the same with `r` to check again.
+
 Browser sign-in is the same OAuth flow AI apps use for Oatmilk's MCP server: the CLI registers itself once, signs in
 with PKCE through a one-time redirect to `localhost`. Your role in each company still decides what you can do. Tokens
 refresh on their own. They are saved in `~/.config/oatmilk/credentials.json` (`%APPDATA%\oatmilk` on Windows), readable only by
@@ -206,7 +241,7 @@ claude mcp add oatmilk -- npx -y @getoatmilk/cli mcp
 | --- | --- |
 | `--local` | Use the Oatmilk on this computer, starting it if it's stopped. |
 | `--cloud` | Use Oatmilk Cloud. |
-| `--offline`, `OATMILK_OFFLINE=1` | Refuse any Oatmilk on the internet: only this computer and its network. |
+| `--offline`, `OATMILK_OFFLINE=1` | Refuse any Oatmilk on the internet: only this computer and its network. No update checks either. |
 | `--setup`, `--no-setup` | Show the first-run setup again, or never. |
 | `--no-start` | Don't start a stopped local Oatmilk. |
 | `--no-ai` | The app without Ask AI; `exec` refuses to run. |