Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 18 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ for every agent.

## Try it locally

With **Node.js 24+** and **Git** installed, paste this into your terminal:
With **Node.js 24+** installed, paste this into your terminal:

```bash
git clone https://github.com/bIackr0se/agentarium.git && cd agentarium && npm ci && npm run agentarium -- --provider demo
npx --yes agentarium-map@latest
```

This installs, builds, and opens the fictional Demo on your own computer.
It does not read your agent history. Stop it with `Ctrl-C`.
Already cloned it? See [Run locally](#run-locally), including how to connect a live source.
This downloads the prebuilt app and opens a fictional Demo on your computer.
No Git, cloning, or local build is needed. It does not read your agent history.
Stop it with `Ctrl-C`. See [Run locally](#run-locally) to connect a live source.

![Agentarium connected world with synthetic Demo projects](docs/agentarium-demo.png)

Expand Down Expand Up @@ -155,12 +155,10 @@ recoveries, and regressions are covered in

## Run locally

Agentarium requires Node.js 24 or newer. The npm package is not published yet.
From this repository checkout, install and build once, then open the demo:
Agentarium requires Node.js 24 or newer. Start the prebuilt npm package:

```bash
npm ci
npm run agentarium -- --provider demo
npx --yes agentarium-map@latest
```

The launcher starts the server on `127.0.0.1` and opens the local app.
Expand All @@ -180,7 +178,7 @@ The included Codex adapter reads the tested local SQLite state and does not
write to it:

```bash
npm run agentarium -- --provider codex
npx --yes agentarium-map@latest --provider codex
```

When the browser opens, choose **Live**. The source label and agent count
Expand All @@ -198,13 +196,13 @@ append-oriented JSONL file. Validate the file, start the matching provider, and
then choose **Live**:

```bash
npm run agentarium -- --validate /path/to/world.json
npm run agentarium -- --provider json --snapshot /path/to/world.json
npx --yes agentarium-map@latest --validate /path/to/world.json
npx --yes agentarium-map@latest --provider json --snapshot /path/to/world.json
```

```bash
npm run agentarium -- --validate /path/to/world.jsonl
npm run agentarium -- --provider jsonl --snapshot /path/to/world.jsonl
npx --yes agentarium-map@latest --validate /path/to/world.jsonl
npx --yes agentarium-map@latest --provider jsonl --snapshot /path/to/world.jsonl
```

The bridge requirement, versioned fields, and tested examples are in the
Expand All @@ -220,7 +218,11 @@ harnesses need a bridge that emits the documented shape.

### Run from a source checkout

For development, clone and build the source:

```bash
git clone https://github.com/bIackr0se/agentarium.git
cd agentarium
npm ci
npm run agentarium -- --provider demo
```
Expand All @@ -244,8 +246,8 @@ Validate a producer file using the same bounded server projection used at the
API boundary:

```bash
npm run agentarium -- --validate /path/to/world.json
npm run agentarium -- --validate /path/to/world.jsonl
npx --yes agentarium-map@latest --validate /path/to/world.json
npx --yes agentarium-map@latest --validate /path/to/world.jsonl
```

From a source checkout, the equivalent command is
Expand Down
12 changes: 6 additions & 6 deletions bin/agentarium.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ Options:
--no-open Do not open a browser automatically
--help Show this help

From an Agentarium checkout after npm ci:
npm run agentarium -- --provider demo
npm run agentarium -- --provider codex
npm run agentarium -- --provider json --snapshot ./world.json
npm run agentarium -- --provider jsonl --snapshot ./world.jsonl --port 4174 --no-open
npm run agentarium -- --validate ./world.json`;
Run without cloning or building (Node.js 24+):
npx --yes agentarium-map@latest --provider demo
npx --yes agentarium-map@latest --provider codex
npx --yes agentarium-map@latest --provider json --snapshot ./world.json
npx --yes agentarium-map@latest --provider jsonl --snapshot ./world.jsonl --port 4174 --no-open
npx --yes agentarium-map@latest --validate ./world.json`;

const FILE_PROVIDERS = new Set(["json", "jsonl"]);

Expand Down
21 changes: 21 additions & 0 deletions docs/licenses/react-MIT.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) Meta Platforms, Inc. and affiliates.

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.
93 changes: 93 additions & 0 deletions docs/licenses/space-grotesk-OFL.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
Copyright 2020 The Space Grotesk Project Authors (https://github.com/floriankarsten/space-grotesk)

This Font Software is licensed under the SIL Open Font License, Version 1.1.
This license is copied below, and is also available with a FAQ at:
http://scripts.sil.org/OFL


-----------------------------------------------------------
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
-----------------------------------------------------------

PREAMBLE
The goals of the Open Font License (OFL) are to stimulate worldwide
development of collaborative font projects, to support the font creation
efforts of academic and linguistic communities, and to provide a free and
open framework in which fonts may be shared and improved in partnership
with others.

The OFL allows the licensed fonts to be used, studied, modified and
redistributed freely as long as they are not sold by themselves. The
fonts, including any derivative works, can be bundled, embedded,
redistributed and/or sold with any software provided that any reserved
names are not used by derivative works. The fonts and derivatives,
however, cannot be released under any other type of license. The
requirement for fonts to remain under this license does not apply
to any document created using the fonts or their derivatives.

DEFINITIONS
"Font Software" refers to the set of files released by the Copyright
Holder(s) under this license and clearly marked as such. This may
include source files, build scripts and documentation.

"Reserved Font Name" refers to any names specified as such after the
copyright statement(s).

"Original Version" refers to the collection of Font Software components as
distributed by the Copyright Holder(s).

"Modified Version" refers to any derivative made by adding to, deleting,
or substituting -- in part or in whole -- any of the components of the
Original Version, by changing formats or by porting the Font Software to a
new environment.

"Author" refers to any designer, engineer, programmer, technical
writer or other person who contributed to the Font Software.

PERMISSION & CONDITIONS
Permission is hereby granted, free of charge, to any person obtaining
a copy of the Font Software, to use, study, copy, merge, embed, modify,
redistribute, and sell modified and unmodified copies of the Font
Software, subject to the following conditions:

1) Neither the Font Software nor any of its individual components,
in Original or Modified Versions, may be sold by itself.

2) Original or Modified Versions of the Font Software may be bundled,
redistributed and/or sold with any software, provided that each copy
contains the above copyright notice and this license. These can be
included either as stand-alone text files, human-readable headers or
in the appropriate machine-readable metadata fields within text or
binary files as long as those fields can be easily viewed by the user.

3) No Modified Version of the Font Software may use the Reserved Font
Name(s) unless explicit written permission is granted by the corresponding
Copyright Holder. This restriction only applies to the primary font name as
presented to the users.

4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
Software shall not be used to promote, endorse or advertise any
Modified Version, except to acknowledge the contribution(s) of the
Copyright Holder(s) and the Author(s) or with their explicit written
permission.

5) The Font Software, modified or unmodified, in part or in whole,
must be distributed entirely under this license, and must not be
distributed under any other license. The requirement for fonts to
remain under this license does not apply to any document created
using the Font Software.

TERMINATION
This license becomes null and void if any of the above conditions are
not met.

DISCLAIMER
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
OTHER DEALINGS IN THE FONT SOFTWARE.
6 changes: 6 additions & 0 deletions docs/provider-matrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@ hashed JavaScript, CSS, fonts, health, Live JSON, and Demo JSON before removing
the temporary install. This is the distribution check; a passing source-tree
server test alone is not enough.

The same test also uses npm exec with the tarball from an empty directory and
an isolated cache, with install scripts disabled. It verifies default Demo startup,
the read-only health endpoint, and that the caller's directory stays empty.
The published runtime has no external npm dependencies; React and the font are
already in the built browser assets.

Run the focused matrix with:

```bash
Expand Down
2 changes: 1 addition & 1 deletion docs/visual-assets.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The running world uses `public/assets/sculpted/reference-world.webp` (1536 x 102

The earlier individual `workshop.webp`, `observatory.webp`, `garden.webp`, and `village.webp` scenes remain as prior artwork. They no longer define runtime island geometry. Keep provenance sidecars with their assets. A generation prompt is not a license statement.

The README screenshot and launch film show fictional Demo data. Captures have tool padding removed and reduced-resolution content. The film is an edited walkthrough with an original score. Working captures and editing intermediates are excluded from the source release.
The README screenshot and launch film show fictional Demo data. Captures have tool padding removed and reduced-resolution content. The film is an edited walkthrough with an original score. The repository includes the Demo captures and film renderer used to reproduce the walkthrough. Editing intermediates are excluded from the source release.

## Retained legacy assets

Expand Down
2 changes: 1 addition & 1 deletion launch/2026-09-redesign/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

This 36-second, 1080p film combines fictional Demo captures, the application artwork, and an original synthesized score. It is an edited walkthrough, not a continuous screen recording. All displayed tasks and evidence are synthetic. The screenshots have reduced-resolution content, so small UI text is softer than the running application.

The film demonstrates the local browser application. Codex is the tested native adapter; JSON and JSONL accept normalized local snapshots. It does not announce an available npm package or hosted service.
The film demonstrates the local browser application. Codex is the tested native adapter; JSON and JSONL accept normalized local snapshots. The prebuilt application runs with `npx --yes agentarium-map@latest` on Node.js 24 or newer.

The typeface license is included in `FONT-LICENSE.txt`. Source artwork provenance is recorded in `public/assets/sculpted/` at the repository root.

Expand Down
Binary file modified launch/2026-09-redesign/agentarium-launch.mp4
Binary file not shown.
Binary file modified launch/2026-09-redesign/captures/connect.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions launch/2026-09-redesign/export.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"inputs": {
"launch/2026-09-redesign/SpaceGrotesk-Medium.ttf": "6f62490780ab5ec012ec7de71446fbb0d37c2c53ec4df9f94c49c9187336ea23",
"launch/2026-09-redesign/captures/connect.png": "e7891a7b0d86ff53e4c9f0217ba16803cbd35bb5b1d47ad3406a3cc05c646544",
"launch/2026-09-redesign/captures/connect.png": "f36a091fbfcbef485c6fa7e90f3fcd44698c4a982d66ebc1e3168632d6e72ba7",
"launch/2026-09-redesign/captures/desktop.png": "e2d8b2a42af803ce615e6885b6fbcfa70a9cbac1caa167f6be88d90b1ea443ac",
"launch/2026-09-redesign/captures/evidence.png": "3d5d13425ca105c82177d218acb93cdad03ef5965a2bdf5ded3b55a26074cd1d",
"launch/2026-09-redesign/captures/project.png": "80f68e1b8b59d0c9714834fb72bb845882c6a2159173897c80b0e51a39e31b7f",
Expand All @@ -12,5 +12,5 @@
"launch/2026-09-redesign/robot-film.webp": "d34e4430bfbc0d5a0cc13ffc99685d634de76dbe98da8740f768d0c36c4e300a",
"public/assets/sculpted/village.webp": "cf679972dc12baf2fc4dc6e7362529c15704c62e9328b7b4a2634484980184d9"
},
"video_sha256": "ff31e001f3f57a83cb41424491aa83fac28dcf2e97b61e9438083696478b59f5"
"video_sha256": "4280876922546da8ffd23000158742a1ecbd1bd1d572d875297061c24e40a042"
}
12 changes: 7 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 8 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"name": "agentarium-map",
"version": "0.1.0",
"private": true,
"description": "A localhost-only, read-only visual map for provider-neutral agent work.",
"bin": {
"agentarium": "./bin/agentarium.mjs"
Expand All @@ -13,7 +12,8 @@
"src/lib/demo-fixture.mjs",
"docs/provider-matrix.md",
"docs/world-snapshot.example.json",
"docs/world-snapshot.schema.json"
"docs/world-snapshot.schema.json",
"docs/licenses"
],
"repository": {
"type": "git",
Expand Down Expand Up @@ -44,12 +44,10 @@
"test:browser": "playwright test",
"verify": "npm run lint && npm test && npm run build && npm run test:install && npm run test:browser"
},
"dependencies": {
"devDependencies": {
"@fontsource-variable/space-grotesk": "^5.3.0",
"react": "19.2.8",
"react-dom": "19.2.8"
},
"devDependencies": {
"react-dom": "19.2.8",
"@axe-core/playwright": "4.13.0",
"@playwright/test": "1.63.0",
"@testing-library/jest-dom": "7.0.1",
Expand All @@ -63,5 +61,9 @@
"typescript": "7.0.2",
"vite": "8.2.2",
"vitest": "4.1.11"
},
"publishConfig": {
"access": "public",
"registry": "https://registry.npmjs.org/"
}
}
10 changes: 5 additions & 5 deletions src/App.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ describe("Agentarium shell", () => {
expect(screen.getByRole("heading", { name: "Codex" })).toBeInTheDocument();
expect(screen.getByRole("heading", { name: "Any harness · JSON" })).toBeInTheDocument();
expect(screen.getByRole("heading", { name: "Any harness · JSONL" })).toBeInTheDocument();
expect(screen.getByText("npm run agentarium -- --provider codex")).toBeInTheDocument();
expect(screen.getByText("npx --yes agentarium-map@latest --provider codex")).toBeInTheDocument();
expect(screen.getByText(/never sends prompts, commands, approvals, or payloads/i)).toBeInTheDocument();

await user.click(screen.getByRole("button", { name: "Close connection guide" }));
Expand Down Expand Up @@ -1102,11 +1102,11 @@ describe("Agentarium shell", () => {
const emptyScene = screen.getByRole("region", { name: "Connect a source" });
expect(emptyScene).toHaveTextContent("Connect a local source to see your projects, tasks, and agents");
expect(emptyScene).toHaveTextContent("restart it with one adapter below, return here, then select Live");
expect(emptyScene).toHaveTextContent("npm run agentarium -- --provider codex");
expect(emptyScene).toHaveTextContent("npm run agentarium -- --provider json --snapshot /absolute/path/world.json");
expect(emptyScene).toHaveTextContent("npm run agentarium -- --provider jsonl --snapshot /absolute/path/world.jsonl");
expect(emptyScene).toHaveTextContent("npx --yes agentarium-map@latest --provider codex");
expect(emptyScene).toHaveTextContent("npx --yes agentarium-map@latest --provider json --snapshot /absolute/path/world.json");
expect(emptyScene).toHaveTextContent("npx --yes agentarium-map@latest --provider jsonl --snapshot /absolute/path/world.jsonl");
expect(emptyScene).toHaveTextContent("docs/world-snapshot.schema.json");
expect(emptyScene).toHaveTextContent("npm run agentarium -- --validate /absolute/path/world.jsonl");
expect(emptyScene).toHaveTextContent("npx --yes agentarium-map@latest --validate /absolute/path/world.jsonl");
expect(screen.getByText("Snapshot source was not configured.")).toBeInTheDocument();
expect(screen.getByText("Live source not connected")).toBeInTheDocument();
expect(screen.getByText("Prompts and payloads are never displayed")).toBeInTheDocument();
Expand Down
Loading