@agentshouse/kit 0.1.0-alpha.36 → 0.1.0-alpha.38

package/docs/linux.md

@@ -0,0 +1,71 @@
+# Linux
+
+Run the Linux command from the [README](../README.md#connect-a-computer) in a
+terminal. It needs `bash`, `curl` and Docker Engine.
+
+## Docker Engine
+
+- A Docker Engine that already answers is used as it is, on any distribution.
+- On Ubuntu 22.04, 24.04 or 26.04 LTS, anything missing is installed from
+  Docker's own apt repository through `sudo`, which asks for your password.
+  The command starts the `docker` service and adds you to the `docker` group.
+- Ubuntu packages that conflict with Docker's (`docker.io`, `docker-compose`,
+  `docker-compose-v2`, `docker-doc`, `docker-buildx`, `podman-docker`,
+  `containerd`, `runc`) are not removed for you: remove them and run again.
+- On any other distribution, install Docker Engine first.
+
+A new `docker` group membership applies from your next sign-in. If a later run
+says so, sign out and back in, then run the command again.
+
+## What it creates
+
+- `~/.house-kit`: Kit home, with your credential and `kit.json`.
+- `~/AgentsHouse`: your workspace, mounted in the container as
+  `/agents/house`. Pass `--workspace /absolute/path` to use another directory.
+
+Both are readable only by you. The credential is never printed.
+
+## Updating
+
+Run a newer release's command. While an Agent session is still running, the
+update names it and leaves Kit as it is; run the command again once it ends.
+Your credential, Kit home and workspace are kept.
+
+## Pushing a working copy
+
+From a directory under your workspace, such as a Room copy under
+`working-copies/rooms/`, run:
+
+```sh
+bash <(curl -fsSL …/connect-linux.sh) house git push --owner
+```
+
+## A House on this computer
+
+`--house http://127.0.0.1:<port>` or `--house http://localhost:<port>` runs Kit
+on the host network so it can reach a House served on this computer.
+
+## An Always-on server that hosts containers
+
+An Always-on Ubuntu server that will run persistent container Environments
+connects natively instead of in a container. Run the command with `--linux`:
+
+```sh
+bash <(curl -fsSL …/connect-linux.sh) --linux
+```
+
+It needs Ubuntu 26.04 LTS on `amd64`; any other host is refused. Every other
+computer takes the ordinary command. It sets up:
+
+- Docker Engine, as above, and `git` and `tmux` from Ubuntu's apt repository.
+- `/opt/house-kit`: House Kit and the Node.js it runs on, copied from the
+  release's image and owned by root.
+- `~/.house-kit`: Kit home, readable only by you.
+- `/agents/house`: your Agents' workspace, readable only by you.
+- `house-kit.service`: the systemd service that runs Kit as you and starts it
+  with the server.
+
+The server connects as a continuous Environment. Put `--linux` before `kit` or
+`house` to run a Kit command, as in
+`bash <(curl -fsSL …/connect-linux.sh) --linux kit apply`, and run a newer
+release's command with `--linux` to update it, as above.

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,36 @@
+# 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`.
+- A command whose output is redirected also writes its prompts and errors there.
+- 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.36",
+  "version": "0.1.0-alpha.38",
   "license": "MIT",
   "repository": {
     "type": "git",