Multi-Agent Collaboration for Team and Friends
TypeScript agent-automationagent-orchestrationagent-workflowai-agentsai-collaborationai-memoryai-workforceautonomous-agentsclaude-codeclaude-code-skillscodexcoding-agentmulti-agentmultiple-agentone-person-businessone-person-companyone-person-teamopencodesolopreneur
docs: refresh README artwork and explain monorepo structure
Gus2a8a64074786
diff --git a/README.md b/README.mdindex f97abb8b1..2d0df4750 100644--- a/README.md+++ b/README.md@@ -7,6 +7,7 @@<a href="https://github.com/alookai/alook/actions"><img src="https://github.com/alookai/alook/actions/workflows/ci.yml/badge.svg" alt="CI" /></a><a href="https://codecov.io/gh/alookai/alook"><img src="https://codecov.io/gh/alookai/alook/branch/main/graph/badge.svg" alt="codecov" /></a><a href="https://www.npmjs.com/package/@alook/app"><img src="https://img.shields.io/npm/v/@alook/app.svg" alt="npm version" /></a>+ <a href="https://alook.ai/c"><img src="./assets/readme/alook-join.svg" alt="Alook Join" /></a><a href="https://discord.alook.ai"><img src="https://img.shields.io/badge/Discord-Join%20us-5865F2?logo=discord&logoColor=white" alt="Discord" /></a></p>@@ -139,6 +140,18 @@ flowchart TBSee [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to get involved.+### Monorepo structure++Alook is a monorepo, with code grouped by responsibility under `src/`:++| Area | Directories and responsibilities |+| --- | --- |+| Apps | `web/` — web UI and API, plus `web/blog/`; `desktop/` — native app shell; `app/` — local self-hosting CLI. |+| Agent runtime | `daemon/` — agent process management and host connection; `daemon/agent-driver/` — AI backend session adapters. |+| Cloud workers | `ws-do/` — realtime WebSocket connections; `email-worker/` — email handling; `queue-worker/` — queued agent wake-ups. |+| Shared code | `shared/` — types, database schema, queries, and validation. |+| Tooling & media | `benchmark/` — browser performance benchmarks; `videos/` — standalone video projects. |+## Communitydiff --git a/assets/readme/alook-join.svg b/assets/readme/alook-join.svgnew file mode 100644index 000000000..4085c46c5--- /dev/null+++ b/assets/readme/alook-join.svg@@ -0,0 +1 @@+<svg xmlns="http://www.w3.org/2000/svg" width="89" height="20" role="img" aria-label="Alook: Join"><title>Alook: Join</title><filter id="blur"><feGaussianBlur stdDeviation="16"/></filter><linearGradient id="salook-join" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="ralook-join"><rect width="89" height="20" rx="3"/></clipPath><g clip-path="url(#ralook-join)"><rect width="58" height="20" fill="#555"/><rect x="58" width="31" height="20" fill="#ff9915"/><rect width="89" height="20" fill="url(#salook-join)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><image x="5" y="3" width="14" height="14" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAC9ElEQVR4Ae3AA6AkWZbG8f937o3IzKdyS2Oubdu2bdu2bdu2bWmMnpZKr54yMyLu+Xa3anqmhztr1a/y34vKv4O/68HHmZavRfqluZ/it6Fd0gee/Wv+ZYh/A3/Xg48zHH4W8NG8YH+N4rvpFt+j97l1l+cP8a/kb7vutcn8LvCDeZHoViLeRx9wz2/zvBD/An/XdQ9maK8FvDTw2sBL828SH6MPuvereU6IF8Dfdt1rk+2rgJfmP4p4H33g2e/m2RDPxd/14OMMR98Ffmv+U+ht9EH3/TRXIB7A3/Xg4wyHvwW8NP9pdCv9xsvofW7dBQgeaDz8KeCl+U/lBzMefjZXEDyTv/XMe2Nem/8K5r24guB+1mfxLzn14vDmPwVv+N1w6sV5Hq/yefDmPwUv9wn8C477W8+8N0AA+FvPvDf4wfxL3vyn4IZX42t+5snsvvTn8xxe4oPgJT6I337SyE/f/gi4/tV44fTWAAGA9dq8KGbH+O3f/m0++qM/mq/+jh/nOfQ7AHz2Z382b/M2bwPbN/NC2a8FIAB/y5mLwHH+JY98Z3jtr+Wrv+KLee+H/C3Hz/06z9Ifg7f4aX77786y+7Q/5q2nr+Rf1JeHCMDfcsb8d4jyOuFvPfPS/Dvdej55n+/ZRx90llvPJ/8KVFSO48a/xnt/9z7PuJAA3Hq+ceu5xrFF8FlvvsmDTwX/ClT+Dd76pWf89pNG/vr2ifd65TkPPl1465fqOb4h/pWo/Bu89Uv3vPVL9/wHoPLfi8p/LyqZr81/H4KI3+a/D5X/RvqAe3479AH3/DboGfyX0zMAAgD01fzX+26AANAH3fvVoO/hv4z+hn7jqwGCZ9IH3ffeEB/Dfzr9DX28td7n1l0A8Vz8Xdc9mCHfG/zRwDH+41wCfTX9xlfrfW7d5QrEC+Fvu+61cXtrzEuDHgx+EP8qegbw28i/Tbf503qfW3d5Toh/JX/bda/N/dwejPVgAORbUbmVZ9IH3PPb/MsQ/734R5Ji0ZCzMywFAAAAAElFTkSuQmCC"/><g transform="scale(.1)"><g aria-hidden="true" fill="#010101"><text x="385" y="150" fill-opacity=".8" filter="url(#blur)" textLength="310">Alook</text><text x="385" y="150" fill-opacity=".3" textLength="310">Alook</text></g><text x="385" y="140" textLength="310">Alook</text></g><g transform="scale(.1)"><g aria-hidden="true" fill="#010101"><text x="725" y="150" fill-opacity=".8" filter="url(#blur)" textLength="210">Join</text><text x="725" y="150" fill-opacity=".3" textLength="210">Join</text></g><text x="725" y="140" textLength="210">Join</text></g></g></svg>diff --git a/assets/readme/banner.png b/assets/readme/banner.pngindex f085e3856..f75efa87e 100644Binary files a/assets/readme/banner.png and b/assets/readme/banner.png differdiff --git a/assets/social-preview/readme-banner.html b/assets/social-preview/readme-banner.htmlindex d4452cc02..58ec3f7bf 100644--- a/assets/social-preview/readme-banner.html+++ b/assets/social-preview/readme-banner.html@@ -107,7 +107,7 @@ body {align-items: center;justify-content: flex-end;overflow: visible;- zoom: 0.72;+ zoom: 0.78;height: 460px;}@@ -133,7 +133,7 @@ body {z-index: 2;perspective: 2500px;transform-style: preserve-3d;- transform: rotateY(-14deg) rotateX(8deg);+ transform: rotateY(-20deg) rotateX(10deg);}.tw-machine {@@ -168,6 +168,16 @@ body {opacity: 1;}+.tw-paper.tw-paper-city {+ padding: 8px 8px 24px;+}++.tw-city-art {+ display: block;+ width: 100%;+ aspect-ratio: 16 / 9;+}+.tw-body {position: relative;width: 100%;@@ -296,22 +306,6 @@ body {.tw-bar-long { width: 210px; }.tw-bar-short { width: 170px; }-.tw-email-headers {- font-family: 'VT323', monospace;- font-size: 15px;- color: oklch(0.45 0.01 55);- line-height: 1.7;- border-bottom: 1px solid oklch(0.15 0.01 55 / 10%);- padding-bottom: 10px;- margin-bottom: 12px;-}-.tw-email-line span { color: oklch(0.15 0.01 55); }-.tw-email-body {- font-family: 'VT323', monospace;- color: oklch(0.45 0.01 55);- font-size: 17px;- line-height: 1.6;-}</style></head><body>@@ -338,15 +332,8 @@ body {<div class="tw-body-bottom"></div><div class="tw-body-front"><div class="tw-paper-track">- <div class="tw-paper">- <div class="tw-email-headers">- <div class="tw-email-line">HOME / FAMILY-PLANS</div>- <div class="tw-email-line"><span>Maya joined the room.</span></div>- <div class="tw-email-line">A note for Alli#8145</div>- </div>- <div class="tw-email-body">- Maya and Alli now share this channel. Either can reply here, and Gus can catch up when he returns.- </div>+ <div class="tw-paper tw-paper-city">+ <img class="tw-city-art" src="./typewriter-city-art.png" alt="A giant Alook sculpture in an ASCII city" /></div></div><div class="tw-roller-assembly">diff --git a/assets/social-preview/typewriter-city-art.png b/assets/social-preview/typewriter-city-art.pngnew file mode 100644index 000000000..833f2e720Binary files /dev/null and b/assets/social-preview/typewriter-city-art.png differdiff --git a/package.json b/package.jsonindex 770e93bc8..6ab76ddcb 100644--- a/package.json+++ b/package.json@@ -40,6 +40,8 @@"typegrep:ws": "node scripts/lint-ws-events.mjs","typegrep:agent-driver": "node scripts/check-agent-driver-boundaries.mjs","logo:generate": "node scripts/generate-logo-assets.mjs",+ "readme:badges": "node scripts/generate-readme-badges.mjs",+ "readme:badges:test": "node --test scripts/generate-readme-badges.test.mjs","readme:capture": "node src/web/readme-capture/capture.mjs","prepare": "simple-git-hooks"},@@ -48,6 +50,7 @@},"devDependencies": {"@vitest/coverage-istanbul": "4.1.11",+ "badge-maker": "6.0.0","sharp": "^0.35.4","simple-git-hooks": "^2.14.0","turbo": "^2.11.3",diff --git a/pnpm-lock.yaml b/pnpm-lock.yamlindex a55135746..bba72f8b1 100644--- a/pnpm-lock.yaml+++ b/pnpm-lock.yaml@@ -20,6 +20,9 @@ importers:'@vitest/coverage-istanbul':specifier: 4.1.11version: 4.1.11([email protected])+ badge-maker:+ specifier: 6.0.0+ version: 6.0.0sharp:specifier: ^0.35.4version: 0.35.4(@types/[email protected])@@ -4587,6 +4590,9 @@ packages:resolution: {integrity: sha512-Thbli+OlOj+iMPYFBVBfJ3OmCAnaSyNn4M1vz9T6Gka5Jt9ba/HIR56joy65tY6kx/FCF5VXNB819Y7/GUrBGA==}+ resolution: {integrity: sha512-Nlfq7NC4AOkTJerWRIZcOAiMNtIDVIGWGvQ98O7Jl6Kr2Dk0dX5u4MqN778kSRTy5KRqchpLdF2RtLFEz9FVkQ==}+resolution: {integrity: sha512-/6w/C21Pm1A7aZitlI5Ni/2J6FFQN8i1Cvz3kHABAAbw93v/NlvKdVOqz7CCWz/3iv/JplRSEEZ83XION15ovw==}engines: {node: '>=6'}@@ -4737,6 +4743,11 @@ packages:react-native-b4a:optional: true+ resolution: {integrity: sha512-+P5EsfmFWAR2cA9M0q20pa4OVOgnOXZkfRYUkQYHanECXCIg10ZnSBzelfBtEjt03b4Vac/yC1h55/wJPLmaOg==}+ engines: {node: '>=20'}+ hasBin: true+resolution: {integrity: sha512-0xO6mYd7JB2YesxDKplafRpsiOzPt9V02ddPCLbY1xYGPOX24NTyN50qnUxgCPcSoYMhKpAuBTjQoRZCAkUDRw==}@@ -4879,6 +4890,9 @@ packages:resolution: {integrity: sha512-fX1Onk0tdVPC7obPWB5EbJ1z7NVhLq4m2xZLq2YXBkxzMXIGRpNMU88n0EPgWseKl12J7zXs7qrDxPK4sRs2fg==}+ resolution: {integrity: sha512-nbE1WxOTTrUWIfsfZ4aHGYu5DOuNkbxGokjV6Z2kxfJK3uaAb8zNK1muzOeipoLHZjInT4Br88BHpzevc681xA==}+resolution: {integrity: sha512-PJvH288AWQhKs2v9zyfYdPzlPqf5bXbGMmhmUIY9x4dAUGIWgomO771oBQNwJnMQSnUIXhKu6sgzpBRXTlvb8Q==}@@ -4993,6 +5007,9 @@ packages:resolution: {integrity: sha512-7NzBL0rN6fMUW+f7A6Io4h40qQlG+xGmtMxfbnH/K7TAtt8JQWVQK+6g0UXKMeVJoyV5EkkNsErQ8pVD3bLHbA==}engines: {node: ^12.17.0 || ^14.13 || >=16.0.0}+ resolution: {integrity: sha512-Fz4UD0LBpxPgL9i29CJ5O4KANwaMnX/OhhbxzvNa332h+9+nRKyeuLw4wA51lt/ex67+/AdsoBQJF3kgX2feYQ==}+resolution: {integrity: sha512-1v7fgQRj6hnSwFpq1Eu0ynr/CDEw0rXo2B61qXrLNdHZmPKgb7fqS1a2JwF0rISo9q77jDI8VMEHoApn8qDoZA==}@@ -5104,6 +5121,9 @@ packages:resolution: {integrity: sha512-loKTxY1zCOuG4j9f6EPnuyyYkf58RnhhWTvRoZEokgB+WbdXehfjFviyOVYkqzEWz1Q5kRiZdBYS5SwxbQYwzw==}+ resolution: {integrity: sha512-RwBeO/B/vZR3dfKL1ye/vx8MHZ40ugzpyfeVG5GsiuGnrlMWe2o8wxBbLCpw9CsxV+wHuzYlCiWnybrIA0ling==}+resolution: {integrity: sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==}@@ -5248,10 +5268,16 @@ packages:resolution: {integrity: sha512-EL/iN9etCTzw/fBnp0/uj0f5BOOGvZut2mzsiiBZ/FdT6gFQCKRO/tmcKOxn5drWZ2Ndm/xBb1SI4zwWbGtmIw==}+ resolution: {integrity: sha512-oLIG2soZz3wcC3aAl/7Us5RS8Hvvc6I8G8LniF/qfMmrm7fIKQ8RIDDRZeKyGL2SrWfNqYspuLShbnjBMVWm8g==}+resolution: {integrity: sha512-X7sjQzceUhu1u7Y/ylrRZFU2FS6LRiFVp6rKLPg23y3x3c3DOKAwuXGDp+PAGjh6CSnCjYeAul8pcT8bAl+lSA==}engines: {node: ^10 || ^12.20.0 || ^14.13.0 || >=15.0.0}+ resolution: {integrity: sha512-IiJwMC8rdZE0+xiEZHeru6YoONC4rfPMqGm2W85jMIbkFvv5nFTwJVFHam2eFrN6txmoUYFAFXiv8ICVeTO0MA==}+resolution: {integrity: sha512-YUifsXXuknHlUsmlgyY0PKzgPOr7/FjCePfHNt0jxm83wHZi44VDMQ7/fGNkjY3/jV1MC+1CmZbaHzugyeRtpg==}@@ -13709,6 +13735,10 @@ snapshots:json-schema-traverse: 1.0.0require-from-string: 2.0.2+ dependencies:+ char-width-table-consumer: 1.0.0+@@ -13859,6 +13889,11 @@ snapshots:+ dependencies:+ anafanafo: 2.0.0+ css-color-converter: 2.0.0+@@ -13952,6 +13987,8 @@ snapshots:dependencies:require-from-string: 2.0.2+ [email protected]: {}+@@ -14091,6 +14128,10 @@ snapshots:+ dependencies:+ binary-search: 1.3.6+@@ -14211,6 +14252,8 @@ snapshots:+ [email protected]: {}+dependencies:color-name: 1.1.3@@ -14356,11 +14399,19 @@ snapshots:+ dependencies:+ color-convert: 0.5.3+ color-name: 1.1.4+ css-unit-converter: 1.1.2+dependencies:mdn-data: 2.27.1source-map-js: 1.2.1+ [email protected]: {}+diff --git a/scripts/generate-readme-badges.mjs b/scripts/generate-readme-badges.mjsnew file mode 100644index 000000000..e95309ef9--- /dev/null+++ b/scripts/generate-readme-badges.mjs@@ -0,0 +1,57 @@+import { readFile, writeFile } from "node:fs/promises"+import { dirname, resolve } from "node:path"+import { fileURLToPath } from "node:url"+import { makeBadge } from "badge-maker"++const repoRoot = resolve(dirname(fileURLToPath(import.meta.url)), "..")+const faviconPath = resolve(repoRoot, "src/web/src/app/favicon.ico")+const outputPath = resolve(repoRoot, "assets/readme/alook-join.svg")+const pngSignature = Buffer.from([0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a])++export function extractPngIcon(ico, size = 32) {+ if (ico.length < 6 || ico.readUInt16LE(0) !== 0 || ico.readUInt16LE(2) !== 1) {+ throw new Error("Invalid ICO header")+ }++ const imageCount = ico.readUInt16LE(4)+ for (let index = 0; index < imageCount; index += 1) {+ const entryOffset = 6 + index * 16+ if (entryOffset + 16 > ico.length) throw new Error("Invalid ICO directory")+ const width = ico[entryOffset] || 256+ const height = ico[entryOffset + 1] || 256+ if (width !== size || height !== size) continue++ const byteLength = ico.readUInt32LE(entryOffset + 8)+ const imageOffset = ico.readUInt32LE(entryOffset + 12)+ const image = ico.subarray(imageOffset, imageOffset + byteLength)+ if (image.length !== byteLength || !image.subarray(0, pngSignature.length).equals(pngSignature)) {+ throw new Error(`The ${size}x${size} favicon entry is not a complete PNG`)+ }+ return image+ }++ throw new Error(`The favicon does not contain a ${size}x${size} PNG entry`)+}++export function makeReadmeBadge(faviconIco) {+ const favicon = extractPngIcon(faviconIco)+ return `${makeBadge({+ label: "Alook",+ message: "Join",+ labelColor: "#555",+ color: "#ff9915",+ logoBase64: `data:image/png;base64,${favicon.toString("base64")}`,+ style: "flat",+ idSuffix: "alook-join",+ })}\n`+}++export async function generateReadmeBadges() {+ const svg = makeReadmeBadge(await readFile(faviconPath))+ await writeFile(outputPath, svg)+ process.stdout.write(`Generated ${outputPath}\n`)+}++if (process.argv[1] === fileURLToPath(import.meta.url)) {+ await generateReadmeBadges()+}diff --git a/scripts/generate-readme-badges.test.mjs b/scripts/generate-readme-badges.test.mjsnew file mode 100644index 000000000..429a8f286--- /dev/null+++ b/scripts/generate-readme-badges.test.mjs@@ -0,0 +1,17 @@+import assert from "node:assert/strict"+import { readFile } from "node:fs/promises"+import test from "node:test"+import { extractPngIcon, makeReadmeBadge } from "./generate-readme-badges.mjs"++test("the checked-in Alook Join badge matches its favicon source", async () => {+ const favicon = await readFile(new URL("../src/web/src/app/favicon.ico", import.meta.url))+ const checkedInBadge = await readFile(new URL("../assets/readme/alook-join.svg", import.meta.url), "utf8")+ const generatedBadge = makeReadmeBadge(favicon)+ const embeddedLogo = generatedBadge.match(/data:image\/png;base64,([^\"]+)/)?.[1]++ assert.equal(generatedBadge, checkedInBadge)+ assert.match(generatedBadge, /width="89" height="20"/)+ assert.match(generatedBadge, /aria-label="Alook: Join"/)+ assert.ok(embeddedLogo)+ assert.deepEqual(Buffer.from(embeddedLogo, "base64"), extractPngIcon(favicon))+})