git.iko.soy/urbit-apps
on master help sign in
swap
83692737 ahead, 0 behind
5 files changed+730−274
since splitsnapshots
unifiedsplit
AGENTS.md+161 CLAUDE.md+1 README.md+142−75 flake.lock+206−83 flake.nix+220−116
AGENTS.mdnew file+161
@@ -0,0 +1,161 @@
1+# Agent guidance
2+
3+## Project
4+
5+`urbit-apps` is a Nix flake that builds Urbit apps' desks into `.deskjam`
6+files, the upload format of [deskjam](https://github.com/iko-soy/deskjam),
7+with its glob next to each one, for an app whose frontend is one. `jammer/`
8+is the Rust CLI that packs them. `README.md` documents the apps for users:
9+read it before changing what the flake builds.
10+
11+## Code map
12+
13+- `flake.nix`: nixpkgs, flake-utils, one input per app, and the commits
14+ harness' build pins. Each app is an `<app>-desk` built with `mkDeskjam` and
15+ exposed as `packages.<system>.<app>`. Globs are `packages.<system>.<app>-glob`,
16+ for hits, silo and vita. jammer is `packages.<system>.jammer` and `default`.
17+ - `mkDeskjam { desk, src, glob ? null }` packs the desk folder `src` into
18+ `$out/<desk>.deskjam` and copies `glob` next to it as `$out/<desk>-glob`.
19+ - `names-glob` reads a `desk.docket-0` with `urbit eval`, as the docket mark
20+ does. `mkDeskjam` fails the build when the docket names a glob (a
21+ `glob-http` or `glob-ames` clause, and no `site` clause) but has no
22+ `glob`, when it has a `glob` for a docket that names none, and when Hoon
23+ can't read the docket as a list of clauses. It doesn't check that the
24+ docket has the clauses the mark needs, such as `title`.
25+ - `mkGlob` builds a frontend with `buildNpmPackage` (`npm run build`, then
26+ its `dist/`), for apps whose own flakes don't build their globs.
27+ - `harness-git` and `harness-src` run harness' own `zig build` offline; see
28+ the README's "How the desks are built".
29+- `flake.lock`: the revision of every app and dependency.
30+- `jammer/`: the packer. Its build takes only `Cargo.toml`, `Cargo.lock`,
31+ `src/` and `tests/`, and runs its tests.
32+- `README.md`: the apps table, installing and updating with deskjam,
33+ frontends, and how each desk is built.
34+
35+## Working conventions
36+
37+- Use jj, not git, and pass `--git` to `jj diff` and `jj show`. Commit or push
38+ only when asked. Never write to `/nix` by hand.
39+- Nix only sees files jj tracks, and jj tracks a new file at its next
40+ command. After adding a file, run `jj status` before building, not
41+ `git add`.
42+- jammer writes `<desk>.deskjam` or `<desk>/` in the current directory, and jj
43+ would track them in this repo. Run it elsewhere, or give `jam` and `unjam`
44+ an `-o` outside the repo; `nix shell .` puts it on your PATH.
45+- Don't change the app repos from here. When one needs a change, write a
46+ prompt the user can give an agent in that repo: the problem, with evidence,
47+ the change, and how to check it.
48+- Add an app by the first route its repo allows:
49+ 1. Its flake builds the full desk, as `packages.<system>.desk`, or as
50+ `default` if it has no `desk`, like vita's. Add it as a flake input, with
51+ `src = app.packages.${system}.desk`, or `.default`. If its docket names a
52+ glob and its flake builds it, use `glob = app.packages.${system}.glob`;
53+ if not, build it here with `mkGlob`, as for hits. Have its `nixpkgs`
54+ follow this flake's only if its flake builds no frontend; otherwise keep
55+ the nixpkgs it pins, so its glob is the same build as in its own repo.
56+ 2. It has no flake, and its `desk/` is the whole desk: a `flake = false`
57+ input, with `src = "${app}/desk"`. If its docket names a glob, build it
58+ with `mkGlob`, starting its `npmDepsHash` at `pkgs.lib.fakeHash`.
59+ 3. Its own build tool assembles the desk: run that build in Nix, with its
60+ fetches pinned as inputs, as for harness. Don't reimplement its steps.
61+ Replace only a step that can't run in the sandbox, as `flake.nix` does
62+ for harness' npm steps, with `--replace-fail`, so a change upstream
63+ stops the build. Make the build fail loudly when upstream pins
64+ something new.
65+- Before adding an app, check:
66+ - that its `sys.kelvin` lists the current kernel, `[%zuse 408]`. Kernel
67+ numbers count down, so 411 is older than 408. Don't package an app that
68+ only supports older kernels.
69+ - its desk name, from its README or its docket's `base`.
70+ - whether its docket names a glob, and where else its frontend could come
71+ from, such as files its own agent serves from the desk.
72+ - that `jammer jam -v` reports no missing marks, and that deskjam's confirm
73+ page, on a fake ship, finds nothing missing that its agents and marks
74+ need. Its warning that other files import files the desk lacks, as for
75+ silo's base-dev libraries, is fine if nothing uses them.
76+- The flake supports `x86_64-linux`, `aarch64-linux` and `aarch64-darwin`;
77+ nixpkgs 26.11 dropped `x86_64-darwin`. An app's flake must provide its
78+ outputs on all three.
79+- Keep `README.md` in step with the flake. Give the app its row in the Apps
80+ table (description, source link,
81+ `nix build github:iko-soy/urbit-apps#<app>`), and add it wherever the README
82+ lists apps like it: the glob and build-all commands and their counts, the
83+ Frontends section, which names every app, with a glob or without, and
84+ "How the desks are built", including its npm hashes. Search the README for
85+ a similar app's name to find them all, and keep the lists in alphabetical
86+ order. Write in the README's voice: short, plain sentences.
87+- In a README table cell, escape `|` as `\|`, even inside backticks. GitHub
88+ drops the cells an unescaped one adds, so a rendered table won't show it.
89+- The README says `~donmec-sallud` publishes every app in its table, and
90+ [shelf.iko.soy](https://shelf.iko.soy) lists the apps it offers. Only the
91+ user can publish an app there: when you add one that shelf.iko.soy doesn't
92+ list, say so in your report.
93+- Format `flake.nix` with `nix run --inputs-from . nixpkgs#nixfmt -- flake.nix`.
94+- `nix flake update` moves every input except those pinned by a commit in
95+ their URL, such as `harness-grubbery` and `harness-tlon`; move those by
96+ editing the URL.
97+- When a frontend's `package-lock.json` changes, its build stops with a hash
98+ mismatch, or `npmDepsHash is out of date`. Set its hash (`npmDepsHash`, or
99+ the `hash` of harness' `npmDeps`) to `pkgs.lib.fakeHash`, build, and use
100+ the hash shown after `got:`.
101+
102+## Validation
103+
104+Run from the repository root:
105+
106+```sh
107+nix run --inputs-from . nixpkgs#nixfmt -- --check flake.nix
108+nix flake check --all-systems --no-build
109+nix build --no-link --print-out-paths .#<app>
110+grep '^|' README.md | sed 's/\\|//g' | awk -F'|' 'NF != 6'
111+```
112+
113+The last command prints any README table row with a stray `|`; it should
114+print nothing.
115+
116+For a change that shouldn't change a desk, build every app before and after
117+it, and `cmp` each `.deskjam`. Store paths don't tell: they change whenever
118+jammer is rebuilt. For a change that should, unpack both with
119+`jammer unjam OLD.deskjam -o old` and `jammer unjam NEW.deskjam -o new`, and
120+check that `diff -r old new` shows only the expected changes. To check that a
121+glob is reproducible, build it, then run `nix build --rebuild` on it a few
122+times; `--rebuild` fails on a glob that isn't built yet.
123+
124+For a new app, check that its deskjam has what the app's install steps make.
125+`|new-desk` adds `mar/hoon`, `mar/kelvin`, `mar/noun`, `mar/txt` and
126+`sys.kelvin` from `%base` to what you copy in. Make that folder, pack it with
127+deskjam's `tests/fakezod/pack.sh`, which makes the same bytes as jammer with
128+`urbit eval`, and `cmp` the two. pack.sh stops on a file jammer skips, such
129+as hits' `LICENSE`, which has no extension: pack a copy without such files.
130+
131+To test an app on a ship, clone iko-soy/deskjam outside this repo and use its
132+fake-ship harness, `tests/fakezod`, which keeps its pier in its
133+`tests/fakezod/.work`:
134+
135+- `bootstrap.sh` boots a fake `~zod` with deskjam, and a desk `%harness` whose
136+ `%logtap` agent copies the ship's output into the log. This repo's harness
137+ app is also `%harness`, and replacing that desk deletes logtap: move
138+ `%logtap` to a desk of its own before installing it.
139+- Set `HTTP_PORT`, and an `AMES_PORT` outside 31337 to 31592. A fake ship
140+ sends galaxy N's packets to port 31337 + N, so a ship on one of those ports
141+ loops them back to itself. The harness' default, 31483, is in that range.
142+- `smoke-test.sh` shows how to drive deskjam's pages with curl. It has no
143+ glob: for an app with one, post the confirm page's **set** form first, as
144+ the README's Frontends section says.
145+- Upload a glob at `/docket/upload` as a browser does: a `desk` part, then one
146+ `glob` part per file, named `<folder>/<path>`, with its content type.
147+- Stop the ship with `stop.sh` when done.
148+
149+Quirks:
150+
151+- `urbit eval` colors its output, ends lines with CRLF, and exits 0 even when
152+ the Hoon crashes. Check its output, not its exit status.
153+- In the build sandbox, npm packages' `#!/usr/bin/env node` scripts only run
154+ after `patchShebangs`, which `npmHooks.npmConfigHook` does once. Another
155+ `npm ci` puts the unpatched scripts back.
156+- `nix build` of several targets writes `result`, then `result-1` and so on.
157+ Nix reuses a `github:` flake it fetched within the last hour, unless given
158+ `--refresh`.
159+
160+In the final report, summarize the change, the checks run, and anything left
161+unchecked.
CLAUDE.mdnew file+1
@@ -0,0 +1 @@
1+AGENTS.md
README.md+142−75
@@ -6,30 +6,41 @@ file. You install it in your ship's web interface with
66[deskjam](https://github.com/iko-soy/deskjam), without access to the ship's
77files.
88
9+Every app here is also published from `~donmec-sallud`, so you can install
10+it from that ship instead, with nothing to build: see
11+[Installing from ~donmec-sallud](#installing-from-donmec-sallud).
12+
913## Apps
1014
1115| App | Description | Source | Build |
1216|---|---|---|---|
13−| `%deskjam` | Install and update apps, and upload and download desks, as deskjam files, in your ship's web interface at `/apps/deskjam`. A fork of [tinnus-napbus/deskjam](https://github.com/tinnus-napbus/deskjam). | [iko-soy/deskjam](https://github.com/iko-soy/deskjam) | `nix build .#deskjam` |
14−| `%hits` | Ranks apps by how many installs they have among the ships around you, which gossip their installs to their Pals and the ships they chat with in Tlon. There's no central server. Its frontend is a glob: see [Frontends](#frontends). A fork of [urbit/hits](https://github.com/urbit/hits). | [iko-soy/hits](https://github.com/iko-soy/hits) | `nix build .#hits` |
15−| `%mcp` | An MCP (Model Context Protocol) server at `/mcp` that lets AI tools use your ship, and a proxy at `/apps/mcp/mcp` that offers its tools together with those of remote MCP and OpenAPI servers. A fork of [gwbtc/urbit-mcp](https://github.com/gwbtc/urbit-mcp). | [tloncorp/mcp](https://github.com/tloncorp/mcp) | `nix build .#mcp` |
16−| `%shelf` | A public web page that lists the apps your ship publishes, so anyone can install them on their own ship. It answers at `/shelf`, for a reverse proxy to serve at the root of its own domain, and needs `%landscape`, which fresh ships have. | [iko-soy/shelf](https://github.com/iko-soy/shelf) | `nix build .#shelf` |
17−| `%silo` | A file manager for the S3 storage your ship uploads to: add a bucket's credentials, then browse its files and upload new ones. It has no agents of its own, and uses `%storage` from `%landscape`, which fresh ships have. | [arthyn/silo](https://github.com/arthyn/silo) | `nix build .#silo` |
18−
19−Run the build commands in a checkout of this repo, with Nix and flakes
20−enabled. If flakes aren't enabled, put
21−`--extra-experimental-features 'nix-command flakes'` after `nix`. Without a
22−checkout, give the repo's address instead of `.`, such as
23−`nix build github:iko-soy/urbit-apps#shelf`. Nix fetches each app's source
24−itself, at the version `flake.lock` pins.
17+| `%accountability` | Watches all 256 galaxies from your ship. Every 10 minutes it checks each one's keys on chain, whether it answers, and which `%kids` OTA it serves, and logs every change. A dashboard at `/apps/accountability` and a public JSON API show the results. It needs `%azimuth` running, as on a livenet ship. | [sigilante/accountability](https://github.com/sigilante/accountability) | `nix build github:iko-soy/urbit-apps#accountability` |
18+| `%burn` | Shares a Plex server's media library between ships. Every byte goes over Ames and is checked against its hash, so a ship behind NAT can share with no port forwarding. Its page is new-oxal's `/new-oxal/plex`, so install `%new-oxal` too. | [brbenji/burn](https://github.com/brbenji/burn) | `nix build github:iko-soy/urbit-apps#burn` |
19+| `%deskjam` | Install and update apps, and upload and download desks, as deskjam files, in your ship's web interface at `/apps/deskjam`. A fork of [tinnus-napbus/deskjam](https://github.com/tinnus-napbus/deskjam). | [iko-soy/deskjam](https://github.com/iko-soy/deskjam) | `nix build github:iko-soy/urbit-apps#deskjam` |
20+| `%harness` | Runs AI agents on your ship. Talk to them in its web app at `/apps/harness`, in Tlon, or from an editor, while the ship keeps the conversations, permissions and work. Models come from providers you configure, such as OpenRouter, OpenAI or Anthropic. Its Tlon features and its documents need `%groups`. Installing it takes a few minutes, while Clay builds it. | [mopfel-winrux/urbit-agent-harness](https://github.com/mopfel-winrux/urbit-agent-harness) | `nix build github:iko-soy/urbit-apps#harness` |
21+| `%hits` | Ranks apps by how many installs they have among the ships around you, which gossip their installs to their Pals and the ships they chat with in Tlon. There's no central server. It works without `%pals`, but then hears only from the ships you chat with. It only counts apps that kiln syncs from another ship, as after `\|install`: not ones installed from a deskjam file, or ones you stop kiln syncing. Its frontend is a glob: see [Frontends](#frontends). A fork of [urbit/hits](https://github.com/urbit/hits). | [iko-soy/hits](https://github.com/iko-soy/hits) | `nix build github:iko-soy/urbit-apps#hits` |
22+| `%new-oxal` | A networked reactive database, shown as a tree-shaped spreadsheet. Its views include burn's page, at `/new-oxal/plex`, which needs `%burn`. It comes from burn's repo. | [brbenji/burn](https://github.com/brbenji/burn) | `nix build github:iko-soy/urbit-apps#new-oxal` |
23+| `%shelf` | A public web page that lists the apps your ship publishes, so anyone can install them on their own ship. It answers at `/shelf`, for a reverse proxy to serve at the root of its own domain, and needs `%landscape`, which fresh ships have. | [iko-soy/shelf](https://github.com/iko-soy/shelf) | `nix build github:iko-soy/urbit-apps#shelf` |
24+| `%silo` | A file manager for the S3 storage your ship uploads to: add a bucket's credentials, then browse its files and upload new ones. It has no agents of its own, and uses `%storage` from `%landscape`, which fresh ships have. Its frontend is a glob: see [Frontends](#frontends). A fork of [arthyn/silo](https://github.com/arthyn/silo). | [iko-soy/silo](https://github.com/iko-soy/silo) | `nix build github:iko-soy/urbit-apps#silo` |
25+| `%vita` | Tracks how your published apps spread: how many ships sync each of your desks, and the daily active users that apps using its `vita-client` library report, with a dashboard for creating and maintaining apps. Its frontend is a glob: see [Frontends](#frontends). A fork of [assemblycapital/vita](https://github.com/assemblycapital/vita), updated for kernel 408. | [iko-soy/vita](https://github.com/iko-soy/vita) | `nix build github:iko-soy/urbit-apps#vita` |
26+
27+The build commands need Nix with flakes enabled, but no clone of this repo:
28+Nix fetches it from GitHub, and each app's source at the version `flake.lock`
29+pins. If flakes aren't enabled, put
30+`--extra-experimental-features 'nix-command flakes'` after `nix`. In a
31+checkout of this repo, `.` builds your working copy instead, as in
32+`nix build .#shelf`.
2533
2634Each build writes `result/<desk>.deskjam`, such as `result/shelf.deskjam`, in
27−place of the last build's `result`. For an app with a web frontend, a glob,
28−it also writes the glob's files next to it, as `result/<desk>-glob`, and the
29−build fails if `flake.nix` doesn't build them, so a deskjam never comes
30−without its glob. `nix build .#hits-glob` or `.#silo-glob` builds just a glob.
31−`nix build .#deskjam .#hits .#mcp .#shelf .#silo` builds all five, into
32−`result`, `result-1`, `result-2`, `result-3` and `result-4`.
35+place of the last build's `result`. For an app whose web frontend is a glob,
36+such as hits, it also writes the glob's files next to it, as
37+`result/<desk>-glob`, and the build fails if `flake.nix` doesn't build them,
38+so a deskjam never comes without its glob.
39+`nix build github:iko-soy/urbit-apps#hits-glob`, or `#silo-glob` or
40+`#vita-glob`, builds just a glob. In a checkout,
41+`nix build .#accountability .#burn .#deskjam .#harness .#hits .#new-oxal .#shelf .#silo .#vita`
42+builds all nine, in that order, into `result` and `result-1` to `result-8`.
43+The steps below assume one app's `result`.
3344
3445You can install these files on your ship with
3546[iko-soy/deskjam](https://github.com/iko-soy/deskjam): see
@@ -40,6 +51,15 @@ desks. No Hoon is compiled: your ship compiles an app's Hoon when you install
4051it. The flake supports `x86_64-linux`, `aarch64-linux` and `aarch64-darwin`
4152(Apple silicon Macs).
4253
54+## Installing from ~donmec-sallud
55+
56+`~donmec-sallud` publishes every app in the [table](#apps). To install one
57+from it, run `|install ~donmec-sallud` and the app's name in the dojo, your
58+ship's command line, as in `|install ~donmec-sallud %shelf`. Your ship gets
59+the app, frontend included, and its updates from that ship.
60+[shelf.iko.soy](https://shelf.iko.soy) lists all the apps `~donmec-sallud`
61+offers, with the command that installs each.
62+
4363## Installing with deskjam
4464
4565[deskjam](https://github.com/iko-soy/deskjam) installs and updates apps from
@@ -47,7 +67,8 @@ these files. Only install apps you trust: an app's agents, its programs, run
4767as your ship, and can read and change anything on it.
4868
4969If you build on another machine, such as the server your ship runs on, copy
50−the file to the computer your browser runs on first, for example with `scp`.
70+the file, and its `<desk>-glob` folder if it has one, to the computer your
71+browser runs on first, for example with `scp -r`.
5172
5273### Getting deskjam
5374
@@ -56,8 +77,8 @@ that doesn't have it yet. The first time, do one of these:
5677
5778- If you can reach your ship's files, follow deskjam's
5879 [Installation](https://github.com/iko-soy/deskjam#installation).
59−- If another ship publishes it, run `|install ~that-ship %deskjam` in the
60− dojo, your ship's command line.
80+- Install it from `~donmec-sallud`: run `|install ~donmec-sallud %deskjam`
81+ in the dojo.
6182- If your ship runs upstream deskjam,
6283 [tinnus-napbus/deskjam](https://github.com/tinnus-napbus/deskjam), upload
6384 `result/deskjam.deskjam` through it, following
@@ -76,61 +97,85 @@ After that, update deskjam like any other app, as below.
76972. Under **upload deskjam**, choose the file, such as `result/shelf.deskjam`,
7798 and click **upload**.
78993. Under **Install it as a new desk**, keep the name and click **next**.
79−4. On the confirm page, tick **start its agents after uploading** (for an app
80− without agents, such as silo, **mark it running after uploading**), and
81− click **confirm**.
100+4. On the confirm page, if the app's frontend is a glob, first click **set**
101+ in the glob box, as [Frontends](#frontends) says. Then tick
102+ **start its agents after uploading** (for an app without agents, such as
103+ silo, **mark it running after uploading**), and click **confirm**.
821045. The status page says whether the app runs.
83105
84−Once it runs, see the app's README for how to set it up. mcp's README
85−describes an operator console at `/apps/mcp/`, which this version of mcp
86−doesn't have. MCP clients send mcp's API key in an `X-Api-Key` header, and
87−`.^(@t %gx /=mcp-proxy=/client-key/noun)` in the dojo prints it.
106+Once it runs, see the app's README for how to set it up.
88107
89108### Updating an app
90109
91110Apps installed this way don't update on their own. To update one:
92111
93−1. Move its pin to the latest commit of its repo, such as with
94− `nix flake update shelf`, and build it again. `nix flake update` moves
95− every app, and nixpkgs.
112+1. Build it again. Nix reuses a copy of this repo it fetched in the last hour,
113+ so add `--refresh` to get the pins it has now:
114+ `nix build --refresh github:iko-soy/urbit-apps#shelf`. To build an app's
115+ newest commit before this repo pins it, add
116+ `--override-input shelf github:iko-soy/shelf`. In a checkout,
117+ `nix flake update shelf` moves the pin, and `nix flake update` moves every
118+ app, and nixpkgs.
961192. Upload the new file as above. Under **Update an existing desk**, choose the
97120 app's desk, select **replace it**, and click **next**. Replace makes the
98121 desk exactly the upload, so files a new version removed don't linger.
991223. The confirm page offers a download of the desk as it is now. Keep it if
100− you might want to go back, then click **confirm**.
123+ you might want to go back. If your ship serves the app's glob, click
124+ **set** in the glob box first. Then click **confirm**.
101125
102126Uploading the kept copy with **replace it** puts the old version back. If the
103127update changed the state an agent keeps, that usually fails, and nothing
104128changes. But some agents start afresh from state they can't read, and lose it
105−instead: deskjam's and mcp's do. For mcp, that means a new API key, and its
106−remote servers and OAuth grants are gone.
107−
108−If the app came from another ship with `|install`, kiln, the part of your
109−ship that installs and updates apps, keeps it in sync with that ship. That
110−ship's next release would undo your upload. Tick **stop kiln syncing** on the
111−confirm page to keep yours. That stops all of that ship's updates to the
112−desk, until you run `|install ~that-ship %desk` again, which replaces your
113−upload with their latest release.
129+instead: deskjam's does. If your ship serves the app's glob, also copy its old
130+`result/<desk>-glob` somewhere before you build the new version, and upload it
131+at `/docket/upload` after putting the old version back.
132+
133+If the app came from another ship with `|install`, such as
134+`~donmec-sallud`, kiln, the part of your ship that installs and updates apps,
135+keeps it in sync with that ship. That ship's next release would undo your
136+upload. Tick **stop kiln syncing** on the confirm page to keep yours. That
137+stops all of that ship's updates to the desk, until you run
138+`|install ~that-ship %desk` again, which replaces your upload with their
139+latest release.
114140
115141### Frontends
116142
117−An app's web frontend, its glob, isn't part of its desk. Landscape's
118−`%docket` agent gets it as the app's docket says, and the build puts it next
119−to the deskjam, as `result/<desk>-glob`:
120−
121−- silo's docket has `%docket` download its glob from a url, so `silo.deskjam`
122− works on any ship. You need `result/silo-glob` only to serve the frontend
123− from your own ship instead, as deskjam's
124− [Serving a glob from your ship](https://github.com/iko-soy/deskjam/blob/main/docs/globs.md#serving-a-glob-from-your-ship)
125− says.
126−- hits' docket has `%docket` get its glob from `~donmec-sallud` over Ames,
127− with a placeholder hash, so `hits.deskjam` is for that ship. There, install
128− it, then open `/docket/upload`, choose the desk `hits` and the folder
129− `result/hits-glob`, and click **glob!**. When you update hits with deskjam,
130− click **set** in the glob box on the confirm page first, or hits loses its
131− frontend until you upload it again. Other ships get hits, frontend
132− included, from that ship once it publishes hits:
133− `|install ~donmec-sallud %hits`.
143+Some apps' web frontends are globs, which aren't part of their desks.
144+Landscape's `%docket` agent gets an app's glob as its docket says, and the
145+build puts the glob's files next to the deskjam, as `result/<desk>-glob`. That
146+folder is what you upload at `/docket/upload`: choose the app's desk and the
147+folder, and click **glob!**. Use a browser other than Safari, which can't
148+upload folders.
149+
150+hits', silo's and vita's dockets have `%docket` get their globs from
151+`~donmec-sallud` over Ames, with a placeholder hash. On your ship:
152+
153+1. When you install the deskjam, click **set** in the glob box on the confirm
154+ page first, so your ship serves the glob instead. **set** reloads the page
155+ and clears the boxes below it, so tick **start its agents after uploading**
156+ after it, then confirm.
157+2. Once the app runs, upload its `result/<desk>-glob`.
158+
159+On `~donmec-sallud`, their dockets already name your ship, so skip **set**,
160+and just upload the glob. Without its glob, an app runs, but has no frontend.
161+deskjam's
162+[Serving a glob from your ship](https://github.com/iko-soy/deskjam/blob/main/docs/globs.md#serving-a-glob-from-your-ship)
163+has the details.
164+
165+When you update an app whose glob your ship serves, click **set** in the glob
166+box on the confirm page first, which keeps the glob your ship serves now.
167+Then upload the new `result/<desk>-glob`, so the frontend matches the new
168+version. If the app was suspended, as after a kernel update, `%docket`
169+forgets its glob when the app starts again, even after **set**: upload it
170+again.
171+
172+To let other ships install an app from yours, frontend included, publish it:
173+`:treaty|publish %hits` makes it public and lists it in Landscape, and
174+`|public %hits` is enough for `|install ~your-ship %hits`.
175+
176+The other apps have no glob: accountability, burn, deskjam, harness,
177+new-oxal and shelf serve their pages from their own agents. harness' frontend
178+is in its desk, so `harness.deskjam` already has it.
134179
135180### Kernel updates
136181
@@ -147,23 +192,45 @@ has the details, including what to do when an upload goes wrong.
147192
148193## How the desks are built
149194
150−- deskjam's, hits' and shelf's own flakes build their desks, so each
151− `.deskjam` file has the files that repo's own build makes. jammer leaves
152− out the files a `|commit` would skip too, such as hits' `LICENSE`, which has
153− no extension.
154−- mcp's repo builds its desk with `zig build`, which copies some files from
155− other repos at pinned commits. `flake.nix` copies the same files from the
156− same commits. After moving mcp's pin, check that its `build.zig` still lists
157− the same files and commits, and change `flake.nix` to match if not: nothing
158− checks this for you.
159−- silo has no flake. Its CI deploys all of urbit's `pkg/base-dev`, then
160− landscape's `desk-dev`, then its own `desk/`, and `flake.nix` builds the
161− same, with landscape at `master`, as the CI takes it, and urbit at
162− `408k-2`, since the CI's tag isn't public. After moving silo's pin, check
163− its `.github/helpers/deploy.sh`.
164−- A desk whose docket names a glob only builds with its glob, which
165− `flake.nix` builds from the app's `ui/`. A glob for a desk whose docket
166− names none fails the build too.
195+- deskjam's, hits', shelf's, silo's and vita's own flakes build their desks,
196+ so each `.deskjam` file has the files that repo's own build makes. jammer
197+ leaves out the files a `|commit` would skip too, such as hits' `LICENSE`,
198+ which has no extension. silo's and vita's flakes build their globs too, and
199+ this flake takes them as they are, with the nixpkgs those flakes pin: so
200+ `github:iko-soy/urbit-apps#silo-glob` is the same build as
201+ `github:iko-soy/silo#glob`. Their desks
202+ include all of urbit's base-dev, so deskjam's confirm page warns about a
203+ few of its libraries that import files the desks lack, but the apps don't
204+ use them.
205+- accountability has no flake, and its `desk/` is the whole desk, which
206+ `flake.nix` packs as it is.
207+- burn has no flake either. Its repo holds two whole desks, `burn/` and
208+ `new-oxal/`, which `flake.nix` packs as they are, as `%burn` and
209+ `%new-oxal`.
210+- harness' repo builds its desk with `zig build`. It builds `fe/`, its
211+ frontend, into the desk's `web/`, which harness' own agent serves; fetches
212+ grubbery and some of Tlon's files with git, at commits it pins; and patches
213+ grubbery's desk under harness' own. `flake.nix` runs the same `zig build`
214+ with npm's packages fetched ahead, and a stand-in `git` that answers from
215+ inputs pinned to the same commits, and fails if the build asks for any
216+ other. When a new version of harness pins other commits, change the commit
217+ in `harness-grubbery`'s or `harness-tlon`'s url in `flake.nix` to the one
218+ the error names: `nix flake update` won't move them. The build also fails
219+ if the desk has no `web/index.html`, so it can't come out without its
220+ frontend. Two of grubbery's libraries in it, `lib/verb.hoon` and
221+ `lib/xray.hoon`, import files the desk lacks, so deskjam's confirm page
222+ warns about them, but harness doesn't use them.
223+- A desk whose docket names a glob only builds with its glob, and a glob for
224+ a desk whose docket names none fails the build too. `flake.nix` reads each
225+ docket as the docket mark does, with Hoon's own parser in `urbit eval`, so
226+ this holds however the docket is laid out, and a docket that isn't valid
227+ fails the build.
228+- A hash in `flake.nix` pins the npm packages of the frontends it builds
229+ itself: `hits-glob`'s `npmDepsHash`, and the `hash` of harness' `npmDeps`.
230+ silo's and vita's are in their own flakes. When moving an app's pin changes
231+ its `package-lock.json`, its build stops with a hash mismatch, or
232+ `npmDepsHash is out of date`. Set that hash to `pkgs.lib.fakeHash`, build
233+ again, and put the hash the error shows after `got:` in its place.
167234
168235## jammer
169236
flake.lock+206−83
@@ -1,5 +1,37 @@
11{
22 "nodes": {
3+ "accountability": {
4+ "flake": false,
5+ "locked": {
6+ "lastModified": 1792368005,
7+ "narHash": "sha256-PwbQoFYi6LMMjfZB1PLdc6lbWx4aZhw2J87uJuMV57U=",
8+ "owner": "sigilante",
9+ "repo": "accountability",
10+ "rev": "1099d293caa1aaf27945bfedc8752367a472e6d2",
11+ "type": "github"
12+ },
13+ "original": {
14+ "owner": "sigilante",
15+ "repo": "accountability",
16+ "type": "github"
17+ }
18+ },
19+ "burn": {
20+ "flake": false,
21+ "locked": {
22+ "lastModified": 1786378297,
23+ "narHash": "sha256-wezDIDk5CUhMXP2SDexV0c3xznZ7SbPx9vAoRTQaitM=",
24+ "owner": "brbenji",
25+ "repo": "burn",
26+ "rev": "bcc3613ebec2c20d69cb2b3658b43b5ea4134b69",
27+ "type": "github"
28+ },
29+ "original": {
30+ "owner": "brbenji",
31+ "repo": "burn",
32+ "type": "github"
33+ }
34+ },
335 "deskjam": {
436 "inputs": {
537 "fang-suite": "fang-suite",
@@ -13,11 +45,11 @@
1345 "urbit": "urbit"
1446 },
1547 "locked": {
16− "lastModified": 1792565467,
17− "narHash": "sha256-kkNjvyRPQf1CS+cYHDAuUK7LuEJJkT3Q9e4swcfh1Xc=",
48+ "lastModified": 1792584136,
49+ "narHash": "sha256-YnMsLXViNtQi+B029JFuVFYM8IzjGxPQLUCOPjlaktQ=",
1850 "owner": "iko-soy",
1951 "repo": "deskjam",
20− "rev": "0da5be5e86de673dc8c5f8586b48143d7d9a3d67",
52+ "rev": "d0bb6b31803336e66a19ee6daeedd98a02813bd4",
2153 "type": "github"
2254 },
2355 "original": {
@@ -61,6 +93,56 @@
6193 "type": "github"
6294 }
6395 },
96+ "harness": {
97+ "flake": false,
98+ "locked": {
99+ "lastModified": 1792513104,
100+ "narHash": "sha256-6U6yLEUWVB0QfcwkiUW1Zio6rbjYVZ/aMQcVTfkxEhY=",
101+ "owner": "mopfel-winrux",
102+ "repo": "urbit-agent-harness",
103+ "rev": "5bde3d6ff4949a67cb94fe28294f29ea65ccfeb8",
104+ "type": "github"
105+ },
106+ "original": {
107+ "owner": "mopfel-winrux",
108+ "repo": "urbit-agent-harness",
109+ "type": "github"
110+ }
111+ },
112+ "harness-grubbery": {
113+ "flake": false,
114+ "locked": {
115+ "lastModified": 1788450026,
116+ "narHash": "sha256-pMiNAJBBzUOAhoX4ZkIsCsS3E8CkUsQHPJLHLDPb2g8=",
117+ "owner": "gwbtc",
118+ "repo": "grubbery",
119+ "rev": "20ef61108f4ffae0c40ccd90e0ee7ae4d475709f",
120+ "type": "github"
121+ },
122+ "original": {
123+ "owner": "gwbtc",
124+ "repo": "grubbery",
125+ "rev": "20ef61108f4ffae0c40ccd90e0ee7ae4d475709f",
126+ "type": "github"
127+ }
128+ },
129+ "harness-tlon": {
130+ "flake": false,
131+ "locked": {
132+ "lastModified": 1787842207,
133+ "narHash": "sha256-Lrwq0LFzRg275k/6gO+yd+qiiy8UR2Qbm12XFuz69pQ=",
134+ "owner": "tloncorp",
135+ "repo": "tlon-apps",
136+ "rev": "938f0c44d693f6f7391cca8107c7b3a40b834a01",
137+ "type": "github"
138+ },
139+ "original": {
140+ "owner": "tloncorp",
141+ "repo": "tlon-apps",
142+ "rev": "938f0c44d693f6f7391cca8107c7b3a40b834a01",
143+ "type": "github"
144+ }
145+ },
64146 "hits": {
65147 "inputs": {
66148 "nixpkgs": [
@@ -69,11 +151,11 @@
69151 "urbit": "urbit_2"
70152 },
71153 "locked": {
72− "lastModified": 1792571528,
73− "narHash": "sha256-OC1Yg4iinINxUmRfYD6b+615tsIfM62Uq4szkWshUpc=",
154+ "lastModified": 1792579499,
155+ "narHash": "sha256-DVg1FSxZd2kZrwCebUWirVWTaya6NpqLAgI5dkk9r9I=",
74156 "owner": "iko-soy",
75157 "repo": "hits",
76− "rev": "deaf7b9eaf51bd6a0df96cf74ee5a81126ba6608",
158+ "rev": "49f410ce92c29e8e1029e4302aa1f5d7a7e2b19d",
77159 "type": "github"
78160 },
79161 "original": {
@@ -99,29 +181,47 @@
99181 "type": "github"
100182 }
101183 },
102− "mcp": {
184+ "landscape_2": {
103185 "flake": false,
104186 "locked": {
105− "lastModified": 1792213278,
106− "narHash": "sha256-0sBWeeuxSHPvaXN2bf5dObvVRp375/qAfVAomm8HIrU=",
187+ "lastModified": 1781809004,
188+ "narHash": "sha256-jRsjR0oOcXFWOZZwNg7Fi946IxuYGUrktNcF/aZIHz4=",
107189 "owner": "tloncorp",
108− "repo": "mcp",
109− "rev": "489751a06e3308d8e176823acf021688b23bd90d",
190+ "repo": "landscape",
191+ "rev": "46c6ed8738082b6a94558710b1e3619befa83057",
110192 "type": "github"
111193 },
112194 "original": {
113195 "owner": "tloncorp",
114− "repo": "mcp",
196+ "ref": "develop",
197+ "repo": "landscape",
198+ "type": "github"
199+ }
200+ },
201+ "landscape_3": {
202+ "flake": false,
203+ "locked": {
204+ "lastModified": 1781809004,
205+ "narHash": "sha256-jRsjR0oOcXFWOZZwNg7Fi946IxuYGUrktNcF/aZIHz4=",
206+ "owner": "tloncorp",
207+ "repo": "landscape",
208+ "rev": "46c6ed8738082b6a94558710b1e3619befa83057",
209+ "type": "github"
210+ },
211+ "original": {
212+ "owner": "tloncorp",
213+ "repo": "landscape",
214+ "rev": "46c6ed8738082b6a94558710b1e3619befa83057",
115215 "type": "github"
116216 }
117217 },
118218 "nixpkgs": {
119219 "locked": {
120− "lastModified": 1792208399,
121− "narHash": "sha256-mN15cwddbOOIzzXSSwYUeRfOYeizz47Vy6y3Hzq6DuY=",
220+ "lastModified": 1792506237,
221+ "narHash": "sha256-Q/8KLB6jNfpaUN1HAedE/u/Et9feE/zYSsutBLKrCFk=",
122222 "owner": "NixOS",
123223 "repo": "nixpkgs",
124− "rev": "7a6522c868711d06e3a520bbcdfafe9806f4337f",
224+ "rev": "5adc50831c259f87faeb09ddf930d43597197473",
125225 "type": "github"
126226 },
127227 "original": {
@@ -131,19 +231,52 @@
131231 "type": "github"
132232 }
133233 },
234+ "nixpkgs_2": {
235+ "locked": {
236+ "lastModified": 1792503283,
237+ "narHash": "sha256-vhe2jyvRCgufWPqDuDq1S3t3ypE+ka46IFutV02xKso=",
238+ "owner": "NixOS",
239+ "repo": "nixpkgs",
240+ "rev": "cd4ea8d57de16f4810bc5f14207bac45fbf19f67",
241+ "type": "github"
242+ },
243+ "original": {
244+ "owner": "NixOS",
245+ "ref": "nixos-26.05",
246+ "repo": "nixpkgs",
247+ "type": "github"
248+ }
249+ },
250+ "nixpkgs_3": {
251+ "locked": {
252+ "lastModified": 1792502884,
253+ "narHash": "sha256-IoNisKcGbUjdd45qCqywGMCYmZ5EnkxezvLII0FWwNA=",
254+ "owner": "NixOS",
255+ "repo": "nixpkgs",
256+ "rev": "02c087f3fe673c9e317f206a627cb6b910336dbe",
257+ "type": "github"
258+ },
259+ "original": {
260+ "owner": "NixOS",
261+ "ref": "nixos-unstable",
262+ "repo": "nixpkgs",
263+ "type": "github"
264+ }
265+ },
134266 "root": {
135267 "inputs": {
268+ "accountability": "accountability",
269+ "burn": "burn",
136270 "deskjam": "deskjam",
137271 "flake-utils": "flake-utils",
272+ "harness": "harness",
273+ "harness-grubbery": "harness-grubbery",
274+ "harness-tlon": "harness-tlon",
138275 "hits": "hits",
139− "mcp": "mcp",
140276 "nixpkgs": "nixpkgs",
141277 "shelf": "shelf",
142278 "silo": "silo",
143− "silo-landscape": "silo-landscape",
144− "silo-urbit": "silo-urbit",
145− "tlon-apps": "tlon-apps",
146− "urbit": "urbit_3"
279+ "vita": "vita"
147280 }
148281 },
149282 "shelf": {
@@ -153,11 +286,11 @@
153286 ]
154287 },
155288 "locked": {
156− "lastModified": 1792533784,
157− "narHash": "sha256-5NHB+yqWIG/heOrp1YJ1FLQ9CvbwHUisMj28vSNNJPI=",
289+ "lastModified": 1792580705,
290+ "narHash": "sha256-LHPVjGLwQX6arH3N28HpW7L6bqxNcNrLQEnckXOhrBo=",
158291 "owner": "iko-soy",
159292 "repo": "shelf",
160− "rev": "868b75a07af54e5ecab8db21cae33e9b7d2869d4",
293+ "rev": "7bd213ef50331e5c1a483519beab6a5411300d61",
161294 "type": "github"
162295 },
163296 "original": {
@@ -167,55 +300,25 @@
167300 }
168301 },
169302 "silo": {
170− "flake": false,
303+ "inputs": {
304+ "landscape": "landscape_2",
305+ "nixpkgs": "nixpkgs_2",
306+ "urbit": "urbit_3"
307+ },
171308 "locked": {
172− "lastModified": 1782065203,
173− "narHash": "sha256-kzP/ArfkVr5hguMldPYzWfBDlOvQ42rYV062LesFoX4=",
174− "owner": "arthyn",
309+ "lastModified": 1792581195,
310+ "narHash": "sha256-ZNqCGv5+l5RtiEdT77dbYIlD4roYbQbG1uKnNeN+Vcw=",
311+ "owner": "iko-soy",
175312 "repo": "silo",
176− "rev": "912b7caf56a2b9d037ca0ae9a152013631bab72e",
313+ "rev": "2d145ca828134f0ab94103089cdd54776cc67b1d",
177314 "type": "github"
178315 },
179316 "original": {
180− "owner": "arthyn",
317+ "owner": "iko-soy",
181318 "repo": "silo",
182319 "type": "github"
183320 }
184321 },
185− "silo-landscape": {
186− "flake": false,
187− "locked": {
188− "lastModified": 1711487686,
189− "narHash": "sha256-Tm76Hb7hO5+LgMTZSJKor6Bla+L2Qto84i2a+I4FfUc=",
190− "owner": "tloncorp",
191− "repo": "landscape",
192− "rev": "90a17528a938eebda57e837b7fec76d543f5f7cf",
193− "type": "github"
194− },
195− "original": {
196− "owner": "tloncorp",
197− "ref": "master",
198− "repo": "landscape",
199− "type": "github"
200− }
201− },
202− "silo-urbit": {
203− "flake": false,
204− "locked": {
205− "lastModified": 1785851358,
206− "narHash": "sha256-eHoGwqirk7zMpOn/y8dKqozz5IiQ7nqek/ypxIOaRiU=",
207− "owner": "urbit",
208− "repo": "urbit",
209− "rev": "5a187fededc4582a34fcd6055c67bb63e0917b94",
210− "type": "github"
211− },
212− "original": {
213− "owner": "urbit",
214− "ref": "408k-2",
215− "repo": "urbit",
216− "type": "github"
217− }
218− },
219322 "systems": {
220323 "locked": {
221324 "lastModified": 1681028828,
@@ -231,41 +334,41 @@
231334 "type": "github"
232335 }
233336 },
234− "tlon-apps": {
337+ "urbit": {
235338 "flake": false,
236339 "locked": {
237− "lastModified": 1756165599,
238− "narHash": "sha256-VhdQTrzBUp1/xk0AkAII3kHKifZ+kl+JbRoe06zoCh8=",
239− "owner": "tloncorp",
240− "repo": "tlon-apps",
241− "rev": "9f0c94771e4773567a2f55a727ffa31b0f6e8e9f",
340+ "lastModified": 1784122708,
341+ "narHash": "sha256-9lrulpAMdMtc9OZ7LeRWHkAgnibLSiDiB+BVwcffiCs=",
342+ "owner": "urbit",
343+ "repo": "urbit",
344+ "rev": "0a9a312e133891937de9c4df1ebecad5cf669c7c",
242345 "type": "github"
243346 },
244347 "original": {
245− "owner": "tloncorp",
246− "repo": "tlon-apps",
247− "rev": "9f0c94771e4773567a2f55a727ffa31b0f6e8e9f",
348+ "owner": "urbit",
349+ "repo": "urbit",
350+ "rev": "0a9a312e133891937de9c4df1ebecad5cf669c7c",
248351 "type": "github"
249352 }
250353 },
251− "urbit": {
354+ "urbit_2": {
252355 "flake": false,
253356 "locked": {
254− "lastModified": 1784122708,
255− "narHash": "sha256-9lrulpAMdMtc9OZ7LeRWHkAgnibLSiDiB+BVwcffiCs=",
357+ "lastModified": 1785851358,
358+ "narHash": "sha256-eHoGwqirk7zMpOn/y8dKqozz5IiQ7nqek/ypxIOaRiU=",
256359 "owner": "urbit",
257360 "repo": "urbit",
258− "rev": "0a9a312e133891937de9c4df1ebecad5cf669c7c",
361+ "rev": "5a187fededc4582a34fcd6055c67bb63e0917b94",
259362 "type": "github"
260363 },
261364 "original": {
262365 "owner": "urbit",
366+ "ref": "408k-2",
263367 "repo": "urbit",
264− "rev": "0a9a312e133891937de9c4df1ebecad5cf669c7c",
265368 "type": "github"
266369 }
267370 },
268− "urbit_2": {
371+ "urbit_3": {
269372 "flake": false,
270373 "locked": {
271374 "lastModified": 1785851358,
@@ -282,20 +385,40 @@
282385 "type": "github"
283386 }
284387 },
285− "urbit_3": {
388+ "urbit_4": {
286389 "flake": false,
287390 "locked": {
288− "lastModified": 1777378893,
289− "narHash": "sha256-VDEAwDPNB85aPved38aDoNJFqbhJcF7bh7+jFxFAEf4=",
391+ "lastModified": 1785851358,
392+ "narHash": "sha256-eHoGwqirk7zMpOn/y8dKqozz5IiQ7nqek/ypxIOaRiU=",
290393 "owner": "urbit",
291394 "repo": "urbit",
292− "rev": "0f94550b941dfe046d9dff4a541330bd084e8cd1",
395+ "rev": "5a187fededc4582a34fcd6055c67bb63e0917b94",
293396 "type": "github"
294397 },
295398 "original": {
296399 "owner": "urbit",
400+ "ref": "408k-2",
297401 "repo": "urbit",
298− "rev": "0f94550b941dfe046d9dff4a541330bd084e8cd1",
402+ "type": "github"
403+ }
404+ },
405+ "vita": {
406+ "inputs": {
407+ "landscape": "landscape_3",
408+ "nixpkgs": "nixpkgs_3",
409+ "urbit": "urbit_4"
410+ },
411+ "locked": {
412+ "lastModified": 1792581006,
413+ "narHash": "sha256-6dr0bBsj1nY8YFZJshqhLaeqDZDFvPSXIw3MOJN8Bm0=",
414+ "owner": "iko-soy",
415+ "repo": "vita",
416+ "rev": "dc3554e22e7e68ccb36efcc8cc149561fe95afb8",
417+ "type": "github"
418+ },
419+ "original": {
420+ "owner": "iko-soy",
421+ "repo": "vita",
299422 "type": "github"
300423 }
301424 }
flake.nix+220−116
@@ -5,20 +5,6 @@
55 nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
66 flake-utils.url = "github:numtide/flake-utils";
77
8− mcp = {
9− url = "github:tloncorp/mcp";
10− flake = false;
11− };
12− # Desk dependencies pinned by mcp's build.zig.
13− urbit = {
14− url = "github:urbit/urbit/0f94550b941dfe046d9dff4a541330bd084e8cd1";
15− flake = false;
16− };
17− tlon-apps = {
18− url = "github:tloncorp/tlon-apps/9f0c94771e4773567a2f55a727ffa31b0f6e8e9f";
19− flake = false;
20− };
21−
228 # Builds its full desk itself, with the dependencies mortar.yaml pins.
239 deskjam = {
2410 url = "github:iko-soy/deskjam";
@@ -26,7 +12,7 @@
2612 inputs.flake-utils.follows = "flake-utils";
2713 };
2814
29− # Its packages.<system>.default is the full desk: it vendors its lib/,
15+ # Its packages.<system>.desk is the full desk: it vendors its lib/,
3016 # mar/ and sur/ files.
3117 shelf = {
3218 url = "github:iko-soy/shelf";
@@ -40,19 +26,35 @@
4026 inputs.nixpkgs.follows = "nixpkgs";
4127 };
4228
43− silo = {
44− url = "github:arthyn/silo";
29+ # silo's and vita's flakes build their desks and their globs, with the
30+ # nixpkgs they pin, so both come out as their own repos build them.
31+ silo.url = "github:iko-soy/silo";
32+ vita.url = "github:iko-soy/vita";
33+
34+ # Its desk/ is the full desk: it vendors its lib/, mar/ and sur/ files.
35+ accountability = {
36+ url = "github:sigilante/accountability";
37+ flake = false;
38+ };
39+
40+ # Two full desks: burn/, whose agent is the backend, and new-oxal/, which
41+ # serves burn's page at /new-oxal/plex.
42+ burn = {
43+ url = "github:brbenji/burn";
44+ flake = false;
45+ };
46+
47+ harness = {
48+ url = "github:mopfel-winrux/urbit-agent-harness";
4549 flake = false;
4650 };
47− # Desk dependencies, as silo's .github/helpers/deploy.sh takes them. It
48− # takes urbit at a tag from a repo variable; 408k-2 is the 408 kernel,
49− # the oldest silo's sys.kelvin lists.
50− silo-urbit = {
51− url = "github:urbit/urbit/408k-2";
51+ # The commits harness' build.zig and scripts/stage-tlon.mjs fetch.
52+ harness-grubbery = {
53+ url = "github:gwbtc/grubbery/20ef61108f4ffae0c40ccd90e0ee7ae4d475709f";
5254 flake = false;
5355 };
54− silo-landscape = {
55− url = "github:tloncorp/landscape/master";
56+ harness-tlon = {
57+ url = "github:tloncorp/tlon-apps/938f0c44d693f6f7391cca8107c7b3a40b834a01";
5658 flake = false;
5759 };
5860 };
@@ -61,15 +63,16 @@
6163 {
6264 nixpkgs,
6365 flake-utils,
64− mcp,
65− urbit,
66− tlon-apps,
6766 deskjam,
6867 shelf,
6968 hits,
7069 silo,
71− silo-urbit,
72− silo-landscape,
70+ vita,
71+ accountability,
72+ burn,
73+ harness,
74+ harness-grubbery,
75+ harness-tlon,
7376 ...
7477 }:
7578 # nixpkgs 26.11 dropped x86_64-darwin, and the apps' own flakes build their
@@ -83,9 +86,16 @@
8386 jammer = pkgs.rustPlatform.buildRustPackage {
8487 pname = cargoToml.package.name;
8588 version = cargoToml.package.version;
86− src = pkgs.lib.cleanSourceWith {
87− src = ./jammer;
88− filter = path: type: !(type == "directory" && baseNameOf path == "target");
89+ # Only what cargo builds and tests, so editing the README doesn't
90+ # rebuild jammer and every deskjam.
91+ src = pkgs.lib.fileset.toSource {
92+ root = ./jammer;
93+ fileset = pkgs.lib.fileset.unions [
94+ ./jammer/Cargo.toml
95+ ./jammer/Cargo.lock
96+ ./jammer/src
97+ ./jammer/tests
98+ ];
8999 };
90100 cargoLock.lockFile = ./jammer/Cargo.lock;
91101 meta = {
@@ -94,9 +104,44 @@
94104 };
95105 };
96106
97− # Pack a desk into $out/<desk>.deskjam. `src` is copied as the base of
98− # the desk, then each entry of `imports` copies `paths` (relative to
99− # the desk root) from the directory `from`.
107+ # Reads the docket file it's given as the docket mark does, with
108+ # `ream` and `slap` in `urbit eval`, so any layout Hoon accepts reads
109+ # the same. Exits 0 if it names a glob: a glob-http or glob-ames
110+ # clause, and no site clause, which lib/docket prefers. Exits 1 if
111+ # it doesn't, and 2 if it isn't a valid docket.
112+ names-glob = pkgs.writeShellApplication {
113+ name = "names-glob";
114+ runtimeInputs = [
115+ pkgs.urbit
116+ pkgs.util-linux
117+ ];
118+ excludeShellChecks = [ "SC2016" ];
119+ text = ''
120+ # the file's bytes as a Hoon @ux literal: an atom, first byte
121+ # lowest, with a dot between each group of four hex digits
122+ hex=$(od -An -v -tx1 -w1 "$1" | tac | tr -d ' \n' | sed 's/^0*//')
123+ atom=0x$(printf '%s' "''${hex:-0}" | rev | sed -E 's/([0-9a-f]{4})/\1./g; s/\.$//' | rev)
124+ out=$(
125+ {
126+ printf '=/ tex `@t`%s\n' "$atom"
127+ echo '=/ cls ;;((list [@tas *]) q:(slap !>(~) (ream tex)))'
128+ echo '=/ has |=(t=@tas (lien cls |=([h=@tas *] =(h t))))'
129+ echo '?&(!(has %site) |((has %glob-http) (has %glob-ames)))'
130+ } | urbit eval 2>&1 | sed 's/\x1b\[[0-9;]*m//g' | tr -d '\r'
131+ )
132+ case $(printf '%s\n' "$out" | tail -n 1) in
133+ '%.y') exit 0 ;;
134+ '%.n') exit 1 ;;
135+ *)
136+ echo "$1 isn't a valid docket: Hoon can't read it as a list of clauses" >&2
137+ printf '%s\n' "$out" >&2
138+ exit 2
139+ ;;
140+ esac
141+ '';
142+ };
143+
144+ # Pack the desk `src` into $out/<desk>.deskjam.
100145 #
101146 # When the desk's docket names a glob, its frontend (glob-ames or
102147 # glob-http), `glob` must be the built frontend, which goes next to the
@@ -107,84 +152,48 @@
107152 {
108153 desk,
109154 src,
110− imports ? [ ],
111155 glob ? null,
112156 }:
113− pkgs.runCommand "${desk}.deskjam" { nativeBuildInputs = [ jammer ]; } ''
114− cp -r --no-preserve=mode ${src} ${desk}
115− ${pkgs.lib.concatMapStrings (
116− { from, paths }:
117− pkgs.lib.concatMapStrings (path: ''
118− install -D -m 644 ${from}/${path} ${desk}/${path}
119− '') paths
120− ) imports}
121− glob=${toString glob}
122− if grep -Eqs '(^|[[:space:]])glob-(ames|http)\+' ${desk}/desk.docket-0; then
123− if [ -z "$glob" ]; then
124− echo "The docket of %${desk} names a glob: give mkDeskjam the built frontend as glob" >&2
125− exit 1
126− fi
127− elif [ -n "$glob" ]; then
128− echo "The docket of %${desk} names no glob, but mkDeskjam got one" >&2
129− exit 1
130− fi
131− mkdir $out
132− jammer jam ${desk} -d ${desk} -o $out/${desk}.deskjam
133− if [ -n "$glob" ]; then
134− cp -r --no-preserve=mode "$glob" $out/${desk}-glob
135− fi
136− '';
137−
138− # Mirrors the dependency list in mcp's build.zig.
139− mcp-desk = mkDeskjam {
140− desk = "mcp";
141− src = "${mcp}/desk";
142− imports = [
143− {
144− from = "${urbit}/pkg/arvo";
145− paths = [ "lib/pretty-file.hoon" ];
146− }
157+ pkgs.runCommand "${desk}.deskjam"
147158 {
148− from = "${tlon-apps}/desk";
149− paths = [ "lib/test-agent.hoon" ];
150− }
151− {
152− from = "${urbit}/pkg/base-dev";
153− paths = [
154− "lib/dbug.hoon"
155− "lib/default-agent.hoon"
156− "lib/server.hoon"
157− "lib/skeleton.hoon"
158− "lib/strand.hoon"
159− "lib/strandio.hoon"
160− "lib/test.hoon"
161− "lib/verb.hoon"
162− "mar/bill.hoon"
163− "mar/hoon.hoon"
164− "mar/json.hoon"
165− "mar/kelvin.hoon"
166− "mar/mime.hoon"
167− "mar/noun.hoon"
168− "mar/ship.hoon"
169− "mar/sole/action.hoon"
170− "mar/sole/effect.hoon"
171− "mar/txt.hoon"
172− "sur/sole.hoon"
173− "sur/spider.hoon"
174− "sur/verb.hoon"
159+ nativeBuildInputs = [
160+ jammer
161+ names-glob
175162 ];
176163 }
177− ];
178− };
164+ ''
165+ cp -r --no-preserve=mode ${src} ${desk}
166+ glob=${pkgs.lib.optionalString (glob != null) "${glob}"}
167+ names=
168+ if [ -f ${desk}/desk.docket-0 ]; then
169+ if names-glob ${desk}/desk.docket-0; then
170+ names=yes
171+ elif [ $? != 1 ]; then
172+ exit 1
173+ fi
174+ fi
175+ if [ -n "$names" ] && [ -z "$glob" ]; then
176+ echo "The docket of %${desk} names a glob: give mkDeskjam the built frontend as glob" >&2
177+ exit 1
178+ elif [ -z "$names" ] && [ -n "$glob" ]; then
179+ echo "%${desk} has no docket that names a glob, but mkDeskjam got one" >&2
180+ exit 1
181+ fi
182+ mkdir $out
183+ jammer jam ${desk} -d ${desk} -o $out/${desk}.deskjam
184+ if [ -n "$glob" ]; then
185+ cp -r --no-preserve=mode "$glob" $out/${desk}-glob
186+ fi
187+ '';
179188
180189 deskjam-desk = mkDeskjam {
181190 desk = "deskjam";
182− src = deskjam.packages.${system}.deskjam;
191+ src = deskjam.packages.${system}.desk;
183192 };
184193
185194 shelf-desk = mkDeskjam {
186195 desk = "shelf";
187− src = shelf.packages.${system}.default;
196+ src = shelf.packages.${system}.desk;
188197 };
189198
190199 # Build a frontend: `npm run build` in its npm project `src`, whose
@@ -217,35 +226,130 @@
217226 glob = hits-glob;
218227 };
219228
220− silo-glob = mkGlob {
229+ silo-desk = mkDeskjam {
221230 desk = "silo";
222− src = "${silo}/ui";
223− npmDepsHash = "sha256-kZaVn4+ORa9Cm100f8/VS1sCWwHOC6rxDvLnz4S5+p0=";
231+ src = silo.packages.${system}.desk;
232+ glob = silo.packages.${system}.glob;
224233 };
225234
226− # The desk silo's deploy.sh commits: all of urbit's pkg/base-dev, then
227− # landscape's desk-dev, then silo's desk/ over them.
228− silo-desk = mkDeskjam {
229− desk = "silo";
230− src = pkgs.runCommand "silo-desk" { } ''
231− mkdir $out
232− cp -rL --no-preserve=mode ${silo-urbit}/pkg/base-dev/. $out/
233− cp -rL --no-preserve=mode ${silo-landscape}/desk-dev/. $out/
234− cp -rL --no-preserve=mode ${silo}/desk/. $out/
235+ vita-desk = mkDeskjam {
236+ desk = "vita";
237+ src = vita.packages.${system}.default;
238+ glob = vita.packages.${system}.glob;
239+ };
240+
241+ accountability-desk = mkDeskjam {
242+ desk = "accountability";
243+ src = "${accountability}/desk";
244+ };
245+
246+ burn-desk = mkDeskjam {
247+ desk = "burn";
248+ src = "${burn}/burn";
249+ };
250+
251+ new-oxal-desk = mkDeskjam {
252+ desk = "new-oxal";
253+ src = "${burn}/new-oxal";
254+ };
255+
256+ # harness' build.zig fetches grubbery, and its scripts/stage-tlon.mjs
257+ # Tlon's files, with git, at commits they pin. This git answers from
258+ # the inputs pinned to the same commits, and fails on any other, so a
259+ # new pin upstream stops the build until the inputs follow it.
260+ harness-git = pkgs.writeShellScriptBin "git" ''
261+ set -eu
262+ if [ "$1" != -C ]; then
263+ echo "git: unexpected command: $*" >&2
264+ exit 1
265+ fi
266+ repo=$2
267+ shift 2
268+ case $repo in
269+ desk-deps/grubbery) src=${harness-grubbery} rev=${harness-grubbery.rev} ;;
270+ desk-deps/tlon) src=${harness-tlon} rev=${harness-tlon.rev} ;;
271+ *) echo "git: unexpected repo: $repo" >&2; exit 1 ;;
272+ esac
273+ pinned() {
274+ if [ "$1" != "$rev" ]; then
275+ echo "git: $repo is pinned to $rev, but the build wants $1" >&2
276+ exit 1
277+ fi
278+ }
279+ case $1 in
280+ init | remote) ;;
281+ cat-file) pinned "''${3%"^{commit}"}" ;;
282+ checkout | fetch) for arg; do :; done; pinned "$arg" ;;
283+ show) pinned "''${2%%:*}"; cat "$src/''${2#*:}" ;;
284+ *) echo "git: unexpected command: $*" >&2; exit 1 ;;
285+ esac
286+ '';
287+
288+ # The desk harness' build.zig assembles: desk/, with fe/ built into
289+ # its web/, over a pruned and patched grubbery desk, with Tlon's files.
290+ # build.zig runs npm itself, which can't work in the sandbox, so fe/ is
291+ # built here first instead.
292+ harness-src = pkgs.stdenv.mkDerivation {
293+ name = "harness-desk";
294+ src = harness;
295+ npmRoot = "fe";
296+ npmDeps = pkgs.fetchNpmDeps {
297+ name = "harness-fe-npm-deps";
298+ src = "${harness}/fe";
299+ hash = "sha256-m5yMZFEUJV4HPrvWRIIyJ7psXy43W+4gZEcrcHHFdu4=";
300+ };
301+ nativeBuildInputs = [
302+ pkgs.zig_0_15
303+ pkgs.nodejs
304+ pkgs.npmHooks.npmConfigHook
305+ harness-git
306+ ];
307+ postPatch = ''
308+ substituteInPlace build.zig \
309+ --replace-fail 'try run(step, &.{ "npm", "ci", "--prefix", "fe", "--no-audit", "--no-fund" });' "" \
310+ --replace-fail 'try run(step, &.{ "npm", "run", "build", "--prefix", "fe" });' ""
311+ '';
312+ buildPhase = ''
313+ runHook preBuild
314+ npm run build --prefix fe
315+ mkdir -p desk-deps
316+ cp -r --no-preserve=mode ${harness-grubbery} desk-deps/grubbery
317+ ZIG_GLOBAL_CACHE_DIR=$TMPDIR/zig zig build
318+ runHook postBuild
235319 '';
236− glob = silo-glob;
320+ installPhase = ''
321+ runHook preInstall
322+ if [ ! -f zig-out/web/index.html ]; then
323+ echo "harness' desk has no web/index.html: its frontend is missing" >&2
324+ exit 1
325+ fi
326+ cp -r zig-out $out
327+ runHook postInstall
328+ '';
329+ # the output is a desk: leave its files as they are
330+ dontFixup = true;
331+ };
332+
333+ harness-desk = mkDeskjam {
334+ desk = "harness";
335+ src = harness-src;
237336 };
238337 in
239338 {
240339 packages = {
241340 inherit jammer;
242− mcp = mcp-desk;
243341 deskjam = deskjam-desk;
244342 shelf = shelf-desk;
245343 hits = hits-desk;
246344 inherit hits-glob;
247345 silo = silo-desk;
248− inherit silo-glob;
346+ silo-glob = silo.packages.${system}.glob;
347+ vita = vita-desk;
348+ vita-glob = vita.packages.${system}.glob;
349+ accountability = accountability-desk;
350+ harness = harness-desk;
351+ burn = burn-desk;
352+ new-oxal = new-oxal-desk;
249353 default = jammer;
250354 };
251355