@agentshouse/kit 0.1.0-alpha.35 → 0.1.0-alpha.37

package/docs/macos.md

@@ -0,0 +1,26 @@
+# macOS
+
+Run the Linux command from the [README](../README.md#connect-a-computer) in
+Terminal. It works on Apple silicon and Intel Macs, including from a terminal
+running under Rosetta.
+
+## Docker Desktop
+
+Kit on a Mac needs Docker Desktop.
+
+- A Docker Desktop that already answers is used as it is.
+- Other engines, such as Colima or OrbStack, are refused.
+- Without `/Applications/Docker.app`, the command downloads Docker Desktop for
+  your chip and installs it through `sudo`, which asks for your password.
+- The command opens Docker Desktop and waits up to five minutes while you
+  accept its terms or finish what its window asks. If it is still not ready,
+  run the command again.
+
+## Notes
+
+- A `--workspace` directory must be one Docker Desktop shares, such as one
+  under `/Users`.
+- A House on this computer (`--house http://127.0.0.1:<port>`) needs host
+  networking enabled in Docker Desktop's settings.
+
+Everything else works as on [Linux](linux.md).

package/docs/telegram.md

@@ -0,0 +1,29 @@
+# Telegram bot
+
+Kit can connect your own Telegram bot so your House conversations appear there.
+The bot token stays on this computer; House never receives it.
+
+1. Create a bot with BotFather and turn on its Threaded Mode.
+2. Send the bot one ordinary private message outside any topic, so Kit can
+   tell the bot is yours.
+3. Connect it, entering the token at the hidden prompt:
+
+   ```sh
+   kit telegram connect
+   ```
+
+4. Serve it; this keeps running until you stop it:
+
+   ```sh
+   kit telegram serve
+   ```
+
+To release the bot:
+
+```sh
+kit telegram disconnect
+```
+
+Run each command through the connect command as the
+[README](../README.md#run-a-kit-command) shows. Only one computer can serve a
+given bot.

package/docs/windows.md

@@ -0,0 +1,37 @@
+# Windows
+
+Run the Windows command from the [README](../README.md#connect-a-computer) in
+the 64-bit Windows PowerShell. It needs Windows 11 23H2 (build 22631) or later
+on `amd64`. Windows Server, Windows 10 and Windows on ARM are refused.
+
+## WSL 2 and Docker Desktop
+
+- A Docker Desktop that already runs Linux containers on WSL 2 is used as it is.
+- Without WSL, the command runs `wsl --install --no-distribution`. Approve the
+  administrator prompt, restart Windows, and run the command again. An old WSL
+  is updated the same way.
+- Without Docker Desktop, the command downloads it and installs it for your
+  account only, without administrator rights.
+- The command starts Docker Desktop and waits up to five minutes while you
+  accept its terms or finish what its window asks. If it is still not ready,
+  run the command again.
+- Windows containers, the Hyper-V engine and other Docker engines are refused.
+
+## What it creates
+
+- `%USERPROFILE%\.house-kit`: Kit home.
+- `%USERPROFILE%\AgentsHouse`: your workspace. Pass
+  `--workspace 'D:\Agents'` to use another directory.
+
+Both are restricted to your Windows account. A path containing a comma is
+refused.
+
+## Notes
+
+- Append `kit` and a command to run it, as on [Linux](linux.md). Each run
+  leaves its exit status in `$LASTEXITCODE`.
+- When a command asks for a secret, such as a Telegram bot token, keep its
+  output on the terminal: with output redirected, what you type is echoed.
+- A House on this computer needs host networking enabled in Docker Desktop's
+  settings.
+- This bootstrap has not yet been run on a real Windows computer.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agentshouse/kit",
-  "version": "0.1.0-alpha.35",
+  "version": "0.1.0-alpha.37",
   "license": "MIT",
   "repository": {
     "type": "git",