@kauakdev/kauak 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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

@@ -1,3 +1,187 @@
-# Temporary Holding Version
+# Kauak
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+![Kauak](packages/web/public/kauak-banner.png)
+
+Kauak is a Sims-style isometric office that shows what your coding agents are
+doing, live. It connects to [Herdr](https://herdr.dev), a terminal multiplexer
+for coding agents, and turns each machine into a floor, each repository into a
+wing, each workspace into a room and each pane into a desk, with someone at it
+when an agent runs there. You see at a glance who is working, who is on a break
+and who is waiting for you, and you click a desk to read that agent's terminal
+and answer it.
+
+![An office of simulated agents, in the Alpine basecamp look](docs/appearance/basecamp.jpg)
+
+## Why
+
+With several agents running at once, across repositories and machines, most of
+the work is noticing which one needs you. A list of panes does not make that
+easy. In Kauak a blocked agent raises its hand and its room pulses red, a
+finished one shows a hopping ✓, and an idle one goes for a drink. When one
+needs an answer, you give it from the office instead of hunting for the right
+tab.
+
+## Quick start
+
+You need Node.js 22 or newer, and Herdr (0.9.x) running on this machine.
+
+```sh
+npx @kauakdev/kauak serve
+```
+
+The office opens at http://127.0.0.1:7788. The package carries the built page,
+so there is nothing to clone or build. `npx @kauakdev/kauak serve --demo` shows
+simulated agents without Herdr, and `npx @kauakdev/kauak serve --help` lists the
+options.
+
+To keep the `kauak` command around, install it globally instead:
+
+```sh
+npm install -g @kauakdev/kauak
+kauak serve
+```
+
+## Run from source
+
+You need Node.js 22.18 or newer and [pnpm](https://pnpm.io).
+
+```sh
+git clone https://github.com/kauakdev/kauak.git
+cd kauak
+pnpm install
+pnpm dev
+```
+
+`pnpm dev` runs the bridge on port 7788 and the page on http://localhost:5178,
+which reloads as you edit. Add `?demo` to the URL for simulated agents.
+`pnpm build && pnpm start` runs the built page the way the npm package does.
+[CONTRIBUTING.md](CONTRIBUTING.md) has the checks and conventions.
+
+## What you can do
+
+- **Watch**: each agent's state (working, idle, blocked, done) drives its
+  animation, the roster and the activity feed. The tab title counts blocked
+  agents.
+- **Answer**: click a desk to open a mirror of its terminal, and type in the
+  message box under it to reply, accept a prompt or run a command. In a Claude
+  Code or Codex pane, `/` lists the agent's slash commands.
+- **Track context**: Claude Code and Codex agents get a meter showing
+  how full their context window is.
+- **Read edits as they happen**: each room's printer prints the diff of every
+  file edit in its checkout, and shows everything not yet committed.
+- **Build**: add desks (new Herdr tabs, with or without an agent) and rooms
+  (new git worktrees or folders) from the office.
+- **Go remote**: add other machines that run Herdr as floors, over SSH.
+  Nothing is installed on them.
+- **Make it yours**: pick the Classic office, the Orbital workshop or the
+  Alpine basecamp, a background, and a company banner for the wall.
+
+The [guide](docs/guide.md) covers all of it, keyboard shortcuts included.
+
+## Kauak and Herdr
+
+[Herdr](https://herdr.dev) ([source](https://github.com/herdrdev/herdr)) owns
+your agents' terminals: the panes and workspaces they run in, on this machine
+and others, and it knows what state each agent is in. Kauak runs none of that.
+It is a separate project that talks to Herdr through Herdr's
+[local socket API](https://herdr.dev/docs/socket-api/): it follows Herdr's
+events, reads session snapshots and pane screens, and asks Herdr to send text
+and keys, create tabs and worktrees, and start agents when you do those things
+in the office. So Kauak needs a running Herdr; without one, only the demo
+works. Other machines are reached through an SSH tunnel to their Herdr socket.
+
+Kauak is an independent project. It is not affiliated with or endorsed by
+Herdr, and it would not exist without it.
+
+## Architecture
+
+```
+Herdr (a unix socket on each machine; through an SSH tunnel for a remote one)
+   │  Herdr's API
+   ▼
+Herdr adapter    packages/bridge/src/runtimes/herdr/ (machine.ts, herdr.ts)
+   │  Kauak terms, the Runtime port
+   ▼
+Bridge           packages/bridge/src/ (core/, enrichers/, transport/ws.ts)
+   │  the Kauak protocol, over a WebSocket
+   ▼
+Page             packages/web/
+```
+
+- **Herdr adapter** (`packages/bridge/src/runtimes/herdr/machine.ts`,
+  `packages/bridge/src/runtimes/herdr/herdr.ts`): one per floor. It talks to
+  Herdr's socket, here or through an SSH tunnel, and translates Herdr's
+  snapshots and errors into Kauak's own. Herdr-specific code lives only here.
+- **Kauak protocol** (`packages/protocol/src/index.ts`, TypeScript): the JSON
+  messages between the page and the bridge, described in
+  [docs/protocol.md](docs/protocol.md). The bridge checks every message from a
+  page against it.
+- **Bridge** (`packages/bridge/`, Node, TypeScript): its core
+  (`packages/bridge/src/core/`) holds the floors and answers each message from
+  a page, `packages/bridge/src/transport/ws.ts` serves the page and the
+  WebSocket on 127.0.0.1:7788, and its enrichers
+  (`packages/bridge/src/enrichers/`) add what Herdr does not report: context
+  usage, read from the agents' transcripts, and file diffs, from git.
+- **Page** (`packages/web/`, TypeScript, PixiJS, xterm.js, built with Vite):
+  lays each snapshot out as floors and rooms, draws the office, and holds the
+  roster, activity feed, terminal panel and build mode. For the demo,
+  `packages/web/src/bridge/demo.ts` speaks the protocol with no bridge at all.
+- **CLI** (`packages/kauak/bin/kauak.js`, `packages/kauak/cli/`): the `kauak`
+  command, one module per command in `packages/kauak/cli/commands/`.
+- **Appearance packages** (`packages/appearance/`): offices and
+  characters as declarative JSON, validated before use. See the
+  [appearance and banner guide](docs/appearance/README.md).
+
+[How Kauak works](docs/architecture.md) goes into the details.
+
+## Configuration, security and privacy
+
+The bridge can type into your terminals, create worktrees and open SSH
+connections, so it listens on 127.0.0.1 only and accepts WebSocket connections
+only from pages served by this computer. The environment variables
+(`HERDR_SOCKET_PATH`, `KAUAK_PORT`, `KAUAK_HOST`, `KAUAK_ORIGINS`,
+`KAUAK_CONFIG`, `KAUAK_SSH`), remote floors and opening the office from another
+device are in [docs/configuration.md](docs/configuration.md); the threat model
+and how to report a vulnerability are in [SECURITY.md](SECURITY.md).
+
+The page talks only to the bridge, with one exception: the radio. It is off
+until you turn it on; then it plays CLIAMP Lofi straight from
+[cliamp.stream](https://cliamp.stream), and your browser connects to it
+directly.
+
+## Where it's going
+
+Kauak 0.1 is its first version. Next up:
+
+- Sprites in place of the procedurally drawn furniture and people, one piece at
+  a time.
+
+Herdr is the only runtime today. The Kauak protocol keeps it behind an adapter,
+so that another runtime could be added later. Protocol versioning, incremental
+updates and a way for a runtime to say what it supports were left out on
+purpose for now; they are possible next steps, not commitments (see
+[docs/protocol.md](docs/protocol.md#another-runtime)).
+
+## Contributing
+
+Issues and pull requests are welcome: see [CONTRIBUTING.md](CONTRIBUTING.md).
+Report vulnerabilities privately, as [SECURITY.md](SECURITY.md) describes.
+
+## License
+
+[Apache 2.0](LICENSE). The build writes the licenses of the packages bundled
+into the page to `dist/THIRD_PARTY_LICENSES.txt`, which ships with the npm
+package and the demo.
+
+Artwork: the logo (`packages/web/public/kauak.png`) and banner
+(`packages/web/public/kauak-banner.png`) were generated for Kauak with OpenAI's
+ChatGPT image generation, and both files carry C2PA metadata saying so. The
+contour-map background (`packages/web/src/appearance/backgrounds/contours.svg`)
+appears to be programmatically generated: evenly spaced concentric rings with no
+geographic reference. No map or elevation data is known to have been used.
+
+**Name and logo.** The Apache License 2.0 does not grant permission to use the
+Kauak name, logo or banner as trademarks (section 6). Forks and redistributions
+are welcome, and so is saying that your project is based on Kauak, but do not
+present a modified version as the official Kauak or as endorsed by its
+maintainers.

package/bin/kauak.js

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+// The `kauak` executable (`npx @kauakdev/kauak <command>`, or `kauak <command>`
+// after `npm install -g @kauakdev/kauak`). The command line itself is in
+// cli/main.js.
+
+import { main } from "../cli/main.js";
+
+// A command that keeps running (`serve`) returns nothing and the process ends
+// on Ctrl+C; the others return their exit code. Exiting here also stops a
+// bridge that started but could not serve the page.
+const code = await main(process.argv.slice(2));
+if (code !== undefined) process.exit(code);

package/bridge/config.js

@@ -0,0 +1,34 @@
+import os from "node:os";
+import path from "node:path";
+function resolveConfig(env, flags = {}) {
+  const home = os.homedir();
+  return Object.freeze({
+    port: Number(flags.port ?? env.KAUAK_PORT ?? 7788),
+    // The bridge can type into terminals, create panes and worktrees, and open SSH
+    // connections, so by default only this computer may connect, and only pages
+    // served from it.
+    host: env.KAUAK_HOST ?? "127.0.0.1",
+    origins: Object.freeze([
+      "localhost",
+      "127.0.0.1",
+      "[::1]",
+      ...(env.KAUAK_ORIGINS ?? "").split(",").map((h) => h.trim()).filter(Boolean)
+    ]),
+    machinesFile: env.KAUAK_CONFIG ?? defaultMachinesFile(home),
+    herdrSocket: env.HERDR_SOCKET_PATH ?? env.HERDR_SOCKET ?? path.join(home, ".config", "herdr", "herdr.sock"),
+    sshCommand: env.KAUAK_SSH ?? "ssh",
+    tunnelDir: path.join(os.tmpdir(), `kauak-${process.getuid?.() ?? "user"}`),
+    claudeDir: env.CLAUDE_CONFIG_DIR ?? path.join(home, ".claude"),
+    codexDir: env.CODEX_HOME ?? path.join(home, ".codex"),
+    pageDir: flags.pageDir ?? null,
+    // Set but blank is unset: path.resolve("") would serve the .json files of the bridge's working folder.
+    appearanceDir: env.KAUAK_APPEARANCES || path.join(home, ".config", "kauak", "appearances"),
+    appearanceFiles: Object.freeze([...flags.appearanceFiles ?? []])
+  });
+}
+function defaultMachinesFile(home) {
+  return path.join(home, ".config", "kauak", "machines.json");
+}
+export {
+  resolveConfig
+};