Reference
Command line#
Verb |
Does |
|---|---|
|
start the writer if it is down, print |
|
the writer alone |
|
up or down; counts by kind, the pin, the index and dense state; |
|
the port, the URL, the daemon binary |
|
one lesson |
|
one standing preference |
|
ranked claims live now, or those live at |
|
claims whose review clock has run out, soonest first |
|
the link graph’s clusters, largest first: size and first claim |
|
the claims the link graph turns on, highest first: a weighted PageRank over the links |
|
the memories a cue activates: activation, seed mark, id, text; |
|
the neglect sweep now: reviews left due past twice their interval lapse; a never-recalled forgettable claim missed three times is tombstoned |
|
drop a scratch workspace’s atoms whole, no tombstones and no deed; per-run scratch workspaces call this on the way out so the long-lived writer does not keep every run’s atoms |
|
these claims fired together; their links gain weight, their other links lose a little |
|
mark a review recalled, or lapsed |
|
read or set the pinned set; an empty name clears it |
|
deed accessions the live claims cite |
|
live-now claims, or those live at |
|
the live claims citing one accession |
|
claims to |
A workspace argument defaults to PACKSET_WORKSPACE, else the git remote of
the working directory, else default.
Every verb takes -h or --help: it prints that verb’s usage and runs
nothing, wherever it appears before --. A flag the verb does not take is
refused rather than read as a workspace, an id or a word of the text. --
ends the flags, so packset forget -- -odd names a workspace that starts
with a dash.
HTTP#
The writer listens on 127.0.0.1 only. Bodies are JSON.
Request |
Does |
|---|---|
|
|
|
counts, pin, index and dense state; |
|
names with live counts |
|
store one claim; returns the stored record, or the live duplicate |
|
live claims, or those live at |
|
one record, whatever its state |
|
merge fields into one live claim |
|
tombstone; |
|
|
|
ranked hits, the engine, the stage; a hit the encoder named carries |
|
the link graph’s communities, largest first |
|
the claims the link graph turns on, highest first, with their scores |
|
the cluster a cue activates: top hits as seeds, two hops along the links, as |
|
|
|
|
|
|
|
the replacement rule over the live set in written order; |
|
accessions the live claims cite |
|
claims citing one accession |
|
the pinned set |
|
a set’s three cards |
|
the cards and the atoms as one document |
|
the seat card, the workspace card |
|
hold one body for the next turn |
|
proposals a person accepts into claims |
A refusal is a 4xx with error as one line: the reason a claim was not
stored, quoted back.
The atom#
Schema inside.atom/v1. Fields the writer reads:
Field |
Meaning |
|---|---|
|
one of |
|
|
|
|
|
the claim: at most two sentences of at most twenty-five words for an agent’s proposal or a hook’s write; a person’s write past that is stored, with the reason in |
|
required |
|
optional; a checked name |
|
names the claim is about; an entity shaped like an accession must be one; |
|
first written, and the window it was true; |
|
the last write: a link rewrite, a review, a closed window, an update or a tombstone; a pack written before 0.15.3 gets it at open, and |
|
the ids a contrary claim closed: an explicit id, a correction sharing an entity, a rewrite (token Jaccard 0.6), or the same opening words with a new object; a rewrite never crosses a different |
|
the review clock: |
|
on a tombstone the writer made: |
|
peers by entity overlap, at most eight, chosen by relative-neighbourhood pruning; |
|
weight per link in (0, 1], absent meaning 0.5; moved by |
|
a persona’s own weights by name, written by a fire |
|
a |
|
a |
|
a |
|
a |
|
an |
A message is one letter, a receipt is one read, and a group atom is one
membership change. A later mail atom does not close an earlier one, and a
repeat is kept. Search and recall leave mail out unless kind names it.
GET /v1/atoms still lists it.
Fields the writer does not model round-trip untouched.
The review clock#
A new claim is due after one day. grade with recalled grows stability
by how overdue the claim was; lapsed halves it and raises difficulty. The
retrievability at t days since the last review with stability S is
R = (1 + 19/81 * t/S)^(-1/2), so R(S) = 0.9. PACKSET_DECAY=fsrs scales
a search score by R, floored at 0.25; cards are never scaled.
Environment#
Variable |
Read by |
Meaning |
|---|---|---|
|
clients |
the writer; |
|
|
the port; default 8761 |
|
|
the pack home; default |
|
clients |
the workspace when none is given |
|
clients |
how long one request may take, default thirty seconds; a busy writer is asked again after 50, 150 and 450 ms inside it |
|
|
requests answered at once, default 4, at most 8; with two or more, searches and writes hold all but one |
|
|
connections that may wait to be read, default 128, at most 4096; searches and writes that a worker has read but cannot yet run are bounded the same way; past either a request is answered 503; |
|
writer |
the panel |
|
writer |
live claims a workspace keeps before the write that crosses it forgets the least retrievable forgettable ones; default twenty thousand, |
|
writer |
a file that receives one line per write with the time each stage took |
|
writer |
query encoders kept side by side, default 1; each loads one model into memory; a waiter takes whichever slot frees first; a batch spreads over the free slots; writes yield a slot to a waiting query |
|
writer |
|
|
writer |
the encoder binary; else beside the writer, else on |
|
encoder |
where models live; default |
|
encoder |
hub layout of the named model ( |
|
build |
directory of a source or system build of the Open Neural Network Exchange (ONNX) Runtime; |
|
encoder |
|
|
encoder |
|
|
writer, encoder |
the second stage on every search, and its model |
Crates#
Crate |
Carries |
|---|---|
|
the atom, the prose limit, BM25+, the scan, the panel, decay, review clock |
|
|
|
the HTTP client every tool uses |
|
the |
|
the read-only Model Context Protocol (MCP) surface, built by |
|
dense, late, sparse and cross-encoder models as one child process |