@flow-engineer/flow 0.2.0 → 0.2.1

package/LICENSE

@@ -1,21 +1,202 @@
-MIT License
-
-Copyright (c) 2026 flow-engineer
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -4,7 +4,7 @@
 
 Flow Framework (`npm i @flow-engineer/flow`). Formerly chinwag: see [Moving from chinwag](#moving-from-chinwag).
 
-[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/flow-engineer/flow/blob/main/LICENSE) ![Node 22.18+](https://img.shields.io/badge/node-%3E%3D22.18-brightgreen.svg) ![TypeScript](https://img.shields.io/badge/TypeScript-yes-3178c6.svg)
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://github.com/flow-engineer/flow/blob/main/LICENSE) ![Node 22.18+](https://img.shields.io/badge/node-%3E%3D22.18-brightgreen.svg) ![TypeScript](https://img.shields.io/badge/TypeScript-yes-3178c6.svg)
 
 ![Pip, the café example, in the WhatsApp simulator: a double text folded into one reply, a menu lookup, and the order with reply buttons](https://raw.githubusercontent.com/flow-engineer/flow/main/docs/playground.png)
 
@@ -33,6 +33,17 @@ npm start
 
 `flow new <name>` makes `./<name>/` from the café example (lowercase letters, digits and dashes). Open the link `npm start` prints and text Pip, a café ordering assistant: your starting point. Pick a platform at the top (SMS, WhatsApp, iMessage, Telegram, web), and turn on **Debug** to see every tool call and how fast each message was answered. A model call that fails (a wrong or expired key, say) shows in the chat, in Debug and on the terminal. The café's `src/agent.ts` reads its model id from `CAFE_MODEL` (default: the model for the key you set, see [Models](#models)). The new folder has the coding-agent skills in `.claude/skills/` and an `AGENTS.md` pointing at them, so you can tell Claude Code, Codex or any coding agent what to build.
 
+### On your phone, from your laptop
+
+```bash
+npx @flow-engineer/flow init                 # the same starter in the current folder; then npm install and the model key
+printf 'hi\n' | npx @flow-engineer/flow chat  # talk to it in the terminal: no account
+npx @flow-engineer/flow link                 # signs in (opens the browser), writes its keys into .env, prints a link
+npm start                                    # open the link on your phone and text the agent
+```
+
+`flow chat` builds the agent from `src/agent.ts` and writes as its first test person, one message per line of stdin. `flow link` signs in and runs `flow setup` when the folder is not set up yet, then prints the link for `--channel telegram` (the default), `whatsapp` or `imessage`; a channel flow.engineer cannot open yet answers with what to do instead. With `FLOW_MESSAGING_KEY` in `.env`, the starter's `npm start` is on Telegram, plus WhatsApp and iMessage when `.env` has their senders, and connects to Flow Messaging by its outbound event stream, so there is no tunnel or public URL, and messages sent while it was stopped arrive when it starts again ([flow-messaging/README.md](flow-messaging/README.md)). Coding agents: [docs/agents.md](docs/agents.md) has the exit codes and `next` steps.
+
 ### In a folder of your own
 
 ```bash
@@ -67,7 +78,7 @@ echo "OPENROUTER_API_KEY=sk-or-..." > .env
 node --env-file=.env src/main.ts
 ```
 
-Tests run with `npx flow test` (see [Testing](#testing)); `npx flow --help` lists everything the command does.
+Tests run with `npx @flow-engineer/flow test` (see [Testing](#testing)); `npx @flow-engineer/flow --help` lists everything the command does.
 
 ## How a turn works
 
@@ -356,7 +367,7 @@ expect:
 `expect.calls` and `expect.never` name tools that must or must not be called, checked by code from the recorded calls. `now` and `timezone` set the test's clock, and dates in test files are written against it (`{{now + 1d | date}}`), so they never go stale ([coding-agents/test-skill.md](coding-agents/test-skill.md)). `tests/tools/*.yaml` describe how each tool behaves (normal, slow, each error). Run the suite from the agent's folder:
 
 ```bash
-npx flow test --cloud https://flow.engineer/observe --synthetic --runs 3 --only latte-correction
+npx @flow-engineer/flow test --cloud https://flow.engineer/observe --synthetic --runs 3 --only latte-correction
 ```
 
 Your agent stays on your machine with its own model and key; the test cloud ([get one](#get-a-test-cloud)) plays the person and the tools and judges each run. The cloud is a hosted service, not part of this package. The command prints pass or fail per run, with the judge's reasons, the cost, and a link to watch each conversation. Before anything is sent it reads every test file as the cloud does, and a mistake stops it with the file and line (`tests/scenarios/latte-correction.yaml:3: person.goal: missing`).
@@ -415,20 +426,25 @@ Each run's line carries its id (`FAIL  latte-correction #1 (whatsapp) trn_…: 6
 `--failed` runs again only the scenarios that did not pass in that file (failed, errored or not played), on every channel each plays: a scenario's channels are part of its file, so one channel cannot be picked alone. It goes with `--runs`; with `--only` it stops and says to pick one, since the two would each pick the scenarios. With nothing to run again it prints `Nothing failed in the last session (<id>).` and exits 0 (and says when that session ran only some scenarios); with no file it says to run `flow test` first and exits 1. The loop, for you or a coding agent:
 
 ```bash
-npx flow test --synthetic                    # the whole suite
+npx @flow-engineer/flow test --synthetic           # the whole suite
 # fix what failed
-npx flow show last                           # why: the judge's reasons, the conversation and the tool calls
-npx flow test --synthetic --failed           # only what did not pass; again until it exits 0
-npx flow test --synthetic                    # the whole suite once more before you finish
+npx @flow-engineer/flow show last                  # why: the judge's reasons, the conversation and the tool calls
+npx @flow-engineer/flow test --synthetic --failed  # only what did not pass; again until it exits 0
+npx @flow-engineer/flow test --synthetic           # the whole suite once more before you finish
 ```
 
 ### Get a test cloud
 
+The quick way: `npx @flow-engineer/flow login` (it opens the browser and waits up to 120 s; `npx @flow-engineer/flow login --wait` waits again for the same code, so a coding agent can run it), then `npx @flow-engineer/flow setup` in the agent's folder, which
+writes `FLOW_FRAMEWORK_CLOUD_KEY` (and the traces and Flow Messaging keys, the join code and its
+`FLOW_FRAMEWORK_TRY_URL`, and the shared Telegram, WhatsApp and iMessage senders that are open) into `.env`, filling names `.env` has with no value and setting it to mode 0600; `npx @flow-engineer/flow link` then prints that link to chat with the agent from a phone (and does the sign-in and setup itself when they have not been done). On WhatsApp and iMessage the agent replies only after you write first (WhatsApp: within 24 hours of your last message). The sign-in token is sent only to the server that issued it, over https.
+Always name the package: `npx flow` on its own fetches another npm package. By hand:
+
 1. Sign in at https://flow.engineer/observe (Google, GitHub or an email link).
 2. Workspace → New agent.
 3. On the agent's Developers page, "Make a CI key". It starts with `oci_` and is shown once.
 4. Put it in the agent's `.env` as `FLOW_FRAMEWORK_CLOUD_KEY` (never on the command line).
-5. `npx flow test --cloud https://flow.engineer/observe --synthetic` from the agent's folder (`--cloud` is that address by default).
+5. `npx @flow-engineer/flow test --cloud https://flow.engineer/observe --synthetic` from the agent's folder (`--cloud` is that address by default).
 
 Your agent runs on your machine with your own model key. The cloud's person simulator, tool simulator and judge are free up to $5 a day per workspace, with 2 sessions at once; test data only (`--synthetic`), and records are deleted after 30 days.
 
@@ -533,7 +549,7 @@ For agents with tools we recommend **Claude Haiku 5.5** (`anthropic/claude-haiku
 
 ## With a coding agent
 
-`flow new` puts the skills in your agent's `.claude/skills/`. They are also in [`coding-agents/`](https://github.com/flow-engineer/flow/tree/main/coding-agents): `skill.md` builds an agent, `tools-skill.md` writes tools and their test files, `test-skill.md` writes scenarios. The café in [`examples/cafe`](https://github.com/flow-engineer/flow/tree/main/examples/cafe) is a complete agent with tests to copy from.
+`flow new` and `flow init` put the skills in your agent's `.claude/skills/`; [docs/agents.md](docs/agents.md) is the short guide from `init` to the phone. They are also in [`coding-agents/`](https://github.com/flow-engineer/flow/tree/main/coding-agents): `skill.md` builds an agent, `tools-skill.md` writes tools and their test files, `test-skill.md` writes scenarios. The café in [`examples/cafe`](https://github.com/flow-engineer/flow/tree/main/examples/cafe) is a complete agent with tests to copy from.
 
 ## Roadmap
 
@@ -568,7 +584,7 @@ cd agents/my-agent && npm start
 
 **How is it different from general agent frameworks?** Those give you an agent loop, and a chat is one more thing you build on top. Flow Framework is opinionated about chat: one actor per conversation, double texts folded into one turn, tools that never stall the chat, acknowledgements, channel rules, one person across channels, and schedules built in.
 
-**Which channels are real?** WhatsApp, SMS and your own UI (`customUI`) have production definitions today; you plug in any provider by writing `sendMessage`. iMessage and Telegram are in the playground for now.
+**Which channels are real?** WhatsApp, SMS and your own UI (`customUI`) have production definitions today; you plug in any provider by writing `sendMessage`. Telegram and iMessage are real through Flow Messaging (`fm.telegram()`, `fm.imessage()`, [flow-messaging/README.md](flow-messaging/README.md)); in core they are in the playground for now.
 
 **Does it host my agent?** No. It runs in your Node process, on your machine or servers. You pay your model and messaging providers directly.
 
@@ -582,7 +598,7 @@ Flow Framework was published as `chinwag` up to 0.1.13; from 0.2.0 it is `@flow-
 
 1. `npm uninstall chinwag && npm i @flow-engineer/flow`
 2. Imports: `chinwag` becomes `@flow-engineer/flow`, `chinwag/simulators` becomes `@flow-engineer/flow/simulators`, `chinwag/testing` becomes `@flow-engineer/flow/testing`. The type `ChinwagEvent` is now `FlowEvent` (the old name still works, deprecated).
-3. The command: `npx chinwag ...` becomes `npx flow ...` (in `package.json` scripts too). `chinwag` still runs for this release and says it was renamed.
+3. The command: `npx chinwag ...` becomes `npx @flow-engineer/flow ...`, and `chinwag ...` in `package.json` scripts becomes `flow ...`. `chinwag` still runs for this release and says it was renamed.
 4. Environment: `CHINWAG_CLOUD`, `CHINWAG_CLOUD_KEY`, `CHINWAG_AGENT_TOKEN`, `CHINWAG_TRACES_KEY`, `CHINWAG_TRACES_URL` and `CHINWAG_TRACES_CONTENT` are now `FLOW_FRAMEWORK_CLOUD`, `FLOW_FRAMEWORK_CLOUD_KEY`, and so on. The old names still work; a new name wins when both are set.
 5. Test results now go to `.flow/last-session.json`; `--failed` and `show last` still read `.chinwag/last-session.json` until the first run writes the new one. Add `.flow/` to `.gitignore`. Files the command keeps on this machine (such as a sign-in) go to `~/.config/flow-framework/`; `~/.config/chinwag/` is still read until then.
 6. Coding-agent skills are now `flow-framework`, `flow-framework-tools` and `flow-framework-tests`: copy them again from `node_modules/@flow-engineer/flow/coding-agents/`.
@@ -592,4 +608,4 @@ The test cloud, its address and its API are unchanged, and traces keep their `ch
 
 ## License
 
-[MIT](https://github.com/flow-engineer/flow/blob/main/LICENSE)
+[Apache-2.0](https://github.com/flow-engineer/flow/blob/main/LICENSE)

package/coding-agents/skill.md

@@ -298,6 +298,38 @@ Open `/playground/?token=...` once (it becomes an HttpOnly cookie and leaves the
 with `Authorization: Bearer <token>`. Wrong tokens are limited per address, and every simulated
 message is logged with the person, channel, time and address.
 
+## Put it on a phone
+
+To chat with the agent from the owner's phone, with no tunnel and no key made by hand, run these
+from the agent's folder (`npx @flow-engineer/flow init` makes a starter in an empty one). Only
+`chat` reads stdin; nothing else asks for input or needs a terminal.
+
+```sh
+printf 'hi\nA latte please\n' | npx @flow-engineer/flow chat   # locally, no account: one message per line, replies printed
+npx @flow-engineer/flow link --json          # signs in and runs setup when needed, then the link; give its say_to_person to the owner
+npx @flow-engineer/flow test --synthetic     # the tests, on the key setup wrote
+npm start                                    # the agent; the owner texts it while it runs
+```
+
+`link` runs `login` first when not signed in: it opens the owner's browser itself and prints the
+link and code at once (with `--json` the first line is `{"status":"pending","verification_uri":...,
+"user_code":...,"next":...}`), waits at most 120 s (`--timeout <s>`), then exits 4 with the code
+kept: give the owner the link and code, and run `link` again (it polls the same code). Then it runs
+`setup`, which writes the test cloud, traces and Flow Messaging keys into `.env`, prints names and
+last 4 characters only, keeps values already there (`--replace` takes the new ones), and is safe to
+run again. `--channel telegram|whatsapp|imessage` picks the channel; a channel flow.engineer cannot
+open yet exits 3 with its `next`. `login`, `setup` and `link` also run on their own.
+
+In `src/main.ts`, put `fm.telegram()` from `@flow-engineer/flow/flow-messaging` in the agent's
+channels and call `fm.start(agent, { cursorFile: ".flow/flow-messaging-cursor" })`: with no webhook
+secret it opens Flow Messaging's event stream, an outbound connection, so the laptop needs no public
+URL, and the cursor file lets messages sent while it was stopped arrive when it starts again. The
+starter does this when `.env` has `FLOW_MESSAGING_KEY`. Each error is
+`{"error":{"code","message","next"}}`: run its `next`. Exit codes: 0 done, 1 usage or not signed in,
+2 network, 3 refused, 4 sign-in waiting. Never ask the owner to paste a key into the chat. Always
+name the package (`npx @flow-engineer/flow ...`): `npx flow` on its own fetches another npm package.
+CI never logs in: `setup --ci` says how to give it the cloud key.
+
 ## Send traces to a dashboard
 
 Every turn can go to a traces endpoint as an OTLP/JSON trace, posted to `<url>/v1/traces`, so

package/coding-agents/test-skill.md

@@ -120,7 +120,7 @@ connects out to the cloud, which plays the person and the tools and judges.
 1. Have a test cloud: the hosted one at https://flow.engineer/observe, the default (see "Get a test
    cloud" below), or another with `--cloud <url>` or `FLOW_FRAMEWORK_CLOUD`.
 2. From the agent's folder (it must export `buildAgent` and `tools` from `src/agent.ts`), which reads
-   the agent's `.env` itself: `npx flow test --synthetic [--runs 3]` (`npm test -- --synthetic`
+   the agent's `.env` itself: `npx @flow-engineer/flow test --synthetic [--runs 3]` (`npm test -- --synthetic`
    in an agent `flow new` made).
 3. It first reads every test file as the cloud does; a mistake stops it with
    `tests/scenarios/<file>.yaml:<line>: <field>: <what is wrong>`, one line each, and nothing is sent.
@@ -151,17 +151,17 @@ connects out to the cloud, which plays the person and the tools and judges.
 
 Work in this loop, and never finish on a partial run:
 
-1. `npx flow test --synthetic`: the whole suite.
+1. `npx @flow-engineer/flow test --synthetic`: the whole suite.
 2. Fix what failed (the agent, or a test that asks for the wrong thing; say which).
-3. `npx flow test --synthetic --failed`, again until every run in it passes (exit 0).
-4. `npx flow test --synthetic`: the whole suite once more, since a fix can break another scenario.
+3. `npx @flow-engineer/flow test --synthetic --failed`, again until every run in it passes (exit 0).
+4. `npx @flow-engineer/flow test --synthetic`: the whole suite once more, since a fix can break another scenario.
 
 ### When a run fails
 
-1. `npx flow test --synthetic --json > report.json`, and read the runs whose `verdict` is not
+1. `npx @flow-engineer/flow test --synthetic --json > report.json`, and read the runs whose `verdict` is not
    `passed` (`jq '.runs[] | select(.verdict != "passed")' report.json`).
-2. `npx flow show last` (the first run that did not pass; it names the others) or
-   `npx flow show <runId>`: the checks with the judge's reasons, then the conversation in time
+2. `npx @flow-engineer/flow show last` (the first run that did not pass; it names the others) or
+   `npx @flow-engineer/flow show <runId>`: the checks with the judge's reasons, then the conversation in time
    order with every tool call the simulator played, its input, output and what it changed.
    `--json` gives the whole record.
 3. Decide which is wrong, and say which:
@@ -169,7 +169,7 @@ Work in this loop, and never finish on a partial run:
    - the test: a check asks for the wrong thing, or the scenario cannot reach its goal; fix the YAML;
    - the simulator: a tool output that could not happen, or a person who left the scenario; fix
      `tests/tools/*.yaml` or the scenario's `world` and `person`.
-4. `npx flow test --synthetic --failed`, then `--runs 3 --only <scenario>` on what you fixed, so
+4. `npx @flow-engineer/flow test --synthetic --failed`, then `--runs 3 --only <scenario>` on what you fixed, so
    a pass is not luck.
 5. The whole suite once more.
 
@@ -181,7 +181,7 @@ The owner does these; never ask for the key in chat or print it:
 2. Workspace → New agent.
 3. On the agent's Developers page, "Make a CI key". It starts with `oci_` and is shown once.
 4. Put it in the agent's `.env` as `FLOW_FRAMEWORK_CLOUD_KEY` (never on the command line).
-5. `npx flow test --cloud https://flow.engineer/observe --synthetic` from the agent's folder (`--cloud` is that address by default).
+5. `npx @flow-engineer/flow test --cloud https://flow.engineer/observe --synthetic` from the agent's folder (`--cloud` is that address by default).
 
 Your agent runs on your machine with your own model key. The cloud's person simulator, tool simulator and judge are free up to $5 a day per workspace, with 2 sessions at once; test data only (`--synthetic`), and records are deleted after 30 days. `--synthetic` is the promise that the test files hold no real customer or member data;
 the CLI refuses a hosted cloud without it and the key. `--environment staging` or `production` is
@@ -192,7 +192,7 @@ answers, with the session's own token. `--agent-version` (else `GITHUB_SHA`) and
 GitHub's branch) are kept with the session. A CI step (GitHub Actions shown):
 
 ```yaml
-- run: npx flow test --cloud https://flow.engineer/observe --synthetic --environment staging
+- run: npx @flow-engineer/flow test --cloud https://flow.engineer/observe --synthetic --environment staging
   env:
     FLOW_FRAMEWORK_CLOUD_KEY: ${{ secrets.FLOW_FRAMEWORK_CLOUD_KEY }}
     OPENROUTER_API_KEY: ${{ secrets.OPENROUTER_API_KEY }}

package/dist/flow-messaging/src/client.d.ts

@@ -12,9 +12,15 @@ export declare class FlowMessagingError extends Error {
     /** Worth trying again later: rate limits, Flow's or the channel's 5xx, no answer. */
     get retryable(): boolean;
 }
+/**
+ * One of Flow's object IDs as a URL path segment: `<prefix>_` and letters, digits, `_` or `-` (Flow
+ * makes `<prefix>_<ULID>`). IDs come from inbound events and callers, and every request carries the
+ * key, so anything else (a `/`, `..`, `?`) is refused rather than sent to another path.
+ */
+export declare function idSegment(prefix: string, id: unknown): string;
 export declare class Client {
     private readonly apiKey;
-    private readonly baseUrl;
+    readonly baseUrl: string;
     constructor(options: {
         apiKey: string;
         baseUrl: string;

package/dist/flow-messaging/src/client.js

@@ -32,6 +32,17 @@ export class FlowMessagingError extends Error {
         return this.status === 0 || this.status === 429 || this.status >= 500 || (this.type === "idempotency_conflict" && this.channelCode === "in_progress");
     }
 }
+/**
+ * One of Flow's object IDs as a URL path segment: `<prefix>_` and letters, digits, `_` or `-` (Flow
+ * makes `<prefix>_<ULID>`). IDs come from inbound events and callers, and every request carries the
+ * key, so anything else (a `/`, `..`, `?`) is refused rather than sent to another path.
+ */
+export function idSegment(prefix, id) {
+    if (typeof id !== "string" || !new RegExp(`^${prefix}_[A-Za-z0-9_-]+$`).test(id)) {
+        throw new Error(`not a Flow Messaging ${prefix}_ id: ${JSON.stringify(String(id)).slice(0, 80)}`);
+    }
+    return encodeURIComponent(id);
+}
 export class Client {
     apiKey;
     baseUrl;
@@ -47,9 +58,10 @@ export class Client {
     }
     /** A file's bytes: GET /v1/files/{id} answers them or redirects to a signed URL, which fetch follows without the key. */
     async download(fileId) {
+        const path = `/v1/files/${idSegment("file", fileId)}`;
         if (!this.apiKey)
             throw new Error("set FLOW_MESSAGING_KEY (or pass apiKey) to reach Flow Messaging");
-        const response = await fetch(`${this.baseUrl}/v1/files/${fileId}`, { headers: { authorization: `Bearer ${this.apiKey}`, "flow-version": API_VERSION }, signal: AbortSignal.timeout(60_000) });
+        const response = await fetch(this.baseUrl + path, { headers: { authorization: `Bearer ${this.apiKey}`, "flow-version": API_VERSION }, signal: AbortSignal.timeout(60_000) });
         if (!response.ok)
             throw await errorOf(response);
         return new Uint8Array(await response.arrayBuffer());

package/dist/flow-messaging/src/index.d.ts

@@ -1,4 +1,4 @@
-import type { IncomingMessage, ServerResponse } from "node:http";
+import { type IncomingMessage, type ServerResponse } from "node:http";
 import { type Agent, type Channel, type ChannelInfo, type WhatsAppFeature } from "../../src/index.ts";
 export { API_VERSION, FlowMessagingError, verifySignature } from "./client.ts";
 export interface FlowMessagingOptions {
@@ -12,19 +12,48 @@ export interface FlowMessagingOptions {
 export interface FlowChannelOptions {
     /** The Flow sender (`snd_...`) this channel starts conversations from. Default: FLOW_MESSAGING_<CHANNEL>_SENDER. */
     sender?: string;
-    /** The agent's name for the channel. Default: whatsapp, telegram or sms. */
+    /** The agent's name for the channel. Default: whatsapp, telegram, imessage or sms. */
     name?: string;
     instructions?: string;
 }
-/** What the webhook needs of an agent. */
+/** What the webhook and the stream need of an agent. */
 export type WebhookAgent = Pick<Agent, "message" | "reacted" | "undelivered">;
+export interface StreamOptions {
+    /**
+     * A file that keeps the ID of the last event the agent handled, so a restart resumes after it and
+     * Flow replays what arrived while the agent was away (for as long as the plan keeps events, 30 days
+     * by default). Without it the cursor is in memory: a dropped stream still resumes, a restart starts from now.
+     */
+    cursorFile?: string;
+}
+/** Why the stream stopped for good: Flow refused the key or the request, so reconnecting cannot help. */
+export interface StreamStop {
+    /** The WebSocket close code, such as 4401 (authentication) or 4403 (permission). */
+    code: number;
+    type: string;
+    message: string;
+}
+export interface StreamHandle {
+    /** Closes the stream and waits for the event being handled. */
+    close(): Promise<void>;
+    /** Resolves when Flow refused the stream for good (a bad or revoked key, say); never after close(). */
+    stopped: Promise<StreamStop>;
+}
 /** Telegram as Flow sends it: an inline keyboard of up to 10 buttons (or one link), photos, Markdown, no read receipts for bots. */
 export declare const TELEGRAM: ChannelInfo;
+/**
+ * iMessage as Flow sends it: plain text up to 9999 characters, photos, inline replies, tapbacks
+ * (other emoji go as emoji reactions), typing and read receipts (the whole conversation). No buttons,
+ * lists or templates. No reply window is set: the line only answers people who wrote to it, and a
+ * send it will not deliver comes back as Not delivered (outside_window).
+ */
+export declare const IMESSAGE: ChannelInfo;
 export declare function flowMessaging(options?: FlowMessagingOptions): {
     whatsapp: (o?: FlowChannelOptions & {
         disable?: WhatsAppFeature[];
     }) => Channel;
     telegram: (o?: FlowChannelOptions) => Channel;
+    imessage: (o?: FlowChannelOptions) => Channel;
     sms: (o?: FlowChannelOptions) => Channel;
     webhook: (agent: WebhookAgent) => (req: IncomingMessage, res: ServerResponse) => Promise<void>;
     receive: (agent: WebhookAgent, request: {
@@ -34,4 +63,10 @@ export declare function flowMessaging(options?: FlowMessagingOptions): {
         status: number;
         body: string;
     }>;
+    stream: (agent: WebhookAgent, o?: StreamOptions) => StreamHandle;
+    start: (agent: WebhookAgent, o?: StreamOptions & {
+        port?: number;
+    }) => StreamHandle & {
+        mode: "webhook" | "stream";
+    };
 };