One JSON object per line, newline-delimited, over the flea --backend child's stdin
and stdout. No batching, no length prefix: Quickshell.Io.Process reads with a
SplitParser on \n. Implemented in src/backend/proto.rs over the field scanner and
escaper in src/json.rs, dispatched by src/backend/run.rs.
- A successful
listis always followed by arowsline, even whenfirstis 0, in which case the array is empty. Alistwhose path cannot be read answers a singleerrorline instead, and norowsline follows. - Errors are messages, never exit statuses.
--backendruns until it readsquitor stdin closes, and returns exit code 0 either way; every failure is anerrorline the client reads off stdout, not a process exit code. - Exactly one line arrives unasked:
changed, which says the listed directory was altered by another program. It can land between any request and its reply, so a client that counts lines rather than reading theirtfield will misread the wire. - A row index means a file only in the numbering it was read from. Every
rowsline names that numbering aslisting, and atrash,transfer,link,paths,collisions,settagsormenuactionthat names an older one is refused before anything resolves; see "listing" below.
"listing":<uint> on a request that carries rows
Example: {"c":"trash","rows":[0],"menuId":0,"listing":7}
The backend numbers its rows, and the number moves whenever what an index names changes: a
successful list or listpaths, a search, an accepted sort, and a walk's ranking. Every rows
line carries the numbering it was written in as its last field, "listing":<uint>, and the first
listing a backend makes is 1. A client names the numbering of the rows it read an index from on any
request that carries rows. A trash, transfer, link, paths, collisions, settags or menuaction whose listing is not
the numbering in force is refused before a single index is resolved: trash, transfer, link, paths,
collisions and settags answer {"t":"error","where":"stale","path":"<the command>","msg":"..."} and nothing else, and a
menuaction answers its own reply with "ok":false and an error sentence. Nothing was done in
either case, so a client that wants the action reads the new rows and asks again.
A request that names no listing is resolved against the listing in force, exactly as before the
field existed, so an older client and a hand-written line keep working. thumb, thumbcancel,
dirsize, meta, tagstates and window read and never act on a file, so they are not refused; a client drops
their answers for a listing it has left. The race this closes is a request written after a list
and before its rows reached the client: the backend has the new listing by then, and without the
field it resolved the old index against it, so list A, list B, paths [0] answered B's first file.
The picker may include an unsigned pickerGen request generation. Every JSON frame
emitted for that listing (including initial rows and failures) echoes pickerGen.
The picker drops any reply whose pickerGen is not its current generation: a superseded
remote scan can finish without answering, so counting outstanding replies cannot identify
the current list. Replies without the field, such as window rows, are handled as before.
Requests without pickerGen retain their existing reply format.
{"c":"list","path":"<string>","first":<uint>,"hidden":<bool>}
Example: {"c":"list","path":"/home/gm","first":350,"hidden":false}
Scans path (phase 1: names and the directory bit only), applies ordering, and
answers a listed line followed immediately by a rows line
covering rows 0..first, or the window select below moves onto its row. A path that fails to scan answers a single error line
instead and leaves the previously listed directory in place: a failed list cannot
mix a new path with the old listing. A missing path defaults to the empty string,
a missing first defaults to 0.
Optional by, desc, foldersFirst, and groupByKind fields use the ordering
rules described under sort. A list with no ordering fields uses name ascending,
directories first, without kind groups. Unlike an explicit sort, a list may
omit by. An invalid ordering key refuses the new listing and keeps the previous
directory and rows.
Optional hiddenLast, false unless true: with it on, dotfiles form an outer
partition, a visible block then a hidden block, for each of the four keys in both
directions, and foldersFirst or groupByKind orders inside each block, so visible
folders come first, then visible files, then hidden folders, then hidden files. Off
leaves dotfiles to follow the sort key like any other name. Absent is off, so an
older client keeps it.
hidden of false, or a missing hidden, drops every name starting with . before
it ever reaches the listing: the filter runs inside the scan itself, not as a later
pass over it, so a hidden directory costs nothing beyond the readdir entry it was
always going to read. hidden of true scans dotfiles in too, ordered the same as
everything else. There is no separate flag to ask for dotfiles without also
re-scanning: sort reorders whichever listing list last produced and cannot add or
remove rows, so changing hidden always means a fresh list, which is also what
clears the cursor and selection back to row 0.
Optional wantChanged, false unless true: with it on, a list that re-reads the
directory already listed names added plus removed rows in changed. Absent is off, so
every navigation and watched re-read stays silent and pays no count.
Optional keep, an array of full folder paths such as ["/home/gm/Music"]: the folders the
client's other tabs show. Settled folder sizes (see dirsize) for rows of those folders, and of
the folder this list lands on, outlive the new listing; every other settled size is dropped
when it lands. Absent keeps only the listed folder's own, so an older client still reuses sizes
across a re-read, a sort or a hidden change of the same folder. The TUI names every tab but the
current one.
Optional select, a full path such as "/home/gm/notes.txt": when it names a row of the new
listing at index first or past it, the rows line covers the first rows that hold that row
near their middle, starting at index - first / 2 and clamped so the window ends at the last
row, instead of 0..first; its start says where. A row inside 0..first, a name the listing
does not hold, a path in another directory or an absent select answers 0..first as before.
The lookup reads only the listing's name arena, matching names exactly the way locate does,
and stats nothing beyond the window it answers. The client asks for the directory with the row
it will put the cursor on, so a row sorted far down lands in the listing's first rows reply.
{"c":"locate","path":"/directory/selected.txt"}
Returns {"t":"located","directory":"/directory","path":"/directory/selected.txt","index":42}
for a name already in the current listing, or index:-1 when absent or invalid. This reads only
the listing's name arena; it does not stat files, resolve symlinks or scan another directory.
The client must match both directory and the requested path before using the index, then
fetch only the viewport containing that row. This is location in the current listing, not proof
that the filesystem object still exists or has the same identity for a later operation.
{"c":"locate","paths":["/directory/selected.txt"],"id":7,"menuId":4} resolves a batch
in one scan of the name arena. The reply carries directory, the request id, ok, error,
and matches:[{"path":"/directory/selected.txt","index":42}]. Missing paths are omitted,
duplicates produce one match, and results follow listing order. No unrequested path is returned.
Without menuId, this has the same name-only semantics as the single-path form. With menuId,
each matched survivor must still have the device, inode and file type captured by that completed
permanent deletion. This explicitly requested survivor check stats only matched paths.
The backend retains one completed deletion's identities for this read-only purpose even after
menuaction/close has expired the mutable selection. An expired restoration identity returns
ok:false and no matches. Clients must also reject replies after navigation, selection changes,
or replacement of the pending request, and fetch metadata only for the visible window.
{"c":"menuaction","op":"activate","id":4,"action":"duplicate"} revalidates the
selection captured by snapshot before the GUI dispatches a selected-item menu action.
The response echoes id, op, and action, with ok and error. Captured selection paths
are returned for validate, and for activate when the action needs resolved paths for client-side
dispatch; other activations return an empty array. taildrop:* and sharelink return the captured
cursor path instead.
The client also rechecks its listing identity and current action eligibility before dispatch.
An optional menuId on transfer, trash, duplicate, rename, archive, or convert
binds that operation to the captured selection. An expired selection, replacement object,
or uncaptured requested source is refused. Transfer uses the captured sources directly;
Trash, Duplicate, Archive, and Convert require the entire requested source set to match.
Identity checks compare the device, inode and file type at the worker boundary; Trash checks again immediately before its existing GIO
batch handoff. These checks do not make subsequent external-helper filesystem operations
atomic. Omitting menuId preserves the existing keyboard and protocol entry paths.
{"c":"menuaction","op":"snapshot","id":4,"rows":[0,2]} captures the selected identities
from the active listing. A Columns neighbour menu instead sends explicit absolute paths and
cursorPath, without navigating or changing that listing. Both forms accept the active listing
stamp and return count, modes (complete mode bits), and kinds, an array of each captured item's own file
type bits in request order, including symlinks without following them. prepareDelete with that
id reviews the captured trees and returns a
fresh token, selected count, and total bytes. checkDelete with the id and token returns
valid without mutating files. A changed set requires refreshDelete: it reviews only the same
captured paths, drops missing paths, captures replacement identities, and issues a fresh token.
Unrelated paths cannot widen that confirmation.
menuaction operations tagstates (with a client tagId) and settags (with change and tag)
read and update the identities retained by id. They return the existing tagstates and settagged
replies. A changed or replaced source refuses before writing; successful writes retain tag undo.
The client shows this new confirmation with
Cancel initially focused; no prior destructive activation authorizes the replacement token.
{"c":"menuaction","op":"delete","id":4,"token":12} consumes that exact token and reserves
the ordinary mutation slot. A failed preflight returns stale:true and requires a fresh review;
it does not delete any item. A completed attempt returns deleted, failed, cancelled,
error, and remaining absolute paths whose original identities survive. Results report partial
completion rather than implying rollback. The caller can use the identity-checked batched
locate form to select survivors after refreshing the listing.
close expires the token and cancels pending work. An already claimed deletion root completes
or restores its survivors before cancellation stops the next root. The undo journal does not
cover permanent deletion.
{"c":"menuaction","op":"properties","id":4} describes the identities captured by snapshot.
For one item the existing single-item reply is unchanged. For several items it returns kinds,
combined bytes, and newest and oldest, the selected entries' own modification dates in local
time as YYYY-MM-DD HH:MM. Kinds are counted in this order, omitting empty groups: folders,
symbolic links, texts, images, videos, audio files, files and special files. Regular files use the MIME
name database's text, image, video and audio groups, with all other regular files grouped as files.
Counts use singular words for one and comma grouping for thousands, for example 2 images, 1 video.
No file contents are opened to classify them, and a symbolic link keeps its own kind, size and date.
A selection containing folders first answers its known file bytes with done:false, then walks
each selected folder on demand using the same walker as contents. A selection on a remote mount
or containing a remote mountpoint has one 15-second bound covering initial metadata, every walk
and final identity revalidation; cancellation frees the menu worker without waiting for a blocked
remote syscall. A deadline ends with the retained floor, done:true,partial:true. A worker lost
before a terminal reply returns ok:false,error:"The selected items stopped answering.".
Before initial metadata completes, kinds, newest and oldest are empty and bytes includes
only inspected non-folder entries. A silent syscall marks its current remote mount stuck; a
subsequent request involving that mount returns a zero partial floor before any stat. Each total
includes the selected folders' own entries, stays on each starting device and never follows links.
Each queued child opens without following links through a held directory descriptor and must
still match its captured identity. A replaced or unreadable descendant leaves a partial floor.
Progress and the final reply have the same shape:
{"t":"menuaction","id":4,"op":"properties","ok":true,"kinds":"2 images, 1 video","bytes":52300000,"newest":"2026-09-23 10:14","oldest":"2026-08-21 12:02","partial":false,"done":true}.
done:true means the request ended, and only done:true,partial:false means the total is exact.
Unreadable or vanished descendants and already-stuck mounts leave a floor with partial:true.
The overall remote deadline also leaves a partial floor. close or a newer snapshot cancels the request, whose last reply carries
cancelled:true,partial:true,done:false; a cancellation reply may omit the facts.
After a close, the caller discards all replies for that snapshot. A moved, vanished or replaced
selected identity returns ok:false with an error, including when it changes during the walk.
Dates and Kinds describe selected entries, not their descendants. Selected roots are summed
independently, so selecting both a folder and an entry inside it counts that entry in each root.
{"c":"menuaction","op":"contents","id":4} counts what the one captured folder holds, for Properties on a folder.
It walks with the folder size walker and never crosses into a nested mount or follows a symbolic link. A local folder
walks on the menu worker with no deadline. A folder on a remote mount, or holding one anywhere below it (the walk
still reads the mount point's own entry), walks on a worker beside the menu worker under the bulk deadline (15 s): past
it the reply is the floor counted so far, partial:true and done:true, the walk stops, and the remote mounts it
could touch are marked stuck for 30 s. While one is marked, the same request answers the empty floor at once
(bytes:0, items:0, partial:true, done:true) without a walk. items counts every entry the walk visits below the folder (files, folders, links and other entries), not the
folder itself, and bytes is the folder size walk's total, which includes the folder's own entry.
The walk runs under the request's own cancellation, so close or a newer snapshot stops it within one directory
read, and a remote one is answered at once. It answers a progress line every 150 ms while it walks, and none for a folder that
finishes sooner: {"t":"menuaction","id":4,"op":"contents","ok":true,"bytes":2104332800,"items":812,"partial":false,"done":false}.
The last line carries done:true. partial is true when the walk could not read a directory or one vanished, and the
numbers are then a floor. A cancelled walk answers once with cancelled:true and "done":false. An id that is not the
captured snapshot, a selection of several items, or an item that is not a directory (a symbolic link to one is a link)
answers ok:false with an error.
{"c":"menuaction","op":"facts","id":4} reads the codecs, bit rate and photo facts for Properties on a file, for the one captured
item. Properties sends it once, right after the properties reply, for a file that is not a folder or a link, so the card opens on
what the listing already knows and the new pairs arrive beside it. It answers one line on the menu worker, under the request's own
cancellation: {"t":"menuaction","id":4,"op":"facts","ok":true,"vcodec":"h264","acodec":"aac","bps":8100000,"make":"Canon","model":"Canon EOS R6","lens":"RF35mm F1.8 MACRO IS STM","shutter":[1,250],"fnumber":[28,10],"iso":400,"taken":"2026:09:12 18:31:07"}.
Every field is raw and a fact the file does not have is "" or 0 ([0,0] for a rational), so the card shows no pair for it.
vcodec, acodec and bps come from the same ffprobe header read meta uses (format=duration,bit_rate and the streams'
codec_name; the first video and the first audio stream name the file), and only for a video container by extension. The photo
fields come from the file's own EXIF, read from the head and never decoded: a JPEG's first Exif APP1, a TIFF-based RAW (CR2, NEF,
ARW, DNG) from its IFD0 and Exif IFD in the first MiB, and a CR3 from the CMT1, CMT2 and CMT3 boxes of its Canon uuid box in the
moov. Text is cut to 120 characters with control characters turned to spaces. A cancelled request answers ok:true with
cancelled:true and no facts. An id that is not the captured snapshot, a selection of several items, or an item that is not a
regular file answers ok:false with an error; a fifo or a device is never opened.
{"c":"gitstatus","path":"/repo","enabled":true,"refresh":false,"id":1}
Reads one repository-wide snapshot for Git decoration without replacing the ordinary listing,
its row numbering or its watch. path is the absolute directory being displayed. enabled
defaults to false and refresh to false; id defaults to 0 and is echoed on every reply.
The shared Boolean setting is showGitStatus, off by default. Its window control is
Show Git status in Settings, View, immediately before Highlight today's dates.
An enabled directory change discovers the worktree and runs one read-only Git status. The same
directory reuses a successful cached snapshot until refresh:true; failed loads retry on the next
enabled status request, with the existing mount quarantine still throttling remote discovery.
Outside a repository no Git process starts. Disabling clears the cache and cancels active or queued
older work without discovery or process launch. Navigation also cancels the old directory's work.
Replies may interleave other backend replies, so clients match both path and their current id
before displaying them.
The existing changed event drives refresh through the client's 400 ms absorbing timer: the
first notification starts it, later notifications do not restart it, and expiry sends this request
with refresh:true. Keep one status request in flight and preserve later watch debt until its
reply. The existing non-recursive watch covers the displayed directory, not all repository paths
or .git metadata; another directory change or explicit refresh discovers those other changes.
The argv is /usr/bin/git -c core.fsmonitor=false -c core.hooksPath=/dev/null -c core.untrackedCache=false -c status.renames=true status --porcelain=v2 -z --branch --untracked-files=all --ignore-submodules=none --.
The sandbox changes directory to the repository root; there are no path operands or shell.
It binds the worktree and linked-worktree metadata read-only, isolates the network, clears the
environment, and sets GIT_OPTIONAL_LOCKS=0, GIT_CONFIG_NOSYSTEM=1,
GIT_CONFIG_GLOBAL=/dev/null and GIT_TERMINAL_PROMPT=0. Capture, parsing and sorting share one
five-second deadline and navigation cancellation check. Stdout is bounded at 32 MiB, stderr at
64 KiB, with the normal sandbox resource limits. A checked 64 MiB aggregate allocation budget
covers both full capture buffers and cumulative snapshot capacity requests, including paths,
rename sources, branch text, change records and the sorted folder index. Growth is charged before
fallible allocation, including replacement storage and 64 bytes of overhead per allocation;
released allocations remain charged conservatively. Folder marks use at most two path references
per change, with no ancestor copies. Over-budget input refuses the whole snapshot with
Git status snapshot is too large.; an allocator refusal reports
Git status could not allocate its snapshot. One ordinary staged deletion (1 D. with zero
index and worktree modes) plus one untracked entry (?) at the same path is legitimate: Git
emits this after untracking a retained file or symlink, recreating a staged-deleted file, or
untracking a retained gitlink (? path/). These records coalesce to one ? change, counted once
in the branch caption and Changes, with deleted:false; the untracked entry determines the
folder flag and path spelling. A lone deletion remains D with deleted:true. A rename's
source metadata can also name an untracked entry; the destination and source remain two distinct
changes. Other repeated destinations, repeated records, or groups larger than two refuse the
whole snapshot with Git status returned a duplicate path. Coalescing allocates no additional
storage and retains all existing budget charges, deadline and cancellation checks. Process
failures retain stderr. Remote discovery uses the existing mount bound.
{"c":"gitrows","path":"/repo","paths":["/repo/Code","/repo/notes.txt"],"id":2}
Projects the last successful snapshot onto the visible rows only. path must match that
snapshot's directory, and every paths entry must be an absolute immediate child. At most
400 paths are accepted per request; a larger viewport can use several requests. Results follow
request order, including clean rows, and perform no per-row stat, MIME lookup or subprocess.
The window draws the marks in a 14 px column before Size; the TUI uses one cell before the size.
Both use M, A, D and ?; the TUI represents a changed folder by yellow ■.
{"c":"gitchanges","path":"/repo","start":0,"count":1,"id":3}
Pages every canonical changed path relative to the worktree root, deleted and untracked paths
included. start defaults to 0 and clamps to total; count defaults to 400 and caps at 400.
The window opens this virtual listing by clicking the branch caption. The branch becomes the
foreground current crumb, the original folder path becomes its muted ancestor, and Back or Esc
returns to that folder. Folder prefixes within changed paths are muted before the leaf name;
the cursor row uses foreground. Deleted rows have no Size or Modified value. There is no added
esc returns hint. Changes view is window only in 0.4.0.
This does not replace the ordinary listing or its watch. Changes-view indices never name
ordinary backend file-operation rows; clients resolve an existing entry against the reply's root.
An optional pickerGen has the same request-generation echo as list, including
the initial rows. It lets the picker distinguish an older Recent visit from its
current request without changing replies to callers that omit the field.
{"c":"listpaths","paths":[<string>,...],"first":<uint>}
Example: {"c":"listpaths","paths":["/home/gm/Pictures/a.png","/home/gm/Downloads"],"first":80}
Builds a fresh listing out of the paths the client names, replacing the current one, and answers a
listed line followed immediately by a rows line covering rows 0..first, exactly as list
does. The listing's base is / and each entry is its absolute path with the leading slash removed,
so window, thumb, paths and every other per-row facility keep working with no special case
anywhere; that is the same shape a search listing takes, for the same reason. The client splits
the last / itself when it wants to draw a name rather than a path.
Nothing is sorted. The order the client sent is the order it gets back, because the callers
are the picker's Recent location and the main window's Recent place, and their order is the
history's own, newest first; a sort by name would throw that away. read on the listed line is the time this build took and sort is always
0.0.
A path that does not exist is dropped, not listed. The build lstats each one, so a history
entry whose file has since been deleted never reaches the client, rather than arriving as a row
whose p, s and m are all 0. A path that is not absolute, and the root itself, are dropped the
same way: this list is read out of a file every application on the desktop writes, so it is checked
here rather than trusted. The type recorded in d is the link's own, the same rule list follows,
so a symlink to a directory is listed as a file and a symlink to nothing is still an entry.
There is no cancel and no streaming: the build is one lstat per path inside the read loop, and the
one caller sends a few hundred at most.
A re-read over the listing already held names added plus removed rows in changed, so a reload
over Recent says how many history entries came or went; a first listpaths carries no changed.
{"c":"window","start":<uint>,"count":<uint>}
Example: {"c":"window","start":1200,"count":350}
Stats rows start..start+count of the current listing (phase 2) and answers one
rows line. start and count are clamped to the listing's length, so a stale or
out-of-range window never panics, it just returns fewer rows or none. Missing fields
default to 0.
A count of 0 returns an empty rows array and kinds array with ms of 0.000,
the clamped start, and the current listing stamp. It does not read mountinfo,
stat rows, load row tables, start workers, or rank the remainder of a session's
matches. A later nonempty window uses the normal complete row format below.
TUI traversal sends "traverse":true on the same name-only request and receives
{"t":"found","id":7,"query":"^note","rows":[0,2],"error":"","listing":1}.
It uses smart-case regular expressions and retains the full listing and selection.
An invalid pattern returns its diagnostic in error. The client accepts only its
latest id, query and listing generation. Initial traversal includes a matching
current row; subsequent next/previous steps exclude it and wrap. Its state is
separate from the live filter.
{"c":"filter","query":"<string>","id":<uint>}
Example: {"c":"filter","query":".PNG","id":7}
Matches a case-insensitive literal substring against every name in the current listing,
including rows outside the client's held window. Missing query defaults to the empty
string and missing id to 0. Filtering reads names only, fetches no metadata and
does not change the listing, its sort order or its numbering. Each request answers once:
{"t":"filtered","id":7,"query":".PNG","n":1300,"rows":[0,2,4],"ms":0.012,"listing":1}
n is the full listing count. rows contains matching indices in ascending order in
the current sorted listing, with [] for no matches. An empty query answers rows:null,
so clearing restores the integer-count model without sending an identity array.
ms measures backend matching and serialization, not UI latency.
The client accepts a reply only while its id and query name the latest request, and
it drops its answer and sends a fresh request whenever a list, sort, search, search
refresh or final search ranking renumbers the listing, so an accepted reply answers in
the numbering of the rows on screen, the one its listing stamp names. View positions
map through rows; paths and file operations use those original listing indices and
the listing stamp. Filtering
does not emit a rows metadata reply or refill a window, even on clear. The client
requests only windows needed for the displayed matches and refills its viewport after clear.
{"c":"sort","by":"<string>","desc":<bool>,"foldersFirst":<bool>,"groupByKind":<bool>,"hiddenLast":<bool>}
Example: {"c":"sort","by":"size","desc":true}
The TUI retains creation-time, extension and random orders for the running session
and navigation, without writing them into the shared four-sort settings schema.
Re-sorts the current listing by by and answers a listed line. The orders are:
-
"btime"requests optional Linuxstatx(STATX_BTIME)for each entry without following symlinks. The returned mask must includeSTATX_BTIME. Unsupported, inaccessible or missing timestamps stay unavailable, never substituted with ctime or mtime. Like yazi's optional-time comparison, unavailable sorts before known times ascending and after them descending; equal times use the name tie-break. -
"extension"reads only existing filename extension bytes, without MIME lookups or a metadata pass. Directories retain name order. -
"random"materializes one random rank per entry before comparing and installs the resulting permutation for that listing generation. Window reads do not reshuffle it and require no per-entry metadata. Both name-only orders reportread:0.0. Existing anchors and listing-generation replacement still apply. -
"name"works on phase-1 data alone:readis0.0andsortis the sort. -
"size"and"mtime"pay the metadata pass first, onelstatper row of the whole listing split across the cores, then sort. A size sort also walks every folder's subtree under one shared 250 ms budget for the whole sort, and that walk is part of the pass, so its time lands inreadtoo.readis that pass in milliseconds andsortis the sort, so the two costs stay readable apart on the wire. -
"kind"compares MIME type strings obtained from filenames, withapplication/octet-streamfor an unknown name andinode/directoryfor a folder. Files with equal kind order by extension, none first with the Finder comparison, then by name; folders keep name order. It does not read file contents or run a metadata pass;readis0.0.
foldersFirst defaults to true: folders remain before files in both directions.
With foldersFirst:false, the key orders folders and files together. groupByKind
defaults to false; when true it takes precedence over foldersFirst and fixes
three groups in this order: folders, images (MIME type starts with image/), then
all remaining files. Groups do not reverse with desc. Kind grouping uses filename
MIME lookup, not content probing. hiddenLast defaults to false; when true it
is an outer partition, a visible block then a hidden block, and foldersFirst
or groupByKind orders inside each block. Neither block reverses with desc.
Inside each group, or across the whole listing when ungrouped, the key decides and
the name order breaks ties, except files with equal kind order by extension first, none first, then by name, so two equal sizes list the same way every run, and
desc is the exact reverse of ascending inside the group,
tie-break included. A size order walks each folder's subtree and orders folders by that
recursive size, the same number the dirsized line reports, so the order agrees with the
size column the way it already did for files; an mtime order lists them by time like
everything else. A folder that hit the shared budget orders by the floor it counted.
A size sort seeds the answered-row cache only with the folders it finished walking, so a
later dirsize for one of them is answered from the cache rather than walked twice. A folder
the budget cut off seeds nothing, and is walked again by the worker at its own per-row
deadline when the client asks, because a floor must not stand in for a size.
On a network or phone listing (the classes the client refuses folder sizes on) a size sort walks no folder: each folder orders by its own entry size, the floor a walk past its deadline would give, and seeds nothing.
A size order is best effort on a directory large enough to exhaust the 250 ms budget. A
folder cut off by it is placed on the floor that was counted, and that floor is used for the
order alone: it is never sent, so nothing on the wire says the order was built from one. The
size the column shows for that folder arrives later, from a separate walk at the two second
per-row deadline, and the two walks carry no ordering relation to each other, so that number
can be larger or smaller than the floor the row was placed on. Its dirsized line carries
partial true only when that second walk ran out as well. On such a directory the column can
therefore disagree with the order it was sorted into, and a re-sort can still place two
folders by their floors. A client holding both the order and the later sizes can see that
disagreement; what it cannot tell from the wire is whether a floor or a changed tree caused
it. The budget is what keeps the whole pass short while it runs on the event loop, and this is the cost of that
choice.
The stat
is the same lstat that rows reports s and m from, so the order always agrees with the
column, symlinks included, and a row that vanished between the listing and the pass sorts as
the zeroes rows would send for it.
Sort metadata is not retained between requests. Reversing a size order stats the directory again and walks the folders again, bounded by the same budget each time,
because a listing in name order must not carry metadata it is not using. The stats
live for one request. Historical measurements from 2026-09-02, using the default
name ordering and directory grouping: on the 100,000 file fixture the backend's PSS
read 4781 kB after the listing and
4945 kB after a size sort (one smaps_rollup reading each), with a transient peak 3.2 MB
above that while the pass ran. Measured on that fixture, warm, on 2026-09-02, from the
read and sort fields of the listed line: the pass took 25 to 38 ms on twelve cores and
125 to 135 ms pinned to one with taskset -c 0, and the sort behind it 6 to 7 ms against
5 ms for name; on a three-row directory the whole request stayed under half a millisecond.
Cold is IO-bound, and an earlier measurement in the maintainer's notes, not in this repository,
put the same pass at about 1 s serial and 0.3 s on twelve threads. The pass runs inside the
loop, so a size or date sort of a very large directory on a slow mount stalls other backend
requests for its duration. An initial list explicitly requesting one of those orders pays
that same metadata pass.
An unsupported, empty, missing, or non-string by answers an error line,
never a listed line in name order. The error names the supplied string key, or an
empty key when no string was supplied. This prevents a refused request from silently
resetting the existing order. A refused sort leaves the listing in its existing
order. sort never emits a rows line on its own;
follow it with window to see the reordered rows. A missing desc defaults to false.
An optional anchor names the cursor's logical row for this re-sort as an absolute path,
{"c":"sort","by":"size","anchor":"/home/gm/amber"}, and the listed line answers it with
"anchor" echoing that path and "anchorIndex" carrying its index in the new order, or -1
when that path is not in the listing. Each reply answers only its own request's anchor, so a
burst of re-sorts needs no shared generation count: the client moves the cursor only when the
reply's anchor is still the newest one it sent, and ignores a superseded or foreign one. A
request without anchor answers exactly the listed line it always has, so every older client
keeps parsing what it knows.
mtime names the same stat field that rows carries as m; the GUI labels it
"Modified". date is also accepted as an alias for mtime, matching the saved
Settings value. mode is not a supported sort key.
{"c":"search","path":"<string>","query":"<string>","hidden":<bool>}
Example: {"c":"search","path":"/home/gm","query":"dwnhelp","hidden":false}
Walks the whole subtree under path and streams every entry whose path relative to path
contains query as a case-insensitive subsequence, into a fresh listing that replaces the
current one. The match is fuzzy rather than a substring, and it runs over the whole relative
path rather than the base name, so dwnhelp finds downloads/helper.txt. hidden follows
list's rule exactly: false, or missing, drops dot-prefixed names before they are
counted or descended, so a .git costs one readdir entry and nothing more.
path is whatever the client asks for, and the backend walks exactly that and nothing else:
a client searching a whole home directory sends home as the path, and one searching a mount
sends the mount. The backend has no notion of home and no scope of its own.
Results are ranked, and the rank is what makes a subsequence match usable. A subsequence over a hundred thousand entries matches far too much to read, so every match carries a score and the walk answers in score order. Characters matching consecutively score highest; a character starting the candidate, a path segment, a word or a camelCase hump scores next; a character in the file's own name beats one in a parent directory the query merely passed through; and every candidate character skipped between two matches is charged back. Ties go to the shorter path, then to the listing's own name order, so one walk over one tree always answers in exactly one order.
A search result is a listing like any other, and that is what makes it cheap. Each match
is pushed as its path relative to path, and path becomes the listing's base, so
window, thumb, dirsize and every other per-row facility keep working with no special
case anywhere. The client splits the last / itself to draw the name and its location
column; the backend never sends a second shape.
Matches are appended in discovery order and never re-sorted mid-walk, so a window the
client already holds stays valid as the count grows. The order changes exactly once, at the
end: searched is written after the rows have been ranked, so a client re-reads its window
when it sees that line and every row index it held before then is stale. That is the same
rule a sort follows, for the same reason. The walk is answered in three parts:
- One
listedwithnof 0, immediately, because the client's old rows are gone the moment the request is read. - A
searchingline carrying the growing count and the entries scanned so far, at most one every 100 ms while the walk runs. - One terminal
searchedline, written after the ranking.
There is no trailing listed or searching: searched carries the final count itself, so a walk that a
new listing replaced never announces a total it no longer has.
The walk runs in bounded slices inside the same single-threaded loop everything else uses,
four directories per slice, so a searchcancel or any other request is never queued behind
a subtree. A symlink reports its own type, so a link to a directory is listed but never
descended and no loop is possible. An unreadable directory is skipped in silence, the same
way scan skips an unreadable entry. A path that cannot be read at all is not an error:
the walk finishes at once with n and scanned both 0.
list and sort both end a running walk before they touch the listing, and answer their
own lines after the walk's terminal searched.
A query may carry tag:<name> terms beside the fuzzy text, tag:Red holiday matching files
that carry the Red tag and fuzzy-match holiday. The name matches case-insensitively, and any
Flea or foreign name is accepted. Every named tag must be present. The attribute is read only on
files the walk visits, one getxattr each, never swept ahead of it.
{"c":"searchcancel"}
Stops the running walk and answers one searched line with cancelled true. Whatever the
walk already found stays in the listing, is ranked the same way a walk that ran to the end is,
and stays windowable. Unlike thumbcancel there is
no rows form: one walk runs at a time, so a cancel can only mean that one. A
searchcancel with no walk running does nothing and answers nothing.
With a live session open the walk stops and the session stands: the standing query is
re-answered once from the partial index, listed, rows, then searched with the query's
own gen, walking false and cancelled true, and a later query is still answered from the
kept index. With no standing query, or an empty one, only that searched line answers, for
the last answered gen. The session never closes on a cancel; searchclose is what drops it.
{"c":"searchopen","path":"<string>","hidden":<bool>,"folder":"<string>"}
Opens a live session for the scope path. folder is the pane's folder the
session was opened from; scope and folder differ when the scope is home.
The walk starts at once on a background thread and the current listing is
untouched: no listed, no rows, no row invalidation. Answers one line:
{"t":"searchopened","path":"<scope>"}
hidden follows list's rule exactly. The scope walks once per session with
one mountinfo read. Every directory is classified against that snapshot by its
deepest enclosing mount, including local mounts below remote mounts. Local
directories use the bounded local walk threads. Network and FUSE directories,
including ones below a local scope, share one serial remote lane with the existing
5 s call deadline and 30 s stuck-mount TTL. A mount refused during a walk is not
retried by that walk's remaining directories. A remote-root scope walks serially.
Only one name reader may remain active per remote mount across sessions and
patches. A reader still blocked after cancel or timeout keeps that slot until
its syscall returns; another request reports partial coverage instead of starting
another reader, even if the stuck TTL has elapsed.
One session runs at a time; opening a second closes the first in silence.
A list, listpaths, sort,
search or searchclose closes the session too, and drops
its index. Closing mid-walk cancels it: no directory opens after close.
{"c":"searchremap","gen":7,"from":12,"rows":[0,900],"cursor":900}
A client displaying a same-generation Search replacement can remap its marks and cursor from
the old from listing stamp. The backend keeps one immutable source listing, including names
outside the first window, until it answers a remap. It resolves full paths into the current
result listing, never basenames. The reply is bounded by the requested selection:
{"t":"searchremap","ok":true,"gen":7,"from":12,"listing":15,"rows":[8],"cursor":8}
Missing files are omitted from rows; an absent cursor is null. Rows are unique and ascending.
listing names the current answer, which can be newer than the replacement that prompted the
request. Repeated replacements retain the source until a successful remap, which releases it;
the next index change snapshots the answered listing again before it mutates anything.
Stream order puts that reply before later replacements.
The frontend keeps one request in flight and applies it only to its matching generation, source
and current listing. A stale source, query generation, closed search or different scope answers
ok:false, empty rows and a null cursor. Navigation and a new query discard the snapshot.
Old clients need not send this optional request; existing replies are unchanged.
{"c":"searchquery","query":"<string>","gen":<uint>,"count":<uint>[,"sizes":<uint>]}
Asks the open session. With no session open it answers nothing. The query is
answered from the index with no walk. A tag:<name> term keeps the entries that carry that tag, the
same case-insensitive rule search uses; the names are read once per row on a worker
thread after the walk lands, and until they are in the answer says walking true and
the landing re-runs the query. gen is the client's number, newer per
keystroke; a query whose gen is not newer than the last answered one is
dropped in silence, and a burst answers only its newest query. count is the
first window's size, the same meaning as window's count; missing is the
list's own first-window default. sizes is how many leading rows the client
draws a folder size for, and 0 asks for none; a query without it keeps the
last one the session was given, so a burst answered from its newest query
keeps it too. Each answered query is three lines, in this order, the order
the listing swap already follows for list:
- One
listedline withnthe match count andpaththe scope, carrying the query gen beside them, so a line landing after the session closed names no folder. - One
rowsline for the first window from row 0, ranked, stamped with the new generation and carrying the query gen beside it, so held row indices invalidate exactly as after asortand a late line lands on no folder. Withsizesabove 0 it may end with"z":[[<row>,<bytes>],...]aftergen, in row order, the same bytes a wholedirsizedanswer carries for each folder row among the firstsizesrows whose complete size is known. - One terminal line naming the generation:
{"t":"searched","n":<matches>,"scanned":<entries>,"ms":<ms>,"cancelled":false,"gen":<gen>,"walking":<bool>,"partial":<bool>,"partial_reason":<string>}
scanned is the index size the query scored over. walking is true while
the walk is still running: the answer comes from the partial index, and the
standing query is refreshed from completed directory blocks at most once per
100 ms after its initial hold, and once when the walk lands, with its own gen,
only if no newer query has replaced it; the landing answer has walking
false and ms the walk's time. A newer query's answer replaces the window
whole: no blank listing stands between two queries. Scoring runs on one retained
session execution worker; the loop alone publishes answers and discards an
in-flight answer superseded by a newer query or navigation. Ordinary requests
retain their position relative to collapsed queries. Collapse reports its highest
drained generation to the execution gate before a buffered readiness event can
publish an older answer. The published pageable
remainder survives a discarded answer only while its index row IDs remain valid;
a pending patch or a recursive watch delta that renumbers the index discards
that remainder as usual. The newest query rebuilds it. A watch delta that lands
while an answer is out waits behind it, then is reconciled and re-answered on the
same worker. Closing releases the execution worker.
Requested local rich rows can reuse metadata, MIME and tag results across query generations, keyed by unchanged path identity rather than row index. The cache clears when a folder answer claims a new generation, when an own write under the scope patches the index, and when a change line for the open folder is said; a typed query clears it when its requested rows change the watched directories or are not covered by the inode watches, and keeps it otherwise. Reuse holds at most 350 currently requested rows, with bounded payload and independent directory and file-inode watches armed before reading misses. Inode changes, including writes through hard links in other directories, invalidate metadata and serialized rows together. Ancestor moves and path replacements also invalidate reuse. Each watch set holds at most 350 paths; changing the inode set briefly retains one old set until its replacement is armed and checked, so intersecting identities stay covered. Overflow or failed watch coverage forces fresh reads, as do remote paths, symlinks and names requiring lossy display conversion. Reuse changes no row fields or response-local kind indices.
A query asked while the walk still runs waits for the walk to land, up to
150 ms after the first query held, the search hold (ui/js/Swap.js
HOLD_MS, not the listing swap's cap Swap.CAP_MS, 66 ms), so it is answered once from the whole index; a newer query asked
meanwhile replaces it and answers in its place. Past HOLD_MS the held query
is answered from the partial index with walking true, and every later query
of that walk is answered at once. A searchcancel answers a held query as
its stop.
An empty query keeps the session and its index and answers the open folder's
own listing, the folder the session was opened from, in its own sort, with
listed.path that folder, in the same listed, rows, searched order with that
gen. No walk of the scope runs; one readdir of the folder is all it costs. Its
rows line carries z for the folder's own folder rows the same way.
An unmount of the search scope also completes an empty standing query with one
searched status at that query's generation, walking:false, partial:true
and reason watch_failed. It preserves the folder's rows, count and listing
number; it emits no replacement listed or rows lines.
A size is known when the session learned it earlier, from a dirsize answer
given while it is open or from its own walk for an earlier answer, keyed by
path; or when the walk this answer runs finishes it, all of that answer's
folders sharing one 3 ms budget. A folder left out of z is asked with
dirsize exactly as in any listing. A remote scope never walks for z, and a
scope where a walk that started misses the budget walks for no later answer in
that session; both still carry the sizes the session knows. A walk the
scheduler had not started by the deadline marks nothing. Every patch of the
index, from a write or the open folder's watch, forgets the known sizes.
Local sessions own a recursive inotify instance, separate from the pane and column
watches. Each local directory is armed before enumeration, including directories
on local USB filesystems. Nested network and FUSE directories are never armed,
including during own-write patches and subtree replacement. Those directories
use bounded enumeration and own-write/manual reconciliation, as remote roots do.
Queued changes are replayed before the completed walk is announced.
External root and deep create, rename,
delete, replacement and subtree moves reconcile affected directory blocks without
another query. The standing nonempty query is then pushed again as listed, rows,
searched, with the same query gen and a new listing generation. Clients replace
the old rows even when the query generation is unchanged, and discard row indices
from the old listing generation. Applying an index delta always precedes this push.
The first idle event has no timer delay; subsequent events already queued share a
reconciliation. There is no per-query mtime sweep or whole-index repack per event.
Retained name storage is reclaimed only after retired bytes exceed both 1 MiB and
one percent of logical storage. Dense row swaps and reclamation invalidate internal
query caches and any pageable remainder before another answer.
The backend's own writes and the open folder's existing watch retain their patch
paths. A remote-root session uses bounded enumeration and own-write/manual
reconciliation; it does not claim recursive notification. Closing or cancelling a
running walk stops and joins the recursive pump and closes its descriptors. A new
scope rejects queued events carrying the old session's token.
An unmount event from any recursively watched directory stops the whole scope's
walk, releases its recursive watches, and retains any usable snapshot with
walking:false, partial:true and reason watch_failed unless an earlier failure
already supplies a reason. The scope remains terminally unmounted until reopen:
queued index patches are discarded, and later own-write or open-directory
notifications cannot reconcile its retained identities. Explicit user cancellation
keeps its existing patch behavior. Pending tag reads and retries stop too, with
the stop flag checked before each new path or chunk and after an in-flight read
returns, including remote workers and tag rereads. It does not
scan the exposed mountpoint or automatically resume the scope. Reopen to establish a new
mount snapshot. A remote read abandoned by timeout or cancellation stops before
its next entry when a blocked syscall returns; the syscall itself is not killed.
The index has no fixed entry-count cap. Raw basenames are interned and paths are reconstructed from parent references. Checked ID or arena bounds and allocation refusals stop adding entries and preserve identities already held.
Every session searched line carries partial and partial_reason. Once
walking:false, partial:false and an empty reason certify enumeration without a
refused directory and no reported local recursive-watch failure. This certifies
a snapshot, with no automatic remote freshness guarantee.
While enumeration or tag loading continues, walking:true carries partial:true
with reason walking, unless an earlier failure supplies a reason. Incomplete
coverage carries unreadable, capacity or allocation; cancellation carries
cancelled:true, walking:false, partial:true and reason cancelled. Watch
registration, descriptor or unmount failure carries watch_failed. A queue
overflow reconciles all registered directory blocks and carries watch_overflow.
Both watch failures remain partial until reopen, even if reconciliation recovers
usable results, so no failed scope claims complete live coverage. For a nonempty
query, scanned counts retained identities even when no entry matches; an empty
query retains its folder-row count. A patch read refusal also makes coverage partial.
A partial result remains usable but never certifies a complete live scope inventory.
The session has its own lexical scorer; one-shot search and folder jump
keep their existing scorer. The query and candidate characters fold without
Unicode normalization. Exact basenames rank before clean basename prefixes,
word prefixes, aligned paths, ordinary subsequences and typo-only matches.
Subsequences use the best run and boundary alignment across the whole relative
path, including separators, with no first-occurrence limit. ASCII letter
presence masks reject impossible names before scoring, and an interned basename
is scored once per query. Unknown and non-ASCII classes bypass this rejection.
Typo-only matching starts at a word boundary and permits letter replacement,
insertion, deletion and adjacent swap, including the first letter. A dropped
query letter counts only where the matched word ends, so flea never matches
the prefix fla of flac. Typo-only matches are listed only when no basename
holds the query exactly, as its prefix or at a word start; with a tag term,
only the basenames that carry its tags count. The budget
is zero below four alphanumeric query characters, one from four through seven,
and two from eight onward. Digits and punctuation are never edited. A query
beginning with punctuation, such as .svg, permits no edits. Explicit path
queries may correct letters in parent components as well as the basename.
Fresh lexical ties use shorter relative paths and natural raw identity order.
The final history and folder-distance order belongs to the read-only ranking
prior layer; it adds no control or result mark.
Only extensions with zero edit budgets on both sides may reuse the previous
matches, and only with identical tags, complete prior coverage and an unchanged
index. Backspace, scope or index changes, unfinished tag reads and edit-eligible
queries rescore candidates. The first window is selected and ordered without a full sort; the rest
stays scored but unranked until a row past the window is asked for, when the
next chunk is ordered with the same comparator and appended behind the head,
the request's need or one window, whichever is larger, at least doubling the
adopted length, so no window ever shows a row from a different order than the
one the listed line counted. A path lookup and a sort take the whole rest in
one go, as does any request whose need spans it, select-all among them.
{"c":"searchclose"}
Drops the index and answers one line:
{"t":"searchclosed","path":"<scope>"}
With no session open it answers nothing.
{"c":"thumb","rows":[<uint>,...]}
Example: {"c":"thumb","rows":[2,17,140]}
Asks for a thumbnail for those row indices of the current listing, and answers one
thumbed line per row. This is the only thing that ever generates a thumbnail. The
backend never walks a directory looking for work: a row that no client named is never
looked at, at any priority.
An off storage class still asks, and the backend answers from the cache alone. A client
on a network, phone or USB directory whose switch is off sends
{"c":"thumb","rows":[<uint>,...>],"cacheOnly":true}, and a genuine cache miss then
answers an empty file at once rather than queueing a decode: one stat of the source
per visible row and no read, so a NAS folder costs a metadata round trip instead of
about 48 MB. A row already in the shared cache answers with that entry's path, whether
or not the source can still be opened, and thumbnails another application already made
still show. Absent cacheOnly is today's full path, so a local folder and an older
client are unchanged.
Each index is clamped to the listing: a row past the end is skipped in silence, because
there is no row to answer for. A missing or malformed rows is an empty array and the
request does nothing. Indices may repeat and need not be sorted; the newest request for a
row replaces the older one.
Four of the answers cost no work at all and come back on the same line the request
arrived on. A directory row, a row that is not a regular file, and a row whose MIME type no
validated thumbnailer declares all answer immediately with an empty file; that is the same
condition the t flag in a rows object reports, so a client that honours t never asks.
A row already in the shared cache at the file's current mtime answers immediately with that
entry's path, and a row recorded as failed at that mtime answers immediately with an empty
file. Only a genuine cache miss is queued, and its thumbed line arrives later.
The queue is bounded, and a request larger than it is still answered in full. When the queue
is full the oldest job in it is dropped to make room, and the row that job belonged to is
answered at once with an empty file rather than left waiting.
What the shipped client sends. ui/Pane.qml sends thumb only when the list settles,
which is a 120 ms timer restarted by every scroll and by every arriving window of rows, so a
fling issues nothing at all until it stops. One request names only rows currently visible,
only rows whose rows object carried t:true, and only rows the client's own map does not
already hold.
That map has four states and only two of them are terminal. Absent means unknown, null
means asked and waiting, a non-empty string is the answer's path, and an empty string is a
real answer meaning this row has no thumbnail. The two string states are terminal: every
answer is recorded, an empty file included, and an answered row is never asked about again
while this listing stands. The other two are not. Rows that left the viewport while still
waiting are named in a thumbcancel sent immediately before the same settle's thumb, and a
cancelled row drops back to absent rather than to a terminal state, because the backend
forgets the job it drops and would otherwise never answer it. A row that scrolls out while
waiting and scrolls back is therefore asked for a second time, and that is correct. A client
that treats "asked once" as terminal leaves a permanently empty slot on every such row.
ui/js/Thumbs.js is the shipped implementation, its forget is the drop back to absent, and
tests/js/thumbs.js holds it under the name "a cancelled row can be asked for again".
Neither request is ever sent with an empty rows, because that form cancels everything.
Opening a directory clears the client's whole map, since an index names a different file
afterwards. See AGENTS.md "Thumbnail requests in the GUI".
{"c":"thumbcancel","rows":[<uint>,...]}
Example: {"c":"thumbcancel","rows":[17,140]}
Drops queued jobs for those rows. An empty or missing rows cancels everything queued.
A job that a worker has already started cannot be cancelled and still answers with a
thumbed line; only work still in the queue is dropped. A cancelled row is not answered,
so a client that cancels must stop waiting for it. No response line.
A cancelled row can be asked for again straight away, in either form of the request: cancelling
forgets the row as well as its job, so a later thumb for it queues fresh work rather than
being deduplicated against the job that was just dropped.
{"c":"fsinfo"}
Answers one fsinfo line for the directory the current listing came from:
{"t":"fsinfo","fs":"<string>","free":<int>,"path":"<string>","class":"<string>","tagable":<bool>}.
fs is the filesystem's own name and free its bytes available to an unprivileged
process; path is the directory they are of, so a client that has since moved can
tell they describe somewhere else. tagable is that directory's once-per-change probe
for user extended attributes, so the Tags menu row is absent where the filesystem
cannot store them. A repeated fsinfo for the same directory reuses the answer and makes no
call. On a network or phone directory the probe runs on the statfs worker, never the loop:
the field reads true until it lands, and a refusal sends the line again with false. class is that directory's storage class,
network, phone, usb or "" for local, computed once per directory change
beside this line and never per row: network is cifs, smb3, nfs, sshfs, rclone, 9p,
ceph and any gvfs FUSE share, phone is gvfs mtp, gphoto2 and afc, and usb is a block
device whose sysfs path runs through USB or whose removable flag is 1. An unreadable
path answers an empty fs with a free of 0 rather than a wrong number, and a client draws no free
figure for an empty fs. A filesystem whose statfs reports no blocks, as gvfsd-fuse does for a share
with no size, keeps its fs and sends a free of -1, the only negative value: unknown room rather than
a full drive.
A local directory held by a system mountpoint adds "system":true after class, and no other line carries the key.
The mounts are matched by the directory's own device number in /proc/self/mountinfo, so a symlink,
a bind mount or a second mountpoint of one volume answers as the volume does, and a mountpoint counts as a
system one when it is /, /home, /boot, /var or anything else the rail's own list of system mounts names.
On a slow mount, a gvfs share or a kernel network filesystem, the statfs behind the
figures is a network round trip, so it runs on a worker thread, one per mount at a time, the
newest folder asked for going next: a share starts it once its list rows are sent, for a client that has asked fsinfo
before, and a kernel mount when fsinfo does. The statfs reads the listed folder itself,
because an sftp host or a phone's storages answer differently below one mount. On a gvfs share
it reads the folder's first plain file instead when the listing has one: gvfs answers a statfs
through smbc_statvfs on that exact path, and libsmbclient opens a folder for it by listing every
entry in it, where a file is one open and close. A file gone since the listing falls back to the
folder. fsinfo
answers at once with the class and that folder's last known figures, or unknown figures
("fs":"", "free":0) on a first visit. When the worker returns, a second fsinfo line for
the same path carries the fresh figures, sent only when they differ from what that folder
last answered and only while it is still the listed directory. A client must accept that line
at any time: it updates the figures in place and changes nothing else.
Local and USB directories answer figures and class in the one line, exactly as before.
{"c":"dirsize","rows":[<uint>,...]}
Example: {"c":"dirsize","rows":[4,9]}
Asks for the recursive apparent size of those row indices, and answers one dirsized line
per row that names a directory. This is the only thing that ever walks a directory looking
for size, the same rule thumb follows for thumbnails: a row no client named is never
walked. A row that is not a directory, or past the end of the listing, is skipped in silence.
One persistent background worker walks one directory at a time. The event loop remains
available for navigation while a walk runs. A list, sort or dirsizecancel invalidates
unfinished size work using a generation counter. Cancelled or stale replies cannot populate
the current listing's cache. Cancellation and the 2000 ms deadline are checked between
filesystem calls; a blocked filesystem call may delay further sizes but never holds up the
navigation event loop. No replacement worker is spawned while the old one is still busy.
A row already answered for the current listing answers again from its cache; a row already
queued or running costs nothing extra.
Settled sizes outlive the listing. A whole (not partial) walk that ran on a local
filesystem is also kept by the folder's full path, so a dirsize for the same folder under a
later listing answers at once with no walk, as when a tab switch returns to it. Such a size is
trusted only while every folder the walk read stays watched: the walk arms one inotify watch per
folder before reading it, and any write, truncate, create, delete or rename in any of them, or
the folder itself moving or going, retires the size, so the next dirsize walks again. So does
the path coming to name another folder, as when a folder above it is renamed, which no watch
below sees. A directory's mtime alone would miss a write several levels down, which is why every
level is watched. A walk that would take the backend past 8192 watched folders, counting every
kept size's, a FUSE or network tree, or a box with no inotify is answered as before and never
kept. Which settled sizes survive a new listing is the list
request's keep field.
What the shipped client sends. ui/List.qml sends dirsize only when the list settles, the
same 120 ms timer thumb already waits on, so a fling issues nothing at all. One request
names only the directory rows currently visible and not already known.
{"c":"dirsizecancel"}
Drops every directory row still queued and cancels the running walk cooperatively. An optional
non-empty rows array cancels only those rows, leaving pending walks for directories still in
the viewport running. For example, {"c":"dirsizecancel","listing":7,"rows":[4,9]} drops only
rows 4 and 9. Missing or empty rows retains the full-cancellation behavior. A row already
answered is untouched. No response line.
An optional listing field names the numbering the rows were read from. A dirsize or
dirsizecancel, in either form, whose listing is not the current one is ignored with no
response line, since its rows may name other folders now. A request without listing always
applies.
A directory a dirsizecancel dropped can be asked for again straight away: cancelling forgets
the row, so a later dirsize for it queues fresh work.
{"c":"transfer","op":"<string>","paths":["<string>",...],"dest":"<string>"}
Example: {"c":"transfer","op":"copy","paths":["/home/gm/a.txt","/home/gm/photos"],"dest":"/home/gm/backup"}
Copies or moves each top-level path into dest. op of "move" moves; anything else, including a
missing op, copies, so a malformed request can never remove a source. paths are absolute; dest
is an absolute directory that must already exist, because Flea does not create a destination as a side
effect of a transfer. A dest that is missing, relative, not a directory, or cannot be written answers a single error
line with where of transfer and nothing is started.
Unlike thumb and dirsize, this names paths rather than row indices: a transfer outlives the listing
it was started from, and a row index would name a different file by the time it ran.
A rows array of indices into the current listing may be sent instead of paths, because a client
can only build a path for a row inside the window it holds, and a selection can be wider than that. The
indices are resolved against the listing at request time and the operation runs on the resulting paths,
so it still owns a snapshot that outlives whatever the listing does next. paths wins when both are
present, and an index past the end of the listing is dropped in silence.
Copies, moves, archive compressions and extractions queue by destination drive. Each request
gets its own id and start line, including a request that waits behind another write to the same drive.
Waiting jobs run in arrival order and name their predecessor and its target in the jobs reason.
Writes to different drives run together; another running job never causes a busy refusal for these
requests. An extraction writes to the filesystem holding its destination, just as compression does.
Ordinary trash, duplicate, link and menu deletion share one non-job operation slot.
Reviewed Trash deletion also claims that slot and refuses while its previous Trash journal is settling;
destination-queued transfers do not hold it. Ordinary non-job mutations, including rename, mkdir
and permissionsBatch, refuse while the slot or an unfinished job is active. rename and mkdir
do not claim the slot themselves, and convert remains independent.
The answer is a transferstarted line for a file transfer, then per top-level item a bounded stream of
transferprogress lines and exactly one transferitem, then one transferdone. An archive extract
uses extractstarted for its activity card and archivedone for its terminal line.
Semantics that are decided here rather than left to the caller. A same-filesystem move is a
rename(2); a cross-filesystem move is a copy followed by removing the source, and the source is only
removed once the copy is complete, so a process killed mid-move leaves the source intact and a partial
file at the destination, never the reverse. A symlink is copied as a symlink and never followed. A
fifo or a socket is recreated at the destination with the source's own mode rather than opened,
because neither holds contents to stream and an open of one would wait for a writer or fail. A device
node takes the same path, but creating one needs CAP_MKNOD, so an unprivileged copy fails that item
with EPERM instead of recreating it; either way nothing streams from a device that never ends. A
destination that already exists is refused for that item rather than overwritten, because every write
here creates its target exclusively, unless the request carries a choice for it, below; even replace
never overwrites, it moves the item already there to the trash and then still creates exclusively.
Directory recursion is invisible on this wire: the backend walks a
tree to copy it and the client sees only the top-level item's lines, so the wire's shape does not depend
on how deep a folder is.
An entry the destination cannot hold never ends the walk of the tree around it. Inside a folder
being copied or moved, the backend skips and records an entry the drive refuses for that entry alone,
and goes on with every other one: a link where symlink(2) answers EOPNOTSUPP or ENOSYS, or EPERM
under vfat or exfat (this drive cannot hold links); a fifo, socket or device node where mknod(2)
answers the same (this drive cannot hold special files); a name the create or mkdir refuses with
EINVAL or EILSEQ (the drive's own rule, as ':' is not allowed in a name on this vfat drive, or this drive does not allow that name) or ENAMETOOLONG (that name is too long for this drive); EEXIST
under vfat or exfat beside a source sibling that differs only in case or in trailing dots and spaces, which
is the drive folding two names into one (this drive treats that name as the same as another in the folder), while EEXIST on any other drive, or with no such sibling, is another writer's and ends the
item; and a file of 4 GiB or more onto vfat. A link
is never followed in place of the link. Any other failure ends the item. A tree that landed without some
entries is a failed item, never a success: its transferitem answers ok:false with one whole sentence, <path> could not be copied: <reason> for one entry, <n> items inside could not be copied; the first is <path>: <reason> for
more, the path relative to the item and the verb moved for a move, whose source stays whole. What
landed is journaled as a partial copy with its manifest, so undo removes exactly it, and on a durable
destination it is still confirmed before transferdone. At the top of the selection the same refusal is
the item's own failure with the reason as its err. Each entry is named on transferdone's refused.
Copies onto removable, phone and network targets are durable before "done". When the
destination classes usb, phone or network, sits on a disk that can be pulled out which that class does not
name (an SD card in a PCI reader, a drive behind a Thunderbolt or USB4 port, a btrfs or dm-crypt stick,
see src/backend/removable.rs), or its filesystem is vfat, exfat or ntfs, each file is
fsync'd after its last write and every directory Flea created or wrote into is fsync'd before the
transfer reports done. An rclone mount is the exception: the copy lands in rclone's cache first,
so no fsync forces its upload and the done line names the background upload instead. Local btrfs and ext4 targets keep today's behaviour. A failed file fsync fails
that item like any other copy error and journals the partial for undo. The same rule covers a
same-directory duplicate, a redo of a copy, and a same-filesystem rename onto a durable target:
the new files are fsync'd, and the destination directory (and the source directory for a move)
with them; a rename that already landed reports success either way, because claiming otherwise
would lie about what happened.
A choice for names that already exist rides on two optional fields, collide and collideId:
Example: {"c":"transfer","op":"copy","paths":["/home/gm/Desktop/screenshot.png"],"dest":"/home/gm/Pictures","collide":"replace","collideId":7}
collide is "keep", "replace", "skip", "refuse" or "merge", and collideId is the id of the
collisions question it answers. A merge carries one more field, inner, the second card's answer
for files that exist in both, with the same four words and no merge of its own.
Example: {"c":"transfer","op":"copy","paths":["/home/gm/trip"],"dest":"/home/gm/Pictures","collide":"merge","collideId":8,"inner":"keep"}.
A missing collide is the transfer exactly as it was before this
field existed, so an older client is unchanged; any word but those five refuses, so a malformed choice
can never replace. The choice covers only what the question listed: an item whose source that
question named for this same dest, whose name there still holds the same item it held then (device,
inode and file type). A name that appears after the question, or whose item was swapped since, is
refused exactly as before whatever the choice, and so is every name when collideId names no
question, another destination, or a question an earlier transfer already spent.
keep lands the incoming item under the name duplicate would give it, worked out in dest:
photo copy.png, then photo copy 2.png. skip leaves the item where it is and counts it in
transferdone's skipped, with no transferitem line. merge folds a folder landing on a folder
together instead of replacing it whole: everything missing in the destination is copied or moved
in, and folders inside merge the same way all the way down; see mergecollisions. A folder is
merged only while it still holds the item the question saw, and files that exist in both take the
transfer's inner answer, keep, replace, skip or refuse, asked once by that walk before
anything is written. No answer ever overwrites without it. replace moves the item already there to the
freedesktop trash first, through the same gio call and URI capture trash uses, and then transfers
the incoming one under the name; a folder is replaced whole and never merged into. A trash that refuses
fails that item with the item already there could not be moved to Trash, so nothing was replaced and
touches nothing. An item already there that holds any source this transfer names, the item's own or
another's, fails with the item already there holds the one being moved in, so it was not replaced,
because trashing it would take that source along; and an incoming symlink that resolves to the item
already there now, or whose own text leads back to that name once the link sits there (looked up the way
the kernel would, through any other link on the way), fails with the incoming link points at the item already there, so it was not replaced, because the copy would be a link to itself. A lookup that passes
40 links without reaching that name is let through like a dangling link: the kernel refuses it either
way, and the item it replaces waits in Trash for undo. A replace whose
transfer then fails, a cancel included, puts the trashed item straight back when nothing took its name,
and otherwise leaves it for undo. When that put-back itself fails, the item's err gains ; the item it replaced is still in the Trash and the reason, and the trash step stays in the journal so undo can
still restore it. A cancel gains it too, as cancelled; the item it replaced is still in the Trash (<reason>),
and that item is counted in failed, not skipped, because its name no longer holds what it held;
transferdone still says cancelled. The trash and the transfer are one journal entry, see undo.
Any collide word also settles an item that already lives in dest. A copy lands under
duplicate's name, and a move is left where it is and counted in skipped, with no error. Without
collide both still fail with already in that folder.
{"c":"collisions","id":<uint>,"paths":["<string>",...],"dest":"<string>"}
Example: {"c":"collisions","id":7,"paths":["/home/gm/Desktop/screenshot.png","/home/gm/Desktop/notes"],"dest":"/home/gm/Pictures"}
Asks, before a transfer is sent, which of the items it would name already have their name taken in
dest, and answers one collisions line carrying the same id, unless a later collisions is sent
before it is done, below. rows may be sent instead of
paths and is resolved against the listing exactly as transfer resolves it, and a menuId asks
about that menu's captured selection instead, the one a transfer with that menuId runs on.
Example: {"c":"collisions","id":8,"menuId":31,"dest":"/home/gm/Pictures"}
It is read-only and never walks a tree: one lstat per source, one per destination name and a resolve
of each source's folder. That still measured 0.9 s for 100,000 local sources, and a network mount pays a
round trip for each, so the question runs on a thread of its own and the loop keeps answering other
requests; the collisions line arrives whenever it is done, and a client waits for it before sending
the transfer. A source that is not absolute, that no longer exists, or that already lives in dest
is not counted, because the transfer settles those without a question. A dest that is missing,
relative, not a directory, or cannot be written answers a total of 0, and the transfer that follows answers its own
error.
The backend keeps the latest question: each colliding source with the identity of the item its
name holds in dest, which is what lets a transfer naming this id in collideId apply one choice
to exactly those names. It is kept before its collisions line is written, so a transfer sent after
that line always finds it. The latest question asked is the one kept and the only one answered: an
earlier question still being asked when a later one arrives is dropped without a line, the way a result
for a superseded listing is, so it is never answered after the later one's; a client asks one question
at a time and waits for its line. The next file transfer spends the kept question whether or not it names it. A menuId question also keeps the menu's selection and destination as it saw them,
and a transfer carrying that menuId and naming this question in collideId runs on that capture:
Copy to closes its dialog, which sends menuaction close and expires the live selection, before the
answer comes back. The capture holds the same device, inode and type identities the live selection
does, and they are still checked per item when the transfer runs. Collision destination identities
also compare birth time when the filesystem reports it on both sides. A menuId whose selection has
already expired answers a total of 0, and the transfer then answers Selected items changed; reopen the menu..
FAT-family destinations are answered inside this round trip. When dest is on vfat, exfat,
fat, fat12, fat16, fat32, msdos, ntfs or ntfs3 (read off /proc/self/mountinfo, never
from a name) and the question carries no fat, a source whose name that filesystem refuses is answered
with one fatnames line (below) in place of the collisions line. The client asks the same question
again with "fat":"rename" or "fat":"skip" and gets the collisions line for the names that will
land: Rename and copy asks about the renamed leaves, Skip them leaves the refused names out. Rename and
copy also renames, by the same rule, every UTF-8 name the transfer writes inside a folder it copies or merges into, and writes a name that is not UTF-8 as it is;
Skip them skips only the listed top-level names and leaves the names inside as they are. A redo of that copy writes the same names. The
transfer or link that follows names the same answer in fat beside collideId, so the names the
card promised are the names the operation takes, and a skipped name never lands at all. Each forbidden
character (: ? * " < > |) becomes an underscore, trailing dots and spaces are trimmed, and a name of
only dots becomes _. A dest on any other filesystem, or one whose mount cannot be read, never
answers fatnames, and a fat sent to it changes nothing, so nothing is ever renamed on a guess.
Without fat both requests behave exactly as before, which is every older client. The merge walk
takes the answer from the collisions question it follows, so under Rename a name inside a merging folder
is asked about under the name the transfer writes, and a renamed name that meets an existing one gets the second card's question.
{"c":"mergecollisions","id":<uint>,"paths":["<string>",...],"dest":"<string>"}
Example: {"c":"mergecollisions","id":8,"paths":["/home/gm/trip"],"dest":"/home/gm/Pictures"}
Asks, after the first card answered merge, which files inside the merging folders already have
their name taken in dest, and answers one mergecollisions line carrying the same id. rows
may be sent instead of paths and a menuId asks about that menu's captured selection, exactly
as collisions does, and the walk reuses the first card's capture rather than the live selection
its dialog already expired. It is read-only and runs beside the loop like collisions: one walk
of the sources against the destination, made before anything is written, gathering every relative
name both sides hold except folders that merge further down. The transfer that follows names this
question in collideId and carries the second card's answer in inner; a name that appears after
the walk, or whose item was swapped since, is refused exactly as before whatever inner says.
{"c":"pasteimage","dest":"<string>","name":"<string>"}
Example: {"c":"pasteimage","dest":"/home/gm/Pictures","name":"Pasted image 2026-09-23 at 10.14.32.png"}
Writes the clipboard's image as a named file in dest, the p key with no paths on the
clipboard. The bytes never cross this wire: the backend runs wl-paste --type image/png
itself, refuses an image past 256 MiB and one that never arrives within 30 s, and streams the
rest into the destination through an O_EXCL temp published by a no-replace rename, which a FAT
destination takes where it takes no hard link, so a name that appeared meanwhile is never replaced.
A name already taken lands beside it as stem (n).ext; a clipboard holding no image answers an
error line carrying "code":"emptyclipboard", which the UI words itself; a name that is empty, . or .., or carries /, is refused before anything runs. The answer
is the same made line a new file gets, and one journal entry named paste, so z undoes it; redo
refuses it, because a clipboard has no recorded source to replay.
TUI copy requests paths with "hold":true and a request id. Replies echo the id and listing generation,
including failed identity captures, so a delayed failure cannot clear a newer copy request.
Successful replies include held, one source identity per path. The identity stores absolute
path, decimal-string dev, ino, kind, and born (null or a two-string
seconds/nanoseconds array), preserving integer precision. Capture runs off the
backend loop with the existing mount deadline. The client retains it through
navigation and collision confirmation. The link request carries that same held
array. The link worker checks each source against it before any destination action;
a missing or changed source fails without creating its link. Existing clients may
omit held. Every successful link still records the existing journal step.
{"c":"link","op":"<string>","paths":["<string>",...],"dest":"<string>"}
Example: {"c":"link","op":"relative","paths":["/home/gm/a.png"],"dest":"/home/gm/Pictures"}
Creates one link per top-level path inside dest. op of "absolute" stores
the full path, "hard" creates a hard link, and anything else, including a
missing op, links relative from the destination, so a malformed request can
never write an absolute path by accident. Like transfer, this names paths
rather than row indices, and a rows array of indices into the current
listing may be sent instead of paths, resolved the same way; paths wins
when both are present. A link whose listing is not the numbering in force
is refused with where of stale before a single index is resolved, the
same rule transfer follows.
This runs beside the loop and takes the non-job operation slot:
the busy check and the collide answer are decided on the loop, then one
thread links each source, replacing through the trash when the card chose
it, and the answer is written from its message. A source or the destination
on a mount with a pending slow write waits first, the same gate every other
write passes. A Replace trashes through
gio, which stalls on an unresponsive mount, so that work never runs on the
loop's own thread. A link arriving while an operation runs
answers an error line carrying an operation is already running and journals nothing. The answer is one linked line,
{"t":"linked","ok":<uint>,"failed":<uint>,"skipped":<uint>}, and one journal
entry, so one undo removes every link this request created. note rides on that line whenever a link this request
made could be neither verified nor removed, plain or replacing, naming each leftover link and its cleanup error as the link at <path> could not be removed: <reason>, followed by
; the item it replaced is still in the Trash where a replaced item was kept, and ahead of that a mixed batch's first
failure, so a batch that lands some links still names what the rest failed with. An all-failed batch answers an error line with where of link carrying the first
failure with that note appended, naming the failing source as <source>: <message>. A source that no longer exists is refused
for that item and counts in failed, so one missing source never stops the rest. A name that
already exists is refused for that item unless the request carries the
collide and collideId choice a transfer carries, applied by the same
rule: only what the question listed, only while the name still holds the same
item. keep lands the link under the name duplicate would give it, skip
leaves the item where it is and counts it in skipped, and replace moves
the item already there to the trash first and then links under the name. A
hard link across drives is refused with both filesystem names in the
sentence, and a hard link to a folder is refused outright. A dest that is missing, relative, not a directory,
or cannot be written answers a single error line with where of link and nothing is started.
The optional target string is the selected link's held readlink value. If the
worker reads a different value, it refuses rather than following the replacement.
TUI replies must also match the held request id, source path and listing generation.
{"c":"linktarget","path":"<string>","id":<uint>}
Example: {"c":"linktarget","path":"/home/gm/latest","id":3}
Answers one linktarget line,
{"t":"linktarget","path":"<string>","directory":"<string>","name":"<string>","id":<uint>},
naming the folder the symlink's target lives in and the target's own leaf, the
same path Show in folder uses. id echoes the request's, so a reply landing
after the pane navigated elsewhere is answered only when it still names the
pending one. directory is the target's folder with every
symlinked folder and .. resolved the way the kernel follows them, falling back
to the link text's own split when it cannot be resolved, and the line is answered
from a thread, as meta is. A path that is not a symlink answers an error
line with where of linktarget and touches nothing.
{"c":"permissionsBatch","paths":["<string>",...],"modes":["<string>",...],"id":<uint>}
Example: {"c":"permissionsBatch","paths":["/home/gm/a.txt","/home/gm/b.txt"],"modes":["600","600"],"id":7}
Changes the mode of every named path to its own target mode, each following
the same three-or-leading-zero-four octal rule the dialog's own apply
enforces, and answers one permissions line with op of applyMany,
{"t":"permissions","id":7,"op":"applyMany","ok":true,"mode":"0600","error":""}.
One journal entry holds every path the Apply changed, so one undo restores
them all. A permissionsBatch arriving while an operation runs answers ok false with
an operation is already running and changes nothing. Octal, Owner, Group and the change preview drop out for several
items: the grid and Apply are the whole card. A mixed box the operator never
touched keeps each file's own bit, because the client sends that file's own
target mode rather than one mode for all.
{"c":"transfercancel","id":<uint>}
Example: {"c":"transfercancel","id":12}
Cancels the waiting or running job named by id, including a transfer, archive extract, or
compression, and does nothing for a stale id. Other jobs keep running or waiting independently.
A convert is not a jobs operation and cannot be cancelled by this request. There is no response line
of its own: a transfer answers with its own transferdone carrying cancelled true, and an extract
answers its own archivedone with ok false and an err of cancelled, including when cancelled
before it runs.
The item in flight is stopped rather than allowed to finish, and what it had already written is
removed: a partial file by copy_file, a partly-copied directory by copy_dir. A cancel that waited out a multi-gigabyte copy would not be a cancel, and a half-written file
at the destination is not a result anyone asked for. That item is reported ok:false with an err of
cancelled; every item not yet started is counted in skipped. A cancelled extract stops and reaps
its sandboxed child, removes its staging directory and publishes no destination, so the same rule holds
there without a partial tree. When the archive tool has not exited ten seconds after the cancel, its work
folder is left in place rather than deleted under a live writer, and the err names that folder.
A quit, or stdin closing, cancels a running operation the same way and waits for its terminal line
before the process exits, so shutting down mid-copy also leaves nothing half-written behind. The cancel
lands as the line or the end of input is read, as transfercancel's does, so a listing still out cannot
hold the copy running behind it. A
quit sets each detached compress and convert flag too and drains them under the one 25 s shutdown
budget, so each job's Work cleanup runs before the process exits and no .flea-work-* folder is
left beside the destination. A job whose tool has not exited ten seconds after the cancel keeps its folder in place
and its terminal err names it; one still running when the budget ends is abandoned with the process.
{"c":"flashimage","path":"<string>"}
Example: {"c":"flashimage","path":"/home/gm/Downloads/raspios-arm64.img.xz"}
Classifies one image and answers one flashimage line. The kind comes from the name and is
confirmed by magic bytes: .iso (ISO 9660 CD001 at 32769), .img and .raw (anything),
.img.xz (FD 37 7A 58 5A 00), .img.gz (1F 8B), .img.zst (28 B5 2F FD),
.img.bz2 (BZh), .zip (PK 03 04). A name and magic that disagree answer "kind":""
and the row is refused with "This is not a disk image Flea can flash." The unpacked size is
read in the sandbox, never parsed in Flea's own process: xz --robot --list for xz,
zstd -lv for a frame that records its content size, and the archive listing Flea already
runs for a zip. gzip's size field wraps at 4 GiB and bzip2 has none, so both answer
known:false. A zip qualifies only when its listing has exactly one member and that member
is an image by the rules above.
{"t":"flashimage","path":"<string>","kind":"iso|img|xz|gz|zst|bz2|zip","bytes":<uint>,"unpacked":<uint>,"known":<bool>,"member":"<string>"}
bytes is the file's own size. unpacked is the size that will be written, or 0 when
known is false. member names the zip's one image member and is empty otherwise. A
refused row answers "kind":"" with unpacked 0, known false and member empty.
{"c":"flashtargets","image":"<string>"}
Example: {"c":"flashtargets","image":"/home/gm/Downloads/debian-13.iso"}
Answers one flashtargets line listing every eligible drive in /sys/block order, with
the refusals the image causes. image may be empty, which is a pane opened from a drive:
every drive then lists with no small refusal. Never lists a drive the safety model
excludes; see "The image flasher" in AGENTS.md.
{"t":"flashtargets","drives":[{"dev":"sda","seq":<uint>,"serial":"<string>","label":"128GB","model":"General USB Flash Disk","bytes":<uint>,"volumes":["128GB"],"refused":""}]}
seq is the kernel's diskseq, which never repeats within a boot, so it names this
plugging of this medium. label is the rail's name when the drive shows as one rail row,
else the model. model joins vendor and model the way omarchy-drive-info does. volumes
names the drive's partitions. refused is one of small, readonly, holdsimage,
member (part of a RAID or volume group), or empty when the drive takes the image.
{"c":"flash","id":<uint>,"image":"<string>","dev":"<string>","seq":<uint>,"serial":"<string>","bytes":<uint>}
Example: {"c":"flash","id":31,"image":"/home/gm/Downloads/debian-13.iso","dev":"sda","seq":2,"serial":"2003007157171692","bytes":124623257600}
Writes the image to the drive the Flash step named and verifies it. The identity fields
are the ones the Flash step showed when it was pressed; if any differs when the backend
re-reads it, nothing is touched and the answer is flashdone with err changed. A
flash is keyed by its own id and runs alongside a transfer, because its target is a
device no transfer can reach; one flash runs at a time per backend, and a second answers
an error line with where flash rather than queueing.
Answers: one flashstarted, a stream of flashprogress throttled to one line per
150 ms, the transfer rule, and exactly one flashdone.
{"t":"flashstarted","id":<uint>,"total":<uint>,"known":<bool>}
total is the unpacked size when known is true and the file's own size otherwise.
{"t":"flashprogress","id":<uint>,"phase":"prepare|password|write|flush|verify","bytes":<uint>,"total":<uint>,"permille":<uint>}
bytes counts bytes the device accepted (write) or read back (verify). permille is
the share done: bytes over total when the size is known, else the offset of the
compressed file the decompressor has consumed over its size. Once the write ends, total
is the byte count written, so flush and verify measure against it even when the size was
unknown. prepare runs while the backend re-reads the drive and asks the helper to confirm
it, password runs from the helper's spawn to its descriptor, flush covers the final
fsync.
{"t":"flashdone","id":<uint>,"ok":<bool>,"phase":"<string>","at":<uint>,"err":"<string>","blank":<bool>}
err rides only on a failure: cancelled, denied (the prompt was dismissed or
refused), busy (a volume would not unmount), changed (identity differs), gone
(the device vanished), io (a write or read failed), verify (read-back differs,
at is the first differing offset), nospace (a stream outgrew the drive),
decompress (the decompressor failed or stalled), sandbox (bwrap or prlimit
missing), helper (the helper or udisks failed). blank says whether the drive's ends
were wiped, and is true only when the wipe itself succeeded: a write that ends cancelled,
nospace, decompress or io, a cancel or quit during the final flush and a verify
mismatch wipe. blank is false where nothing is wiped: sandbox, which is found before
the first byte moves, every refusal before the descriptor, a drive that is gone, and a
cancel during verify, which leaves the whole image on the drive and offers Eject alone. A pane that sent an image no probe answers
receives phase probe with err io; the pane never sends one, because Flash is
unavailable until the probe answers a kind.
{"c":"flashcancel","id":<uint>}
Cancels the flash id names and nothing else, as transfercancel does. No line of its
own; the flash answers its own flashdone with err cancelled. Only Cancel stops a
flash: Esc leaves the pane and never cancels one, and a quit, or stdin closing,
cancels the flash and waits for its flashdone, so the drive ends blank rather than
half written. A cancel that lands during the verify is the one exception: the image is
whole and proven so far, so it stays and blank is false.
{"c":"flasheject","dev":"<string>","seq":<uint>}
Example: {"c":"flasheject","dev":"sda","seq":2}
Answers {"t":"flasheject","ok":<bool>,"err":"busy|gone|changed|error"}. Unmounts every
mounted filesystem on the drive, then powers it off. The message the user reads is the
rail's own, so "Ejected 128GB, it is safe to unplug." is the shipped string. seq names
the plugging the step showed; a drive that changed since answers changed. A dev that is
not a bare kernel name, or a drive the flasher would not list (a system disk), answers
error before the helper runs.
{"c":"trash","id":<uint>,"paths":["<string>",...],"rows":[<uint>,...]}
id is the client's request id; the trashed line that answers it echoes it. Omitted, it is 0.
Example: {"c":"trash","id":3,"paths":["/home/gm/old.txt"]}
Example: {"c":"trash","id":4,"rows":[4,9]}
rows is the same alternative to paths that transfer documents above, resolved the same way.
Moves each path to the freedesktop trash by running gio trash under a 10 s deadline, and answers
one trashed line.
Nothing about the freedesktop trash specification is implemented in this codebase, only an argv and
a result: gio already handles the same-filesystem-move-versus-copy question, the .trashinfo
metadata, and the per-mount .Trash-$uid fallback for a volume with no home-relative trash.
Which paths actually went is read off the filesystem afterwards rather than from gio's exit status,
which covers the whole batch and cannot attribute a failure to one path.
The trash URI of each item is captured at trash time, and this is a measured requirement rather than a
preference. gio trash --restore refuses an original path outright (Location given doesn't start with trash:///), and two files trashed from the same path both list that same original, so recovering
the URI later is ambiguous. The backend therefore reads gio trash --list immediately before and after
the call and keeps the entries that are new, which is what makes the operation reversible.
There is no confirmation step anywhere in this request, because the undo journal is the safety.
An accepted request first flushes {"t":"trashstarted","id":<uint>,"n":<uint>,"cancellable":false},
before the worker touches the Trash or the client re-lists. n counts the resolved top-level paths.
This acknowledgement lets the client draw its pending operation immediately. It is followed by the
existing trashed outcome; journal settlement and its ordering are unchanged. Ordinary trashing does
not poll a cancel flag, so this acknowledgement must not expose a Cancel action.
{"c":"trashbrowse","op":"prepare","id":<uint>,"all":true,"emptyTrash":true} reviews the
current Trash and answers {"t":"trashbrowse","op":"prepare","id":<uint>,"ok":true, "token":<uint>,"all":true,"count":<uint>,"bytes":<uint>,"partial":false}. The confirmation body
uses this reviewed count and byte total, including zero bytes for empty files. A partial, pending,
or failed review supplies no actionable confirmation. Preparation and validation query item details
in bounded groups of 128, with the same complete snapshot and identity checks as individual queries.
{"c":"trashbrowse","op":"delete","id":<uint>,"token":<uint>} deletes that reviewed snapshot.
An accepted delete claims the non-job operation slot and immediately flushes
{"t":"trashdeletestarted","id":<uint>,"requestId":<uint>} followed by a transferprogress line,
before any queued Trash request, validation, or filesystem work. id is the operation id accepted by
transfercancel; requestId is the browser request's id. A busy refusal answers only the ordinary
trashbrowse error and starts no job. A pending unsettled trash journal also refuses deletion.
The job uses the operations card's existing progress and terminal types:
{"t":"transferprogress","id":<uint>,"index":0,"name":"<string>","itemSize":<uint>,"bytes":<uint>,"total":<uint>,"unit":"items","phase":"checking|deleting","checked":<uint>}
unit:items changes the meaning of bytes and total for this operation only: they count deleted
and reviewed filesystem entries, including descendants, directories, and zero-byte files. The totals
come from the complete saved snapshot, so one trashed folder can report thousands of files. The
trashbrowse prepare reply's count and the terminal item counts remain top-level Trash entries.
The immediate sample has total 0 until the worker reads the confirmation; later samples carry the
recursive total. During
checking, bytes stays 0 and checked counts validated top-level items; during deleting, bytes
counts successfully removed entries, including children of a folder interrupted later. Refused entries
do not advance this bar. name is the original name of the top-level item in flight and itemSize
is its reviewed recursive byte size; an empty name means no current item. Samples are throttled to
150 ms, with immediate phase, first-item and final samples. Tree nodes poll cancel and sample progress.
The native card's head is Emptying Trash. Show validation during checking, then the determinate
file-count bar and deleted-file count, with the current name and size on its file line. Byte rates
cannot be derived from these counts; a remaining-time estimate must use observed file deletions per
second and is unavailable during checking. Keep the Trash strip's prior count until completion,
then refresh it. The Empty Trash control stays in place and is disabled while the job runs.
Exactly one transferdone releases this job's slot, followed by its original trashbrowse delete
reply. ok, failed, and skipped on transferdone count deleted, refused, and unstarted items;
cancelled reports interruption. A validation failure carries its sentence in note, and the browser
reply retains the existing ok:false, stale, and error fields. A completed or interrupted deletion
retains done, failed, and failures, and adds skipped, cancelled and leftover, the
count of entries the listing left out that the sweep kept on disk: a record kept beside a claim's
quarantine counts, and an entry a cancel stopped the sweep before trying does not
(docs/architecture/write-operations-and-the-undo-journal.md). Deletion is irreversible and creates
no undo entry. Cancellation during validation preserves the confirmation for another attempt. Once
deletion starts it consumes the token, so remaining items require a new review.
Cancel, quit, and stdin closing poll the same flag between items and between tree nodes. Completed
deletions stay deleted. An interrupted folder's surviving payload and .trashinfo are put back
together; a failed rollback retains the existing recovery record and names its quarantine in the
failure. A cancel for another operation id has no effect. The terminal replies precede any client
re-list, so displaying progress and completion never waits for that re-list.
Accepting delete supersedes earlier browser reads and confirmation checks through the browser's request generation. Its independent operation flag accepts cancel while the job is still queued; later browser reads cannot cancel the delete. A superseded check answers its ordinary cancelled error.
{"c":"rename","path":"<string>","to":"<string>"}
Example: {"c":"rename","path":"/home/gm/old.txt","to":"new.txt"}
Inline editors preserve the displayed row's optional source string, encoded as decimal
device:inode:file-type, and send it on commit. The backend checks that identity in the rename
worker using the same selected-item guard as menuId; a replacement or missing source is refused
without moving it. Metadata and contents may change while the same inode remains selected.
Rows without this lstat identity use an asynchronous menu snapshot before the editor opens, then
commit with that snapshot's menuId. Virtual plugin places retain their provider's operation
contract because their rows have no filesystem inode. Older callers may omit both fields.
Renames one file within its own directory and answers one renamed line. to is a bare name, not a
path: an empty to, ., .., or anything containing / or an interior NUL is refused with an error
line before any syscall runs, because a separator would move the file out of its own directory.
The rename refuses to overwrite. It runs renameat2 with RENAME_NOREPLACE rather than
rename(2), which on Unix silently replaces the target; for a file manager that is unrecoverable data
loss, and the check-then-rename alternative leaves a window in which another process can create the
target. Renaming a file to the name it already has is not an error and is not work: it answers ok and
records nothing to undo.
A rename that cannot prove the source survived whole answers rename-kept. Measured mounts that cannot serve
RENAME_NOREPLACE include fuse.rclone directories and fuse.megafs paths, which answer EINVAL, and a path under a
/run/user/*/gvfs/dav: WebDAV mount answers EIO. On those, the backend builds the new name through the same exclusive copy primitives every
other write uses and removes the source only once that copy is complete. The copy is taken back only on proof the source
survived whole: a source that still stats as anything but a directory after the failed removal, since
remove_file removes every other kind with one unlink that either takes effect or does not. That answers a plain rename
error, and so does a failure to take the copy back, in which case the copy stays under the new name
and that error's path is the copy rather than the source. Every other state keeps the copy, a directory source because remove_dir_all
stops at its first failure, and a source that no longer stats because an errno alone cannot tell a
removal that took effect from one that did not. The request then answers an error line whose
where is rename-kept, whose path is
the source, and whose msg is the removal's own message; the target is on neither field. Neither
direction journals the kept copy, so no undo removes it: the removal can stop partway, and one error
with no account of how far it got cannot tell a whole source from a remnant or from one already gone. An undo reverses a
rename through the same call, so a reversal that half succeeds answers this same where. A case twin
whose move-back from its temp sibling fails answers rename-stranded instead: its path is the
source, its msg names the temp leaf and the move-back's cause, and the file stays under that
hidden name.
Unlike the three above, this answers on the loop's own thread on a local mount: the ordinary
case is one renameat2, which costs less than spawning a thread. On a remote mount it runs on its
own worker with the single-call deadline and answers slow first, then its renamed line when the
write lands, journalled exactly as the in-time path would journal it; see slow. The compatibility
paths above are not one syscall, and on a remote mount they run on that worker too, so a directory
rename on rclone or MEGA no longer holds the loop while it copies. See AGENTS.md, "Write operations
and the undo journal".
{"c":"bulkrename","paths":["<string>",...],"names":["<string>",...]}
Example: {"c":"bulkrename","paths":["/home/gm/a.txt","/home/gm/b.txt"],"names":["b.txt","a.txt"]}
Renames every named path to its bare new name in the same directory and answers one bulkrenamed line,
{"t":"bulkrenamed","ok":<uint>,"unchanged":<uint>}. The two arrays run in parallel: names[i] is the new bare name for paths[i]. The whole batch is validated before anything moves: an empty batch, a length mismatch, a non-absolute or repeated path, paths in more than one folder, a missing source or one replaced by another item before the first move, an empty name, ., .., a name containing /, NUL, CR or LF, a name over 255 bytes, two new names that collide, or a destination that already exists outside the batch all refuse the whole batch with an error line whose where is bulkrename, and nothing on disk moves. A destination that is itself one of the batch sources is allowed: swaps and cycles move through temporary names in the same folder, so a to b and b to a works. A name equal to its own source is unchanged rather than work: it counts in unchanged and records nothing. The whole batch is one journal entry, so one undo reverses every rename it made, newest first; a failure partway journals what landed the same way, so undo still reverts the partial batch. Like rename it answers inline on a local mount and on a remote mount runs on its own worker with the single-call deadline, answering slow first and its bulkrenamed line when the batch lands; see slow.
{"c":"duplicate","path":"<string>"}
Example: {"c":"duplicate","path":"/home/gm/photo.jpg"}
Copies one path to a free sibling name and answers one duplicated line. The name walks
"<stem> copy<ext>", "<stem> copy 2<ext>" and so on until one is free; Path's own stem and
extension split the last dot only, so backup.tar.zst becomes backup.tar copy.zst and a dotfile keeps
its whole name as the stem. A directory row duplicates its whole tree.
duplicate and mkdir also accept an optional positive integer request. Without it, or with
zero, their existing operation and error lines are unchanged. An opted-in request keeps that
payload and adds request to its successful duplicated or made line, followed by one
{"t":"menuaction","op":"creation","id":<request>,"kind":"duplicated|made","ok":true,"path":"<created path>"}.
A refusal instead keeps its original error line and adds the same receipt with ok:false and
error in place of path. Busy refusals and slow completions carry the exact original request,
so concurrent results need not arrive in request order. Correlation changes no operation slot,
pending mount claim, journal entry or creation-name rule; independent request fields retain their
meaning. Both completion lines are published together before quit can observe a finished slot.
{"c":"mkdir","path":"<string>","name":"<string>"}
Example: {"c":"mkdir","path":"/home/gm","name":"Invoices"}
Example: {"c":"mkdir","path":"/home/gm"}
Makes one empty directory inside path and answers one made line. path is the absolute parent: a
relative or missing path is refused before any syscall, because a bare name would otherwise land in
the backend's own working directory, which no listing ever names. name is a bare name under the rule
rename applies to to: ., .., anything containing / or an interior NUL is refused with an
error line whose where is mkdir. A name of only spaces is a legal name and is created as sent,
as it would be by rename; trimming is the field's job.
A missing or empty name asks for the first free default name, New Folder, then New Folder 2
and up, the same way duplicate picks copy N itself rather than leaving it to the client: a client
holds a window of the listing and not the directory, so it cannot know which names are taken, and a
name taken by anything, a file included, is stepped past. That is the form an inline
create-then-rename flow sends; the made line then carries the name that was chosen. A typed name is
never renumbered.
The directory is created with mkdir(2) and never merged into one already there. A name already
taken by anything, file, directory or symlink, answers a folder or file with that name already exists and touches nothing, the same rule archivework.rs states for its own staging directories.
Every other failure carries src/error.rs's plain sentence as msg: a parent that vanished since the listing
answers item not found, a parent the user cannot write permission denied, a read-only mount the drive is read-only, a name past NAME_MAX that name is too long.
Like rename, this answers on the loop's own thread on a local mount and never takes the
one-operation slot; on a remote mount it runs on its own worker with the single-call deadline and
answers slow first, then its made line when the write lands; see slow.
{"c":"meta","row":<uint>,"text":<bool>,"media":<bool>,"archive":<bool>}
Example: {"c":"meta","row":4,"text":false,"media":false,"archive":true}
The per-row extras the preview column names and a listing row does not carry, for one row that a
client actually asked for, never a sweep. row indexes the current listing, and a row outside it
is dropped in silence, so a client that changed directory has to re-ask once the new rows arrive.
Answers one meta line on a thread, because a media row costs an ffprobe and the loop waits on it.
The three booleans are the client's own hints, taken from the classification it already made: text
asks for a line count, media for a duration and sample rate, archive for the index. Each costs
something, so none is inferred here. A file whose header parses as an image is never counted for
lines whatever text says, because the newlines in a bitmap are a number nothing should be shown.
{"c":"shebang","path":"<string>","id":<uint>}
Example: {"c":"shebang","path":"/home/gm/run.sh","id":3}
The cursor row's two-byte #! probe behind the Make executable menu row, for one path the
client named, never a sweep: only a regular file without its owner execute bit is ever asked
about. Answers one shebang line, {"t":"shebang","path":"<string>","hasShebang":<bool>,"id":<uint>},
on a thread, because an open on a hung mount never returns and the loop waits on nothing. The
id echoes the request so a later answer never arms an earlier row: a client that asked twice
keeps the newest id and drops any line naming an older one. A path that is not a regular file,
or that cannot be read, answers hasShebang false rather than an error, so the row stays absent.
{"c":"code","token":<uint>,"slot":"<string>","path":"<string>"|"text":"<string>","name":"<string>","lang":"<string>","first":<uint>,"count":<uint>,"raw":<bool>,"csv":"<delimiter>","record":<uint>}
Example: {"c":"code","token":4,"slot":"look","path":"/home/gm/a.rs","first":40,"count":20} and
{"c":"code","token":5,"slot":"fence:2","text":"fn main() {}","name":"x.rs","lang":"","first":1,"count":10}
The syntax-coloured lines first to first + count - 1 of one file or one text a client
actually asked for, never a sweep. A request holding text sends the bytes the client already
holds, with name picking the language when lang is empty (a Markdown info string names it in
its first word); without text the backend opens path, which a client never sends for a file on
a network or phone mount. first counts from 1 and count is capped at 400 lines (the line cap,
lineCap in ui/CodeLines.qml, which asks a longer window in parts), absent meaning the cap. raw true skips the colouring and answers the lines plain. Answers one code line on a
thread. A newer request on the same slot ends the older job and the older reply is never sent,
so a client matches the token of what it last sent and drops any other. At most 1,048,576 bytes
of a file are ever read, and bat runs in the same read-only jail as the other helpers, on the
bytes the verdict was made on.
A raw table request may carry csv: "," for CSV or "\t" for TSV. The backend scans
the already loaded bytes as RFC 4180 records, with quotes opening only at a field start,
"" escaping a quote inside quotes and quotes in unquoted fields staying literal. It moves
first back to the start of the record containing the asked first line, and extends the
asked end through its record's last line, or EOF for an unterminated quote. Thus the reply
contains whole records and can exceed the 400-line request cap, bounded by the 1 MiB size
gate. No second file read or additional stat is made. An absent or invalid csv, or one
without raw: true, keeps the ordinary line window.
A raw csv ask may also carry record, a 1-based record ordinal with the header at 1,
instead of locating its window by the physical first line. The backend locates that
record in the same scan and asks count physical lines from its start, extending the
end through the last record as above. This lets a table jump directly by delegate index
without fetching a prefix or receiving a file-wide index. record is ignored without a
valid raw csv delimiter; zero is clamped to 1. A record beyond EOF returns no lines.
{"c":"html","token":<uint>,"slot":"<string>","path":"<absolute path>","width":<uint>,"height":<uint>,"cancel":<bool>}
Example: {"c":"html","token":3,"slot":"look","path":"/home/gm/index.html","width":984,"height":625}.
Renders the single page a client is previewing, never a listing. Width is the frame's device
width, clamped to 1 through 4096 pixels. Optional height is the viewport's height at that width;
when width is clamped, height scales with it, rounded up and bounded to 1 through 8000 pixels.
An omitted height retains the column helper's 600-pixel viewport. The page must be a readable regular file at most
1,048,576 bytes. A newer request in the same slot cancels the older helper and suppresses its
reply. cancel:true ends that slot without opening a page. HTML and code slots are independent.
The qml6 helper runs offscreen in its own bwrap namespace with network unshared, a 30-second CPU limit, and a 15-second wall deadline. Chromium needs large virtual reservations, so this helper has no address-space limit. Its profile is off the record, JavaScript is disabled, and navigation to another page is refused. Only the page folder is bound as /page, read-only; a content security policy restricts subresources to that folder and embedded data images/fonts. The one writable bind is a private helper directory under the thumbnail cache. All helper files are created exclusively. The confined input is bound over the page's own filename and loaded from that URL, preserving relative URLs and the document's own base element. The PNG is at least the requested viewport height and at most 8000 pixels tall, and cached by canonical path, size, nanosecond mtime, inode, device, width and viewport height. A hit also requires every engine-recorded local resource to retain its size, nanosecond mtime, inode and device. Records hold at most 256 local resources and 64 KiB; an unreadable or incomplete record forces another render. The companion cache uses the preview-cache bounds of 4096 files and 512 MiB, with a 60-second reader grace and one scan per 32 publications.
{"c":"compare","token":<uint>,"a":"<string>","b":"<string>"}
Example: {"c":"compare","token":3,"a":"/home/gm/notes-a.md","b":"/home/gm/notes-b.md"}
The unified diff of two regular files a client actually named, never a sweep; a is the first of the
pair in the listing's order and b the second. Absolute paths and readable regular files are checked
first; a refusal answers failed. Either file over 1,048,576 bytes then answers over, judged on both
files before reading their contents. The bounded contents of each file are read in pair order: a read
failure answers failed, growth past the limit answers over, a NUL byte in its first 8,192 bytes
answers binary, and invalid UTF-8 anywhere answers failed. Code preview displays invalid UTF-8
lossily, but a copied patch must preserve bytes, so Compare refuses it.
Otherwise /usr/bin/diff -u --label <a> --label <b> -- <a> <b> runs once in the same read-only jail as
the other helpers, with the two files bound read-only and nothing writable, so the patch names the real
paths. The diff has a 2 s deadline; expiry kills its process tree and answers failed. Invalid UTF-8
in the diff output also answers failed, so the clipboard never receives replacement bytes.
Answers one compare line on a thread, and token echoes the request's so a client matches the
one it last sent and drops any other.
{"c":"pdfcopy","id":<uint>,"slot":"<string>","path":"<string>"}
Example: {"c":"pdfcopy","id":3,"slot":"column","path":"/run/media/gm/128GB/doc.pdf"}
Fetches one PDF the preview actually opened into a session-private copy under an 8 s deadline, and
answers one pdfcopied line: {"t":"pdfcopied","id":3,"path":"<local copy>"} on success, or
{"t":"pdfcopied","id":3,"err":"that file is not responding","stalled":true} when the wait
runs out. err rides only on a failure, and stalled only on the wait that ran out, so a client
never reads err to tell the two apart. The id is minted by the one counter in ui/Backend.qml,
so two viewers never share one; slot names the viewer, so a newer fetch supersedes only its own
viewer's copy.
The copy runs beside the loop, so a dead mount costs the viewer a sentence and
never the window; a stale reply is dropped by its id, the way a superseded listing's result is.
{"c":"officepdf","id":<uint>,"path":"<string>"}
Example: {"c":"officepdf","id":4,"path":"/home/gm/Documents/report.docx"}
Converts one DOCX, ODT, XLSX, ODS, PPTX or RTF file to a cached PDF with LibreOffice and answers
officepdf lines carrying the request id: {"t":"officepdf","id":4,"state":"ready","path":"<cached pdf>"}
when the PDF exists, {"t":"officepdf","id":4,"state":"converting"} when a conversion started, and
{"t":"officepdf","id":4,"state":"failed","err":"<string>"} when it cannot be had. The preview's
PDF holds only the document's first 30 pages, and its ready line says so with "first":30:
{"t":"officepdf","id":4,"state":"ready","path":"<cached pdf>","first":30}. A client that reads
it shows a PDF of 30 pages as "30+", because the document may run past them; Print and Convert
convert the whole document under their own cache entry. A converting
line is always followed by one ready or failed line for the same id once the job ends, so
a client waits for that second line and treats converting as progress only. A request that
needs no conversion answers ready or failed at once and sends no follow-up.
unavailable rides on a failed line only when this file or this box will never convert:
{"t":"officepdf","id":4,"state":"failed","err":"LibreOffice is not installed on this box.","unavailable":true}.
A client that reads it keeps its existing preview and does not ask again; a failed line without
it (a converter error, a timeout, a request replaced by a newer one, a mount that is not
responding) may succeed on a later request, except that a converter error (an exit status or no
PDF) is remembered for that file until its modification time changes; a timeout is not.
The path is resolved and its cache entry looked up beside the loop under the mount deadline, so a
hung mount costs one failed line and never the window. One conversion runs at a time and the
newest request replaces the one queued behind it, whichever request finished its lookup first; a request older than the newest one started, running or already finished, is answered replaced at once and never converts.
{"c":"officesheets","id":<uint>,"path":"<string>"}
Example: {"c":"officesheets","id":5,"path":"/home/gm/Documents/budget.xlsx"}
Converts one XLSX, ODS or XLS workbook to one cached CSV per sheet with LibreOffice's CSV filter
(UTF-8, comma separated, values as the spreadsheet shows them) and answers officesheets lines
carrying the request id:
{"t":"officesheets","id":5,"state":"ready","names":["Monthly","Savings"],"paths":["<cached csv>","<cached csv>"]}
lists the sheets in the workbook's own order, each name beside its CSV at the same index.
converting and failed lines, unavailable, the remembered converter error, the mount deadline
and the one-at-a-time queue are those of officepdf above, with "t":"officesheets"; the two
requests share that queue, and a workbook's PDF and its sheets are separate cache entries.
A file that is not a spreadsheet answers
{"t":"officesheets","id":5,"state":"failed","err":"that file is not a spreadsheet","unavailable":true}.
The converter runs once over the whole workbook, then once per sheet to fix the order, skipping
the last sheet, which is the one left; a workbook with more than 24 sheets lists its first 24, one
order run each.
{"c":"settags","rows":[<uint>,...],"op":"<string>","tag":"<string>","listing":<uint>}
Example: {"c":"settags","rows":[2,17],"op":"toggle","tag":"Red","listing":7}
Adds, removes or toggles one tag across those rows of the current listing, or clears all tags
with "op":"clear", and answers one settagged line. A toggle is one decision for every row it
names, made from the attributes read before the first write: where every row already carries the
tag it is removed from all of them, otherwise it is added to all of them, so a set where only some
rows carry it never loses the tag from those rows and never ends half toggled. Flea's seven names are Red, Orange,
Yellow, Green, Blue, Purple and Gray, matched case-insensitively; a name Flea does
not know is kept untouched, never rewritten and never dropped. Every file or none: a
filesystem without user extended attributes refuses with an error line naming its filesystem
before the first write, each filesystem the rows sit on asked once, and a file that vanished or
a write that failed refuses all with exactly the files already written put back, so nothing is
half-applied. A row that is neither a file nor a folder is skipped and named in the settagged answer's skipped array while the other rows are still written, so only a real write failure rolls anything back. The change is one undo journal step per file it changed, restoring that file's
previous attribute exactly, absent included, and only onto the same file (its device and inode)
still holding the attribute the change wrote: a file replaced or retagged since is left in place
and named in the error, while the other files are restored. Redo writes only onto the attribute
undo left: a file retagged since is skipped and named, and a file replaced since refuses the redo. A settags is refused with an operation is already running while a
transfer, trash, duplicate or link holds the slot, though a local rename is not. Rows on local mounts
are written on the loop; when any row sits on a remote mount the write runs on a worker, and past
the single-call deadline it answers slow first and its settagged or error line later, the
same way a remote rename does.
{"c":"tagstates","rows":[<uint>,...],"id":<uint>,"listing":<uint>}
Example: {"c":"tagstates","rows":[0,4000],"id":3,"listing":7}
Reads which of Flea's seven tags those rows of the current listing carry and answers one
tagstates line with the same id. It reads only, so a stale listing is not refused; the answer
names the numbering its rows resolved in instead. The shipped client sends it when a menu opens over
a selection that reaches past the held window, whose rows it holds no tags for, and draws the Tags
flyout's checked and mixed marks from the answer. The read runs on its own thread, the way shebang
does, because an attribute read on a hung mount never returns; a file that cannot be read counts as
carrying no tag.
{"c":"undo"}
Reverses the most recent completed operation and answers one undone line naming which kind it was.
An empty journal answers an error line with where of undo, and so does a reversal that fails
removing what an operation created or restoring from the trash. A reversal that renames back goes
through the same call a rename does, so its failure answers rename, rename-kept or rename-stranded instead.
The journal is the session journal under $XDG_RUNTIME_DIR/flea, newest entry from any window, surviving a backend restart but not the session, with an in-memory fallback when the dir is refused. An entry too big for the file stores a small barrier, its op name only and no paths, and no window keeps the payload: the undo that claims it answers That operation was too large to undo., the next undo continues with older entries, and a barrier never enters redo. A file written by a newer version is unavailable, never rewritten: the reader falls back to memory. Each kind reverses as follows: a rename or a move renames back (still
refusing to clobber, because something may occupy the old name by now), a copy or a duplicate removes
what that operation created, a merge is undone only in the window that made it and elsewhere refuses
rather than falling back to the whole folder, a link removes only the link it made, and a trash restores through
gio trash --restore using the URI captured
when it was trashed. A hard link whose source is gone or was replaced stays as the last name holding
those bytes. A transfer that replaced an item reverses both halves in that one step, newest
first: the incoming item is removed or moved back, and then the item it replaced is restored from the
trash to its name. A reversal that fails stops the rest and is spent, except a Mode step whose file
was replaced or whose mode changed since: that step is skipped with a note while the rest restore, and
redo skips the same way. So when the incoming half cannot
go (a partial folder copy with a file inside newer than its root) or the trash cannot be read back (a
gio with no trash:// to list), the replaced item stays in the Trash, restorable from the Trash
browser rather than by undo. A partial permissions undo answers N items were left in place (1 item was left in place for one) and, when it restored any,
names how many it restored for redo, which replays the undone half before anything older. A mkdir removes the folder it made only while it is still empty: a folder the
user has filled since is theirs, so that reversal answers an error line, leaves it and its contents in
place, and is spent like any failed reversal, so the next undo reaches the operation before it.
Only what an operation actually created or moved is recorded, never a path it merely read, so an
undo can never delete a file the operation did not put there. An operation that changed nothing records
nothing, and a cancelled batch records only the items that succeeded. An item that failed short of a
cancel, and had already created its destination, records that partial destination too: the failure
leaves it on disk, because removing it on a transient error would destroy data, and the journal is what
lets undo remove it. A destination that already existed is never recorded, because nothing was created
there. The steps of one operation reverse
newest first, and a step that fails stops the rest rather than leaving the operation half-reversed with
nothing recording which half, except a Mode step, which is skipped with a note while the rest restore.
{"c":"jump","id":<uint>,"ranking":<uint>,"favourites":[<string>,...],"recent":[<string>,...]}
Example: {"c":"jump","id":3,"favourites":["/home/gm/Projects"],"recent":["/home/gm/Pictures/screenshots/shot.png"]}
A whole ask that follows a provisional one names it: {"c":"jump","id":4,"ranking":3,"favourites":["/home/gm/Projects"],"recent":["/home/gm/Pictures/screenshots/shot.png"]}.
The path bar's folder jump, asked once per open of the bar, never per keystroke: the client filters
the answer itself as the line changes. favourites are Flea's own favourites in their rail order, and
recent is the desktop's recently-used.xbel newest first, which the client reads with Qt's XML reader
because the backend has none, and keeps until the file changes. The backend adds the third source,
zoxide's ranking, from one zoxide query --list --all --score, and answers one jumped line from a thread, because zoxide is a subprocess
and a stat can block on a network mount. id is the client's own number for this open and comes back
on the answer, so an answer to an earlier open is told apart from this one's. ranking is optional (absent
or 0 names none): an open whose recent history is stale asks twice, a provisional ask with what the client
has kept and then the whole ask under a new id, and the whole ask's ranking is the provisional ask's id.
The backend keeps the zoxide ranking of the newest run that answered in time, with the id it answered, and
answers a ranking naming that id from it with no second zoxide run, so every open runs zoxide exactly once;
the cross-source dedup still happens in each answer. A ranking naming any other id, or one no run kept
(zoxide still running or past its limit, the ranking replaced by a newer ask), runs zoxide as an ask with none does.
Nothing is written. --all is what keeps zoxide from pruning its own database on a query Flea made:
without it zoxide deletes entries missing for 90 days and saves. zoxide is optional: absent, it is an
empty source and says nothing. A zoxide that runs past 2 s is killed and draws nothing, and its answer is
read up to 1 MiB and its first 1,000 rows. Only one zoxide runs at a time: an open while an earlier one is
still running draws the last ranking that answered in time rather than starting a second, and an
open with no ranking kept yet draws no zoxide. Each source is checked on a thread of its
own against one shared 1 s budget, so a stat wedged on a dead mount drops that source's rows from that one on
and never the other sources. A recent file is checked only once the folder holding it resolved, on that
same budget and under that same key rule, so a wedged recent file costs its own row and never the answer. A check still running past the budget of the open that started it is wedged, and
the next open skips what it names rather than wedge behind it: its whole mount when that mount is NFS, SMB,
9p, Ceph, AFS or FUSE (read lexically from /proc/self/mountinfo, never through the mount), its own path
anywhere else. A dead share therefore holds at most one thread per source for good, not more per open, and a
check merely slow inside its budget is run again rather than skipped.
{"c":"devs","paths":[<string>,...],"id":<uint optional>}
Example: {"c":"devs","paths":["/","/home/gm","/home/gm/Documents"]}
The device number of each path named, symlinks followed, so a path reached through a link names the volume the
link points at. The device is the number listed's v already gives for the listing itself, which is what lets
a client compare the two without a table of mounts: a plain drop onto a path moves when its device equals the
drag's source device and copies otherwise. The client asks once per listing for the ancestors of the listed
path, the breadcrumb's drop targets, and once per drag for the visible folder rows of the neighbour columns,
whose peeked rows carry no device, and keeps the answers by path. Answers one devs line from a thread of its
own, because a stat on a mount that stopped answering never returns and the loop waits on nothing. A path on a
network or FUSE mount runs under the same 5 s bound a listing has, then the mount is marked stuck for 30 s and
answers 0 at once, so a dead share costs one thread and one wait, never one per ask. An absent paths asks nothing.
Rail hover requests include a positive id, echoed in the answer, so leaving or changing a row discards its late answer.
"op":"text" uses the same queued detached owner with paths containing exactly
one NUL-free text value. It offers only text/plain;charset=utf-8, text/plain and
UTF8_STRING, with no file URI list, copy/cut marker or file token. It never changes
the TUI's copied-file selection. TUI copy-as-text joins held selected paths, URIs,
parent paths/URIs, filenames or stems with newlines. URI encoding preserves UTF-8
bytes and escapes every byte outside the unreserved set and slash.
{"c":"clipSet","op":"copy"|"cut","paths":[<string>,...]}
Owns the system clipboard for those files, so another Flea window (or Nautilus, or
Thunar) pastes what this one copied. paths are absolute; anything relative, holding a
NUL or climbing through .. is refused with an ok:false clip line and nothing is
owned. The backend makes a token, spawns a detached flea --clip-own holding the same
binary, writes it the payload and waits up to 2 s for its ready. Runs off the request
thread, the way clipGet does, so an owner that never answers holds up no other request.
Answers one clip line with op of set; see clip below.
{"c":"clipGet"}
Reads the current system selection as files. Runs off the request thread, the way other
slow reads do, because a foreign source can take up to 2 s to close its pipe. The
owner's own token type is read first, then GNOME's copied-files shape, then the
uri-list with KDE's cut marker. With no file paths, an image/png offer answers
image without reading its bytes, including when HTML or browser types are offered
beside it. An empty or text-only selection answers none. Answers
one clip line with op of get; see clip below.
{"c":"clipClear","token":<string>} or {"c":"clipClear","cut":[<string>,...]}
Clears the selection only while it still carries that token, the one clipSet
answered with or clipGet read from another Flea process. A live owner started by
this backend is withdrawn first. Otherwise, including when that owner has exited,
the token form uses the same token check, queued-selection drain and null selection
as flea --clip clear, so it can clear a selection another Flea process owns.
cleared:true means a live owner was signalled or the verified clear sent the null
selection. Both clear forms run on the clipboard mutation queue, off the request
thread. The cut form is a spent cut from another application, which
Nautilus and Thunar clear after pasting: it clears only when the current selection is
still a cut whose path list equals the given one exactly, same order, and never
clears a copy. The verified token clear, cut form and flea --clip clear check the
selection, then drain what the compositor queued behind it with one more round trip,
and send the null selection only while the checked offer is still the current one;
a newer copy answers cleared:false. The protocol has no compare-and-clear request,
so a copy made after that last round trip and before the null selection lands can
still be wiped. Answers one clip line with op of clear, saying whether it
cleared; see clip below.
{"c":"clipWatch"}
Starts the clipboard watcher: one thread holding one data-control connection, reporting
every clipboard selection (never the primary one, so a text highlight changes nothing)
as files the same way clipGet reads them. Idempotent; the UI sends it
once at start and later ones answer nothing. No reply of its own: file selections arrive
as clip lines with op of changed, a PNG offer without files as image, an
empty or text-only selection as none, and
two identical selections in a row emit once. No compositor or manager ends the thread
after one changed none line carrying the error; a dropped connection reconnects at
most once a second, at most 5 times.
Flea's private application/x-flea-clip payload is copy|cut TOKEN PID, where TOKEN
is 32 hex characters and PID is the detached owner's process id. The older
copy|cut TOKEN payload remains readable but supplies no owner-exit trigger.
The two-field form was written only by 0.3.8 development builds, never by a release.
Such a build rejects the three-field payload and reads the selection through the GNOME
fallback, so the paths and the cut operation still arrive and only the token is lost.
Flea 0.3.7 and older read no file selection.
Every watching backend, including windows that did not start the owner, holds a
pidfd for a reported Flea selection's live owner. A pid already gone at report time
(pidfd open returns ESRCH or the pidfd is already readable) triggers the same single
guarded fresh read as a later exit. A missing pid, a live process whose executable
or arguments do not identify this Flea binary's --clip-own, or another pidfd open
failure supplies no trigger and no report.
The watcher uses one reusable waiter thread and replaces its pidfd wait slot when
the reported selection changes; dropping the watching connection closes the slot
and stops the waiter. No per-copy thread or descriptor accumulates.
An owner's exit triggers a fresh connection and the same selection-reading path
as clipGet. It is never evidence that the clipboard is empty: a clipboard manager
may still be re-serving that owner's token. The reading shares the watcher's
deduping emitter and is applied only if that owner's token is still the last
reported token and no newer selection event has arrived when the reading returns.
A watcher offer read captures the report generation when its selection event arrives
and is discarded if an exit read begun after that event reports while its bytes are
pending, so a delayed offer cannot restore an ended token.
Reading the same token emits nothing; a failed reading emits nothing
and is not retried. The spawning backend's reaper only reaps, with no separate
clipboard notification hook.
Hyprland gives data-control clients no event when a selection is emptied. The
pidfd trigger covers Flea owners; a selection owned by another program and emptied
on Hyprland reports nothing until the next selection. Paste always reads fresh,
so no file operation can act on that stale watcher state. See clip below.
{"c":"plugins","op":"list","id":1}, and enable, disable, update and remove with "plugin":"<id>",
set with "plugin", "key" and "value", and add with "source" (a Git URL, or an absolute folder or ~/
folder). For validate, supply "source" as an absolute folder path; it neither clones Git nor expands a literal
~/ prefix. runtime takes "plugin" and a nested "request" object, as described under plugins runtime.
Settings > Plugins and flea plugin <verb> use the management operations. Requests are answered on their own
threads, so a clone, a pull or a start check does not hold the loop. list answers one plugins line. The management
operations enable, disable, set, add, update, remove and validate answer one pluginop line and then
the plugins listing they left, both carrying the request's id. Management changes run one at a time. A runtime
request instead answers one terminal pluginruntime line, optionally preceded by pluginprogress lines; it does
not append a pluginop line or a plugins listing.
The listing names the five built-ins first (Shelf, LocalSend, Tailscale, Dropbox, AirDrop), then every folder under
$XDG_CONFIG_HOME/flea/plugins/ whose name does not start with a dot, in name order. Each plugin carries its
manifest's facts, enabled, source (builtin, git with the origin in the plugin's own .git folder, folder
with the folder it was added from, or empty), its schema in the manifest's own shape and its settings clamped to that schema. The Shelf also carries
shelf, the ui.json shelf group and its pins. failure names why an enabled plugin cannot run, or why a folder is
not a plugin, as a code with one detail; it is empty otherwise.
The Shelf's switch is shelf.enabled, and a change of it installs or removes the bar plugin as --ui-state does. Every
other switch and setting lives in ui.json's plugins map, and set stores the value clamped. add copies or clones
into a dot folder first and renames it into place only when its manifest is valid and its id is free, so a failed add
leaves nothing; an added plugin arrives disabled. A folder add copies regular files and folders only, skips every dot
entry (.git included), and refuses a tree past 4096 entries or 64 MB with write before anything is written; each
file opens without following a link and without blocking, and anything but a regular file refuses the add. A Git add
checks its clone against the same 4096 entries and 64 MB, counting every tracked entry, dot entries included, and
setting aside only the clone's own top-level .git; past either it refuses with write before the clone moves into
place. The listing reads a Git plugin's .git/config only as a regular file of at most 64 KiB, and update lists it
through Git under a ten second deadline. A folder add records its folder in .sources/<id> under the plugins folder, never inside the
plugin; the listing reads that record only as a regular file of at most 4 KiB, and remove deletes it.
enable saves the switch and then sends the plugin's executable hello; the five second deadline starts before
hello is written, and no ready within it records start until the plugin is switched off, updated or starts.
update is git pull --ff-only and reaches only a plugin added from Git. Every Git call runs without system or user
config, hooks or fsmonitor, and update refuses with git a plugin whose .git is not a plain folder or whose config
holds anything a clone does not write (core.worktree, core.hooksPath and core.fsmonitor among them).
remove deletes the plugin's folder and its settings; a built-in refuses remove and update with builtin.
{"c":"plugins","op":"runtime","id":41,"plugin":"example.send-target","request":{"op":"targets"}}plugin identifies the installed plugin. id correlates the outer request with its progress and terminal replies.
request is the plugin operation object. The outer op is always runtime; the nested op selects the operation.
This envelope is accepted by flea --backend and the application-wide flea --plugin-host process. The latter
accepts only c:"plugins" requests.
Except for cancel, the plugin must be enabled and have no recorded failure. Ordinary operations must match a kind
declared by the manifest. run must also name a declared action. A folder field requires declared folder access
and an absolute path without NUL. If supplied, paths is an array of at most 512 absolute paths without NUL;
targets and section refuse a paths field. An action that declares text input requires the matching one-key
input object with a nonblank string within its declared character limit and no control characters.
Nested op |
Declared kind | Terminal plugin op |
|---|---|---|
targets |
send-target |
targets, with a targets array. |
send |
send-target |
done. |
run |
menu-action |
done. |
section |
rail-section |
section, with a rows array. |
list |
place |
list, with an entries array. |
copy, move, rename, delete |
place |
done. |
preview |
previewer |
preview. |
shelf |
shelf |
done. |
settings |
A plugin eligible for a lasting session | done. |
Every ordinary operation may finish with {"op":"error","message":"..."} instead. An operation whose normal
terminal response is done may emit progress before that response. See PLUGINS.md for the
operation-specific request and response fields and the shelf routing rules.
For a preview, the backend envelope names the actual selected local file:
{"c":"plugins","op":"runtime","id":47,"plugin":"example.torrent-preview","request":{"op":"preview","paths":["/home/me/sample.torrent"],"width":900,"height":600}}The file must be a regular file matching the previewer's declared MIME patterns. The backend binds that file
read-only inside the sandbox and sends the executable {"op":"preview","path":"/in/file","outDir":"/out","width":900,"height":600}.
The /in/file path in the guide's executable exchange is a sandbox path, not the host file to send in the outer
request. width and height accept numbers from 1 through 8,192 and are rounded; each defaults to 900 when absent
or invalid.
Two nested operations are handled by the host rather than forwarded as ordinary plugin requests:
{"c":"plugins","op":"runtime","id":42,"plugin":"example.send-target","request":{"op":"ready"}}
{"c":"plugins","op":"runtime","id":43,"plugin":"example.send-target","request":{"op":"cancel"}}For an installed executable plugin, ready checks startup and returns message:{"op":"ready"} on success.
Built-ins use in-process adapters rather than the executable handshake. cancel stops that installed plugin's
lasting session and returns message:{"op":"done"}. Cancellation identifies the plugin, not a particular request
id. When a lasting subprocess is stopped, Flea attempts to write {"op":"cancel"} and immediately kills its
process group; the subprocess has no guaranteed cleanup interval.
The subprocess protocol uses UTF-8 JSON objects separated by newlines. Protocol version 1 is negotiated on that separate stream, rather than on the outer backend envelope. The initial exchange is:
{"op":"hello","protocolVersion":1,"flea":"0.4.0","language":"en","decimal":".","settings":{},"kinds":["send-target"]}
{"op":"ready","protocolVersion":1}flea is the package version; language and decimal describe Flea's locale. settings contains values clamped to
the manifest's schema, and kinds contains its declared kinds. The startup deadline is five seconds. A ready
response may omit protocolVersion; if present, it must be the number 1.
A lasting session handles one call at a time. A concurrent ordinary request is refused with busy rather than
queued. If the host's ready check collides with an active call, its refusal instead uses start.
Previewer-only plugins do not accept runtime settings calls; their fresh startup hello supplies settings.
Ordinary lasting-session requests have a 30-second deadline. The subprocess is stopped after 30 seconds idle; a
later request starts a new subprocess. Previewers instead run once per request in the thumbnail sandbox, with a
10-second response deadline after readiness.
Subprocess messages are limited to 65,536 bytes, result arrays to 256 rows, and progress to 128 messages and
1,048,576 aggregate bytes per request. These are subprocess message limits, not the size of a terminal backend
envelope that also contains retained progress. Required row strings and op, error message, progress message
and preview png strings are at most 4,096 bytes and contain no NUL. Row identities (id, or name for entries)
must be nonempty and unique within an answer. Entry names additionally cannot be ., .. or contain /.
Preview text is bounded by the message size rather than the 4,096-byte string limit.
{"c":"quit"}
Stops the read loop, then answers the thumbnail work already asked for: every queued and
running job is drained and reported before the process exits, because a worker inside a
child owns a temp file in the shared cache that only its own return publishes or removes.
Draining is bounded; see thumbed below. Apart from those thumbed lines, no response.
Once it is done the backend points its stdin and stdout at /dev/null and then exits, so a client
reads the end of output even while the kernel still holds a thread of it in a dead mount's call.
A queued dirsize row is not drained. It answers nothing that outlives this process, unlike
a thumbnail's shared on-disk cache, so a row still waiting when quit arrives is simply dropped;
the client that asked for it is going away too. A collisions question still being asked is dropped the
same way, which is why a scripted client waits for its line before sending quit.
{"t":"gitstatus","id":1,"path":"/repo","ok":true,"enabled":true,"root":"/repo","branch":"main","label":"main · 8 changed","changed":8}
t names the request, id and path echo its correlation, and ok reports success. root
is the canonical worktree root, branch its branch name (detached for detached HEAD),
changed the unique changed-path count after coalescing, and label the exact branch-caption text derived
from that count. An unborn branch keeps its real name; a clean repository says main · 0 changed.
The normal window's branch caption is muted; in Changes it is foreground. The illustrated
main · 8 changed count is data, independent of the ordinary listing's item count.
Disabled replies have enabled:false, empty root, branch and label, and changed:0.
An enabled directory outside a repository has the same empty values with enabled:true.
Clients hide Git decoration in both cases. A failed status clears stale decoration while
ordinary file browsing remains usable. A failed load retries on the next enabled status request;
the existing mount quarantine refuses filesystem work until its stuck TTL expires.
{"t":"gitrows","id":2,"path":"/repo","ok":true,"marks":[{"path":"/repo/Code","status":"","folder":true},{"path":"/repo/notes.txt","status":"M","folder":false}]}
marks contains each asked absolute path, its status, and whether it is a folder with
changes inside. A clean row has status:"",folder:false. Non-empty statuses are exactly
M modified, A added, D deleted and ? untracked. A deleted flag in an ordinary or
rename/copy record takes precedence, so an RD destination uses D; other rename/copy
destinations use A, and other tracked changes use M.
An unmerged record uses its worktree mode: a present conflicted path uses M, including UD and
DU modify/delete conflicts, while a zero worktree mode uses D. No per-file stat is needed.
A coalesced index-deletion/untracked pair instead emits one ?, as described under gitstatus.
A folder square takes precedence over a simultaneous
letter for a submodule or embedded repository. The window square is 6 px, yellow and centred
in the 14 px mark column. Resting letters use yellow, green, error and muted roles respectively,
each at least 4.5:1; cursor-row text uses foreground. folder supplies the same yellow ■
to the TUI's one-cell column. No marks outside the viewport are requested or painted.
{"t":"gitchanges","id":3,"path":"/repo","ok":true,"root":"/repo","label":"main · 8 changed","total":8,"start":0,"entries":[{"path":"Code/lib.rs","status":"D","original":"","deleted":true}]}
root and label identify the same cached snapshot as gitstatus; total is its complete
unique changed-path count after coalescing, start the clamped page offset, and entries the requested page in
repository-relative path order. Each entry supplies path, status, original and deleted.
status has the same four-letter alphabet as gitrows. original is the source path for
a rename or copy and otherwise empty; it is metadata, not another counted entry. deleted
is true for a D row even when that path no longer exists. These replies contain no size or
date; clients resolve metadata off-thread for existing visible paths and skip it for deleted rows.
The Changes footer counts total, for example 8 items, separately from ordinary listing rows.
All three Git requests fail with their own t, echoed id and path, ok:false and an
error sentence, for example {"t":"gitstatus","id":1,"path":"/repo","ok":false,"error":"Git status timed out."}.
Errors include unavailable snapshots or sandbox, invalid paths or visible-row requests,
cancellation, timeout, over-limit output, malformed porcelain and underlying I/O or Git diagnostics.
These are requested replies; changed remains the only unsolicited notification.
{"t":"listed","n":<uint>,"read":<float>,"sort":<float>,"v":<uint>,"w":<bool>,"path":<string>}
Example: {"t":"listed","n":100000,"read":26.400,"sort":2.500,"v":56,"w":true,"path":"/home/gm"}
n is the row count. read and sort are milliseconds, formatted to three decimal
places ({:.3}). Sent after a successful list and after a successful sort. read is
the scan plus any requested metadata pass after list, the metadata pass after a
sort by size or mtime (including its date alias), and 0.0 after a sort by
name or kind, which needs no metadata pass.
v is the listing directory's own filesystem id, sent once here rather than on every row because
every file in the directory shares it. A client compares it against the v of the directory row
being dropped on: equal is one volume and the drag moves, different is two and it copies. v is 0
when the directory could not be stat'd, and a client reads 0 as unknown and copies, because copying
where a move was meant is an annoyance and moving where a copy was meant loses the original.
w is whether this user can create or delete entries in that directory. A drag from a directory
with w false copies, because a move would have to delete the originals and cannot. A reply that
omits w is an older backend, and a client reads that the same as true.
path is the directory exactly as the list that made this listing spelled it, byte for byte, with a
trailing slash, a symlink or a .. left unresolved, because a client drops any listed line whose
path differs from the one it asked for (ui/js/Swap.js onListed).
changed rides only on a list with wantChanged that re-read the directory
already listed, and on a listpaths that re-read the listing it already held, and names
added plus removed rows between the two scans, so a rename counts 2 against a net delta of 0.
A first listing and a navigation carry no changed, and a client reads a missing one as unknown rather than 0.
Local lstat rows include optional source as device:inode:file-type for inline rename. These are
decimal integers in a string, preserving full inode precision. Cached GIO rows omit it and use an
on-demand selection snapshot instead. The field does not require an additional stat.
Each viewport row also carries b, an optional creation timestamp as Unix seconds
or null. The source is Linux statx(STATX_BTIME), with no-follow and no-automount
flags and the returned mask checked. Missing support stays null. It is read only
in the existing bounded viewport metadata worker, except an explicit creation-time
sort. Serialization performs no extra filesystem read. Cached GIO rows without
a creation-time fact report null. TUI Creation
detail displays a localized date or the localized unavailable value. Properties'
single-item menuaction payload carries the same optional value as birth.
{"t":"rows","start":<uint>,"rows":[{"n":<string>,"d":<bool>,"s":<uint>,"m":<int>,"p":<uint>,"i":<string>,"t":<bool>,"k":<uint>[,"l":<string>][,"v":<uint>][,"tg":[<string>,...]][,"a":true][,"x":false]},...],"kinds":[<string>,...],"ms":<float>,"listing":<uint>}
Example:
{"t":"rows","start":0,"rows":[{"n":"say \"hi\".txt","d":false,"s":12,"m":1787790423,"p":33188,"i":"text-x-generic","t":false,"k":0},{"n":"photos","d":true,"s":4096,"m":1787790424,"p":16877,"i":"folder","t":false,"k":1,"v":56}],"kinds":["Plain text document","Folder"],"ms":1.250,"listing":1}
start echoes the requested start, clamped to the listing's length: a window
whose start lands past the end of the listing answers with start equal to the
listing's length and an empty rows array, not the value that was requested.
Each row object holds a name (n, JSON-escaped; a valid UTF-8 name may carry any
character including a quote or a newline, and a name that is not UTF-8 arrives as its lossy
spelling, a NUL and its raw bytes in lowercase hex, which every path field accepts back and
a client draws each such component without its NUL and hex tail, see docs/architecture/exact-names.md), a
directory flag (d, the link's own type rather than its target's: a symlink to a
directory reports d:false and carries S_IFLNK in p), a size in bytes (s), an
mtime as a unix timestamp (m), a raw st_mode (p), a freedesktop icon name
(i), a thumbnailable flag (t), and a Kind index (k, into the envelope's own
kinds array).
x:false means the reported execute bits do not establish per-file executable status. Only those
rows carry it; ordinary rows gain no wire bytes. The icon and executable name colour use
the same backend decision, while p stays the reported mode for permission display and
operations. A symlink's name still uses symlink colour, and a lifted name uses foreground.
l is where a symlink points, and only a symlink row carries it. It is the link's own bytes,
verbatim and unresolved, so a relative target stays relative and a broken link still names where it
points; a readlink that fails leaves the field off entirely, the same as any other row. The row it
sits on is the one that already pays a second stat for its icon, so the extra call lands on the rows
that were already the exception and on no others, and the scale fixture holds no links at all. A row
never carries both l and v: d is the link's own type, so a symlink's d is false and it is
never the directory row v is for. The client draws the target beside the name and the word link
in the size column, because a link's own st_size is the length of that target path and not a size
anyone means.
tg names the file tags Dolphin reads, and only a tagged row carries it. It is the
user.xdg.tags value filtered to names Flea knows, in the stored order and canonical case, so a
row draws its swatches with no call per row; an untagged row carries no tg at all, and a
foreign word stays untouched and shows in Properties instead. One getxattr per emitted row
reads it, which is exactly the rows a window stats and never a sweep; on a network or phone
mount no row carries it, because each read there would be a round trip.
a marks a thumbnailable AppImage, and only that row carries it. Its own icon is its identity, so
the Images thumbnail mode draws it while a row with any other executable icon, such as a Windows
installer a third-party thumbnailer handles, stays a mark; every other row carries no a at all.
v is the row's filesystem id, and only a directory row carries it. A drop destination is
always a directory, so a file row's device would never be read, and the scale fixture is 100,000
files with no directories at all: sending it per row would be paid 100,000 times on the one path
that produces the headline listing number, for a field nothing reads. A client compares the v of
the rows being dragged against the v of the directory being dropped on: equal means one volume and
the drag moves, different means two and it copies, which is what Finder does. A directory whose stat
failed reports p 0 and v 0 with it. ms is the phase-2 stat time for this window, formatted to three
decimal places. Sent after list and after window. The last field is listing, the numbering these
rows are in; see "listing".
A row whose stat failed sends s, m and p all 0, and p is what says so: 0 is outside
st_mode's domain, because a real one always carries its file-type bits. So p 0 needs no flag
beside it the way lines 0 needs lfailed, and it condemns that row's s and m with it: those
two are only readable when p is non-zero.
kinds is a dictionary, not a string per row, because an earlier plan measured the
per-row-string shape and it cost milliseconds. A directory has few distinct Kind
strings even at 100,000 files (a handful of file types, plus "Folder"), so every row
paying one integer instead of a repeated string keeps the response small without a
second round trip. A directory's Kind is always the literal "Folder"; a file's Kind
is src/backend/kind.rs's freedesktop <comment> for its resolved MIME type,
canonicalised through /usr/share/mime/aliases the same way the thumbnailer spec
lookup already is, falling back to the literal "Data" both for a type with no comment
at all (application/x-ms-dos-executable is the one shipped example) and for a name no
glob matched. An icon name is an internal string and this column is a human
description, so one never leaks into the other, and a name nothing identified must not
claim to be text however far the icon ladder itself falls. Like the icon and
MIME tables, the comment file is read once per distinct type for the life of the
backend process, never per row. The selected description is cached per type and
refreshed when Omarchy's language changes: the client is given a human description and never the
MIME type, because a display should not classify.
English uses the first <comment> carrying no xml:lang attribute, preserving its
bytes. Other languages select an exact language and region, then the base language,
then that untranslated comment. Underscores and hyphens name the same locale;
the roster's Chinese regions and Cyrillic Serbian also match their explicit XML
script tags. Translated XML entities are decoded before display. 8 of the first 200
/usr/share/mime/*.xml files on this box open with a translated comment before their
untranslated one; application/msword.xml is one of them, opening xml:lang="zh-Hant-TW"
with its untranslated comment further down the file, after every alias and glob line. A type
whose file carries no matching translated or untranslated comment,
answers None, which is why Kinds::comment returns Option<String> rather than an empty
string.
An explicit mime.markdown catalog value overrides the localized Markdown comment
outside English. Only Japanese supplies one: Markdown 文書, as HIG
CHANGES.md:2800 requires, correcting the installed incomplete Markdown comment.
Every other locale continues through the MIME selection and fallback above.
No wording in that file is a property of the format, and nothing may assert one. Every
/usr/share/mime/<type>.xml is generated by update-mime-database from the files in
/usr/share/mime/packages/, and no package owns the generated file, so the untranslated
string is whatever the applications installed on the box supply. application/msword reads
Word document from shared-mime-info's own freedesktop.org.xml and Microsoft Word Document from libreoffice-fresh's libreoffice.xml, which outranks it; a box with
LibreOffice and a box without therefore disagree on the same distribution and the same
shared-mime-info version. Issue 1 was a test asserting the second string. The parser is
tested against a fixture and the live database is asserted only for shape: reachable, ASCII,
and free of markup.
Note that t inside a row object is a boolean, while the t at the top of every
response line is the message type, a string. They never collide: one is a member of a
row, the other a member of the envelope.
i is never empty. The backend resolves the row's name to a MIME type against
/usr/share/mime/globs2, then that type to an icon name against
/usr/share/mime/generic-icons, falling back to the media class (image-x-generic
and friends) and finally to text-x-generic; a directory is always folder. Both
tables are read once per backend process, never per row. The client is given the icon
name and never the MIME type, because a display should not classify.
Two rules sit above that resolution and neither follows from the name alone. The icon of a
symlink follows the link's target while d still describes the link: a symlink to a
directory reports d:false, because d is what the client navigates on, and i is folder,
because that is what the row looks like. Only symlink rows pay for it, through one extra stat
inside the window the client asked for. An application/* type with no generic-icons entry
resolves by the row's own execute bit, not by its class: 190 of the 613 such types in
globs2 have no entry on this box, so the execute bits in p decide between
application-x-executable and application-x-generic. Both counts move with the installed
applications, the same merge described above: a root built from freedesktop.org.xml alone
gives 138 of 552. Without that rule every one of the 190 drew as a program, which is
how a .pem came to look executable.
t is true only when a validated thumbnailer declares the row's MIME type or an alias
of it. The backend resolves the row's name to a MIME type the same way it resolves the
icon, then looks that type up in the thumbnailer specs read from the freedesktop search
path, whose declarations and queries are both canonicalised through
/usr/share/mime/aliases, so either side of an alias pair matches. A spec whose
program is not a runnable executable is dropped when the table is built, so t is
false for a declared type with no working thumbnailer. t also reads the file type out of the
row's own p: a directory, a fifo, a socket and a device node are always false however they are
named, and a row that vanished between the listing and the stat reports p of 0 and is false
too. A symlink is true when its name resolves to a declared type, because the thumbnail request
stats the target; a symlink to a special file is then refused when the row is actually asked
for. Like
the icon tables, the alias and spec tables are read once per backend process, never per
row; the whole per-row cost of t is one hash lookup, tens of nanoseconds per row, so
it is invisible at a viewport of a few hundred rows. The client is still never given the
MIME type itself: t exists so a display does not have to reason about content types to
know whether asking for a thumbnail is worthwhile.
{"t":"searching","n":<uint>,"scanned":<uint>,"ms":<float>}
Example: {"t":"searching","n":812,"scanned":41200,"ms":300.114}
The streaming progress of a search, at most one every 100 ms while the walk runs. n is
the match count so far and is what the client sets its row total to; scanned is directory
entries looked at, which is the number the status bar counts up. It is deliberately not a
listed line: a mid-walk update is not a fresh listing and carries no read or sort
timing to report.
Matches are only ever appended, so a window the client already holds stays valid across
every one of these.
{"t":"searched","n":<uint>,"scanned":<uint>,"ms":<float>,"cancelled":<bool>}
Example: {"t":"searched","n":6252,"scanned":45807,"ms":48.711,"cancelled":true}
The terminal line of a search. n is the final match count and is authoritative: no
listed follows it. scanned is how many directory entries the walk looked at, which is
what the status bar counts up while it runs. ms is the whole walk, to three decimal
places. cancelled is true when a searchcancel, a list or a sort ended the walk early,
and false when it ran the subtree out. The rows are in rank order by the time this line is
written, so a client holding a window from before it has stale indices and re-reads.
{"t":"thumbed","row":<uint>,"file":"<string>","ms":<float>}
Example: {"t":"thumbed","row":2,"file":"/home/gm/.cache/thumbnails/large/b98fa4082faa4a9cbb9728c94831a4b5.png","ms":75.823}
Answers one row of one thumb request. row is the index that was asked for. file is
the absolute path of the PNG in the shared thumbnail cache, JSON-escaped like every other
string on this wire, and ms is milliseconds to three decimal places: the whole job for a
generated row, or just the lookup for a row answered from the cache, which is tens of
microseconds here against tens of milliseconds and up for a decode.
file is empty rather than absent on failure, so a client never waits forever for a
row that will not arrive. Every reason a row cannot be thumbnailed reads the same on the
wire: a directory, a file that is not a regular file, no thumbnailer for the type, a recorded
failure, a thumbnailer that failed, hung, or exited successfully having written nothing, or a
shutdown that cut the job short. A client that asked for a row
therefore gets exactly one thumbed line for it, unless it cancelled the row itself or
replaced the listing under it.
A result for a superseded listing is dropped, never reported against the current one.
The backend maps only the rows a client actually asked for back to their paths, and a
list or a sort clears that map and cancels the queue, because both change which row an
index names. A job already inside a worker still runs to its own end, and its result is
discarded on arrival rather than printed against a row it no longer describes.
Shutdown is bounded at 25 seconds in total, which is longer than the pool's own 20-second
job deadline, so no single running job can be cut short by it. If the budget does run out,
every row still unanswered is answered with an empty file before the process exits.
{"t":"dirsized","row":<uint>,"bytes":<uint>,"partial":<bool>,"ms":<float>,"listing":<uint>}
Example: {"t":"dirsized","row":4,"bytes":1048576,"partial":false,"ms":12.500,"listing":7}
Answers one row of one dirsize request. row is the index that was asked for, bytes is the
recursive apparent size (every entry's own st_size, symlinks not followed and counted at their
own small size rather than their target's), and ms is the walk's own wall-clock time. The
target's own directory entry counts too, matching what du -s reports for the directory itself.
partial is true when the 2000 ms deadline cut the walk short, or a subtree inside it
answered permission denied. Either way bytes is a floor, honestly labelled, never a wrong
exact number: everything the walk actually saw before it had to stop is still counted. The
shipped client renders a partial answer with a leading >.
A result for a superseded listing is dropped, never reported against the current one. A
list or a sort clears the answered-row cache and cancels the queue, the same rule and the
same reason thumbed follows: both change which row an index names.
The listing stamp also lets the client reject a reply that was buffered before its listing
changed. Older clients may ignore this additional field.
{"t":"settagged","ok":<uint>,"op":"<string>"[, "skipped":["<name>",...]]}
Example: {"t":"settagged","ok":2,"op":"remove"}
Answers one settags request. ok is the number of files whose attribute changed; a request
that changed nothing answers 0 and records nothing to undo. op is what was applied, add,
remove or clear, so a toggle answers the direction it resolved to, and the client words its
status line from it. skipped is present only when a row was skipped, naming the rows that were neither a file nor a folder, so the client words that line instead. A refusal answers an error
line with where of settags instead, and nothing was written.
{"t":"tagstates","id":<uint>,"applied":["<name>",...],"mixed":["<name>",...],"listing":<uint>}
Example: {"t":"tagstates","id":3,"applied":["Red"],"mixed":["Blue"],"listing":7}
The answer to one tagstates request, carrying its id back. applied names, in menu order, the
tags every row carries and mixed the tags only some rows carry; a tag no row carries is in neither.
A name Flea does not know is never listed. listing is the numbering the rows resolved in, so a
client drops an answer whose numbering is not the one it asked in.
{"t":"transferstarted","id":<uint>,"n":<uint>,"moving":<bool>}
Example: {"t":"transferstarted","id":12,"n":2,"moving":true}
id names this operation for the life of the process and is what transfercancel takes. n is the
count of top-level paths, never a recursive file count: computing that before answering would be a
metadata sweep over an unbounded subtree, which is the shape this codebase refuses everywhere else, and
a transfer's first line is on the critical path of every operation.
moving is the verb the request actually resolved to, after the rule that anything which is not
exactly "move" copies. It is on the wire because the client cannot derive it: a paste spends a cut
clipboard before this line arrives, and a move to Dropbox never touches the clipboard at all, so a
client reading its own clipboard reports a move as a copy.
{"t":"extractstarted","id":<uint>}
An archive extract sends this line before its one zero-byte transferprogress line. A current client
routes it into the existing transfer card as n 1, moving false and extract true, so the card says
Extracting without inventing bytes, a rate or an ETA. Older clients ignore this new type, while the
existing archivedone terminal line remains unchanged for archive clients.
{"t":"meta","row":<uint>,"w":<uint>,"h":<uint>,"orient":<uint>,"ms":<uint>,"rate":<uint>,"entries":<uint>,"unpacked":<uint>,"afailed":<bool>,"names":[{"n":"<string>","d":<bool>},...],"lines":<uint>,"partial":<bool>,"lfailed":<bool>,"frames":<uint>,"photo":<object|null>,"target":"<string>","targetdir":<bool>,"raw":{"file":"<string>","w":<uint>,"h":<uint>,"orient":<uint>}|null,"owner":"<string>"}
Example: {"t":"meta","row":4,"w":0,"h":0,"orient":1,"ms":0,"rate":0,"entries":214,"unpacked":3400,"afailed":false,"names":[{"n":"ui","d":true}],"lines":0,"partial":false,"lfailed":false,"frames":0,"photo":null,"target":"","targetdir":false,"raw":null,"owner":"gm"}
Every field a row did not ask for is zero, false or empty. w and h are pixels, read from the
file's own header, as stored and before any turn. ms and rate come from the probe. lines is a
newline count with partial true when it stopped at its 1 MiB budget, so the column states it as a floor.
photo is the camera file's EXIF facts as stored, from the same RAW walk and in the same reply: {"make":"Canon","model":"Canon EOS R6","lens":"RF35mm F1.8 MACRO IS STM","exp":[1,250],"fnum":[28,10],"iso":400,"focal":[35,1],"taken":"2026:09:12 18:31:00","w":6000,"h":4000}, where exp, fnum and focal are numerator and denominator pairs, w and h are the sensor size from the EXIF pixel dimensions (sent together or not at all) and an absent fact is left out. It is null for every row that is not a RAW and for a RAW whose walk names none of them; a JPEG's facts are never in this reply. The properties reply of menuaction carries the same photo object, and for a .jpg or .jpeg it is read from the first Exif APP1 within the file's first 64 KiB.
orient is the EXIF orientation, 1 to 8, from the same read of the same open. The walk that finds a
JPEG's frame header reads the head of its first Exif APP1 on the way past. It is 1 for every file that
names none, every non-JPEG included. Orientations 5 to 8 swap the sides, and the Columns frame and Quick
Look ask Qt for their decode size turned the same way, because Qt fits its decode before it turns.
entries and unpacked are exact totals whenever they are non-zero, because the index is
streamed and counting all of it costs no memory. names is capped at the first ARCHIVE_NAME_CAP
entries, which is the only part that is bounded: the tile lists those and states the difference as
its own "+ N more" line.
lfailed is true when the row produced no count at all, which on this box
means permission denied, a row that is not a regular file, or a row that vanished between the
listing and the request. Nothing but a regular file is ever read here or for w and h: a
stat refuses every other kind before any open, so a FIFO that stat sees is never opened at all
and its waiting writer is left where it was, and the open behind that stat is O_NONBLOCK with a
second fstat on the descriptor, so a row swapped for a FIFO inside that window is closed again
instead of leaving the row waiting forever. That one open does wake a writer parked in open(2), and
closing it unread hands that writer an EPIPE on its next write if nothing else is reading: it is
the cost of refusing a swap the stat cannot see, not a case the stat avoids. A FIFO, a socket, a
device or a directory answers its stat facts with no dimensions and no count. It is what tells
lines 0 apart from an empty file, whose lines is also 0: zero is a real count, so
unlike mode on an error line it cannot carry the failure itself. A row that never asked for a
count sends lines 0 and lfailed false, the same as a row whose count really is zero, because
nothing was attempted; the client knows which kind it asked about.
afailed is true when the listing was not completed, which covers a tool that could not read the
archive and a read that outran its wall-clock budget. A failed read sends entries 0, unpacked 0
and an empty names, so a partial count never reaches a client that has been told the number is a
total. That is a different answer from an archive holding nothing, which sends the same zeroes with
afailed false, and the two are drawn as the error state and the empty state respectively.
target is a symlink's own target and targetdir says whether that target is a directory, so the
column's mark can follow the target the way a listing row's does.
raw is an object for a camera RAW whose largest embedded JPEG preview was copied out, and null for every
other file and for a RAW holding none. file is the copy under $XDG_CACHE_HOME/flea/raw/, named by the md5
of the RAW's file URI and carrying the RAW's mtime, so a changed RAW is copied again and an unchanged one is
neither walked nor written twice.
The directory is held to 4096 copies and 512 MiB, least recently used first (by ctime, since a copy's mtime is its RAW's:
a cache hit sets the copy's atime to now, which moves the ctime), and sweeps temps a minute old. A copy made or served less
than a minute ago is never evicted, because the thread that has it is still reading it. Each process scans on its own first
new copy and then on one in 32 of its own, and the directory is shared, so it can stand over its caps: by the copies of the
last minute, which stay until the first scan after they age, and by fewer than 32 more per process. w, h and orient read like
the top-level fields, taken from the copy: stored
pixels and the EXIF turn, which the copy carries even when the camera put it only in the RAW's IFD0. The top-level
w and h stay 0 for a RAW, because they name the file's own pixels and the preview is smaller.
owner is the login name of the user who owns the path itself (a symlink reports the link's owner, as
its row does), resolved from /etc/passwd alone and never through getpwuid: that call goes through
NSS and can wait on a network directory, and the meta thread must never hang the column on one. A uid
no local account carries answers the empty string, never the number dressed as a name.
{"t":"owner","row":<uint>,"token":<uint>,"owner":"<string>","retry":<bool>}
Example: {"t":"owner","row":7,"token":91,"owner":"gm","retry":false}
The answer to one {"c":"owner","row":<uint>,"token":<uint>} request, which the TUI's Owner detail
column sends for one drawn row at a time, echoing its row and token. owner reads as meta.owner
does, the login name from /etc/passwd, and is empty for a uid no local account carries, a path that
cannot be stat'ed or a row past the listing. retry is true only when the stat could not run, because
its remote mount already holds an owner stat, eight remote owner stats are held across all mounts, the
mount is marked stuck, or the stat missed its five-second deadline. owner is empty then too, so a
reader that ignores retry reads the line it always did, and an absent retry reads as false. The
TUI keeps every retry:false answer, empty ones included, until its rows change, and asks a
retry:true row again only while the Owner column still draws it, at most once a second.
{"t":"shebang","path":"<string>","hasShebang":<bool>,"id":<uint>}
Example: {"t":"shebang","path":"/home/gm/run.sh","hasShebang":true,"id":3}
The answer to one shebang request, carrying its id back. hasShebang is true only when the
path opened as a regular file and its first two bytes were #!; anything else, a directory, a
FIFO, a missing path or an unreadable file, answers false. The open is the backend's own
regular-file open, so a FIFO is refused before any open and a row swapped for one inside that
window is closed again, the same rule meta follows.
{"t":"code","token":<uint>,"slot":"<string>","state":"<string>","first":<uint>,"total":<uint>,"lines":[[<role>,"<string>",...],...][,"records":<uint>,"firstRecord":<uint>]}
Example: {"t":"code","token":4,"slot":"look","state":"styled","first":1,"total":2,"lines":[[5,"fn",0," main"],[]]}
The answer to one code request, echoing its token and slot. first is the actual first
line returned: normally the asked line, or the record start for a raw csv table request.
state is styled
(bat coloured the lines), plain (the lines are the file's own text, every role 0: a line over
5,000 bytes, or no bat on the host), binary (a NUL in the first 1,024 bytes), large (over
1,048,576 bytes) or failed (unreadable, or bat refused it); the last three carry no lines.
total is the line count of the whole text. Each entry of lines is one line as a flat run list,
a role from 0 to 6 then the run's text, in order, an empty line being an empty list; the lines
returned are those asked for that exist, extended to whole records for a raw csv table
request. total remains the physical-line count in either case. A plain raw csv reply
also carries records, the whole file's record count including its header, and firstRecord,
the ordinal of the first returned record. An unterminated quote at EOF still counts as one
record. An empty file has zero records; an empty reply beyond EOF has the requested record
ordinal, or the next ordinal after the file for a physical-line ask. Every other reader's
reply omits these two fields. The roles are the foreground (0) and bat's ANSI colours
31 to 36 in order: red, green, yellow, blue, magenta, cyan. A one-line .json file is formatted
with jq first, so its total and lines are those of the formatted text.
{"t":"html","token":<uint>,"slot":"<string>","state":"<string>","file":"<PNG path>","total":<uint>,"width":<uint>,"title":"<string>"}
Example: {"t":"html","token":3,"slot":"look","state":"ready","file":"/cache/thumbnails/flea-html/a.png","total":61,"width":984,"title":"Local page"}.
The answer to the latest request in one HTML slot. State is ready, failed, or cancelled;
only ready names a PNG and a whole-file line count. Failure uses the existing unreadable-file
frame. Width is the render width, not a CSS zoom. Title is the helper's observed static page
title on a new render and empty on a cache hit. The client matches token and slot, and drops
replies after closing or switching to Source.
{"t":"compare","token":<uint>,"state":"<string>","patch":"<string>"}
Example: {"t":"compare","token":3,"state":"diff","patch":"--- /a\n+++ /b\n@@ -1 +1 @@\n-x\n+y\n"}
The answer to one compare request, echoing its token. state is diff (diff exited 1 and patch
holds what it printed, headers included), identical (it exited 0), binary (screening found a NUL in
a file's first 8,192 bytes), over (either file is over 1,048,576 bytes) or failed (a path
that cannot be read as a regular file, invalid UTF-8 in a file or the patch, any other exit, diff or
the jail not starting, or a patch past 8 MiB). patch is the empty string in every state but diff.
Screening first requires both absolute paths to open as regular files with readable lengths;
either initial length over 1,048,576 bytes returns over. It then reads a, followed by b, up to
1,048,577 bytes each, checking read failure (failed), growth past the limit (over), a NUL in the
first 8,192 bytes (binary), then UTF-8 validity (failed), stopping at the first refusal. An earlier
file's failed or over therefore takes precedence over a later file's NUL.
{"t":"collisions","id":<uint>,"total":<uint>,"names":[{"n":"<string>","d":<bool>,"i":"<string>"},...],"mergeable":<bool>}
Example: {"t":"collisions","id":7,"total":2,"names":[{"n":"screenshot.png","d":false,"i":"image-x-generic"},{"n":"notes","d":true,"i":"folder"}],"mergeable":true}
total counts every colliding source. names is the first three of them in request order, which is
all a client's card lists before its "and N more" line, so the answer stays small however wide the
selection. n is the incoming item's name, d whether it is a directory and i the same icon name a
rows row carries, for the card's kind mark. n is the name as a person reads it; a name that is not UTF-8
also carries x, its exact text (docs/architecture/exact-names.md), which a client matches against a rows
name and joins into a locate path, so the question never lands on that name's lossy twin. mergeable is true when a folder lands on a folder,
which is the only shape the card offers merge for. A total of 0 means nothing collides; the shipped client
then sends its transfer with collide refuse, so a name that appears in the meantime is still refused.
{"t":"fatnames","id":<uint>,"fstype":"<string>","volume":"<string>","renames":[{"old":"<string>","new":"<string>","d":<bool>,"i":"<string>"},...]}
Example: {"t":"fatnames","id":7,"fstype":"exfat","volume":"128GB","renames":[{"old":"clip: final.mp4","new":"clip_ final.mp4","d":false,"i":"video-x-generic"}]}
Answers a collisions question that carried no fat for a FAT-family destination, with the same
id, in place of the collisions line. fstype is the mount table's own word and volume the
owning mount's folder name, so the card names the drive from fields and never from a sentence.
renames lists every source whose name the filesystem refuses, in request order, old as it is and
new as Rename and copy would land it; d and i are the rows row's directory bit and icon name.
{"t":"mergecollisions","id":<uint>,"total":<uint>,"names":[{"n":"<string>","d":<bool>,"i":"<string>"},...]}
Example: {"t":"mergecollisions","id":8,"total":3,"names":[{"n":"IMG_4120.HEIC","d":false,"i":"image-x-generic"}]}
total counts every file-level name both sides hold; folders that merge further down are not
listed because they need no answer. names is the first three in walk order with the same n,
d and i the card draws, n relative to the merging folder when one folder merges and to the
destination when several do. A total of 0 sends no second card: the transfer goes out at once
with inner refuse.
{"t":"clip","op":"set","ok":<bool>,"token":<string>}
{"t":"clip","op":"get","ok":<bool>,"clip":"copy"|"cut"|"image"|"none","paths":[<string>,...],"token":<string>,"skipped":<uint>}
{"t":"clip","op":"clear","ok":<bool>,"cleared":<bool>}
{"t":"clip","op":"changed","clip":"copy"|"cut"|"image"|"none","paths":[<string>,...],"token":<string>,"skipped":<uint>}
One shape for all three clipboard requests, read by clipResult. A refusal carries
ok:false and an error sentence instead of the success fields. A get with no
files on the clipboard answers clip:image if PNG is offered, otherwise clip:none,
with empty paths and token in either case. Only file selections enable Paste As;
image enables ordinary Paste, which requests the PNG bytes through pasteimage.
skipped
counts the offered URIs that were refused (bad escapes, NUL, relative paths, . or
.. parts, non-UTF-8, duplicates, other schemes) rather than failing the read. The
token on a get names Flea's own copy when the selection carries it, which is what
a later clipClear hands back; a foreign selection answers an empty one. changed
is the watcher's line and carries no ok: it reports the selection as files, with the
same fields as get, and a failed watch reports none with an error sentence.
A selection event supersedes any exit read begun before it, while an exit read begun after that event invalidates its pending watcher bytes only if it reports, with both guards ordered by sequences under the emitter lock.
{"t":"transferprogress","id":<uint>,"index":<uint>,"name":"<string>","bytes":<uint>,"total":<uint>[,"phase":"writing"]}
Example: {"t":"transferprogress","id":12,"index":0,"name":"a.txt","bytes":40000000,"total":120000000}
Throttled to one window per 150 ms for the whole operation, not per item: the first sample goes out
at once and a run of small files shares one window, and a window sends the item's own line with at most
one owed line beside it (below), so a fast copy of a thousand small files sends a few
lines (plus one transferitem per item, below), and a single large file sends one per window as it
always did. A thousand small files once sent a progress line and an item line each, so the card model
was written 2002 times; the throttle cuts the progress lines from 1000 to 2 and the writes to 1004. An item
that sends no line of its own is correct and not a missing message.
Bytes ride on the next line, never get lost. A client counts an item's bytes from the last sample it
saw for that item (ui/js/Transfer.js itemDone), so the bytes of items that sent no line go out once, ahead
of the next item's first line: a sample with total 0 under the index and name of the last item to end,
which the client has already closed, so it joins the running sum and moves nothing on the card. The next item
then sends its own bytes and total, so a large file keeps its size on every line. A closing sample of the
same shape follows the last item when anything is still unreported, ahead of the drive flush below. What the
card draws is then the figure an unthrottled run draws, to the byte, whatever the
throttle skipped; an item that ends short (a failure or a cancel) counts as the total its last line
named, as it always did. Only a copy or a same-device move sent by the transfer loop paces this way; a
cross-device move batch and a folder merge keep their own per-item windows.
Only a regular file reports bytes. A directory has no total without the sweep this codebase does not
do, and a same-filesystem move is a single rename(2) with nothing to report partway through, so
neither emits these lines at all. A client renders an item with no progress as indeterminate.
On a durable target (usb, phone, network, or vfat/exfat/ntfs) those bytes are reported only after
the drive confirms them, so the rate is the drive's real rate.
The final phase rides one more of these lines. After the last file, the transfer emits
{"t":"transferprogress","id":<uint>,"index":0,"name":"","bytes":0,"total":0,"scanned":0,"phase":"writing","drive":"<string>"}
while it fsyncs every directory it created or wrote into. Cancel is not honoured there because
every file is already complete. drive is the destination's own name, so the card's headline
names where the flush is going without guessing from timing. Older clients ignore the fields
they never asked for.
An extract's one progress line is not a transfer's. It carries the archive's own file name as
name with bytes and total both 0: the unpacking tool streams no per-item bytes, so any figure for
it would be invented and no percentage or time left is offered for it.
{"t":"transferitem","id":<uint>,"index":<uint>,"name":"<string>","ok":<bool>,"err":"<string>"}
Example: {"t":"transferitem","id":12,"index":0,"name":"a.txt","ok":true}
Example: {"t":"transferitem","id":12,"index":1,"name":"photos","ok":false,"err":"permission denied"}
Exactly one per top-level item the transfer starts, in the order the items were named; an item it
never starts, one a cancel reached first, one a skip left or a move already in place, answers none. err rides only on a failure, so
a successful item's line carries no empty field to reason about, and a permission error on one file is
that item's data rather than the operation's: the batch carries on to the next item. What a failed item
had already written stays where it is and is journaled as that operation's own creation, so an undo
removes it; only a cancel removes its partial itself, see transfercancel.
{"t":"transferdone","id":<uint>,"ok":<uint>,"failed":<uint>,"skipped":<uint>,"cancelled":<bool>,"retryPaths":[<string>,...],"durable":<bool>,"note":"<string>"[,"merged":<uint>,"keptBoth":<uint>,"into":"<string>"][,"refused":[{"name":"<string>","err":"<string>"}]]}
Example: {"t":"transferdone","id":12,"ok":1,"failed":1,"skipped":0,"cancelled":false,"retryPaths":[],"durable":false,"note":""}
Example: {"t":"transferdone","id":13,"ok":0,"failed":1,"skipped":0,"cancelled":false,"retryPaths":["/home/a/thesis"],"durable":true,"note":"","refused":[{"name":"thesis/refs/paper.pdf","err":"this drive cannot hold links"}]}
The whole operation's terminal line. skipped counts the items the transfer did not start by design:
those a cancel reached before they started, the colliding items a collide of skip left in place,
and an item a collide move would have put back where it already is. A cancelled replace whose
put-back failed is counted in failed instead, see transfer. cancelled is true when a
transfercancel, a quit or stdin closing ended it early. durable is true only when the
destination needed durability and every flush succeeded, so the UI can say "written to the drive";
local targets report false and never claim it, and so do rclone ones, which skip the flush by design.
note carries the sentence the UI prints beside the done count: copied, but the drive did not confirm the folder when the files landed but a folder flush did not, and rclone uploads them in the background for a copy onto an rclone mount, and is empty otherwise. refused rides only when an item
failed for entries a drive refused inside its tree, see "An entry the destination cannot hold" above: one
object per entry, its path under dest and its reason, in the order the walk met them and at most 100 of
them across the transfer; that item's own err carries its full count. An item that ended on any other
error adds nothing to refused. A merge carries two more
counts, merged for every entry it landed (the inner entries of folded folders and every other
landed item, including ones that waited on a move batch) and keptBoth for the landed entries its
answer kept both, top-level and inner alike, and into naming the one merging folder, or the
destination several folders folded into, so the status line needs no client state; older clients
ignore the fields they never asked for. A merge's refused, when present, follows into.
{"t":"flashstarted","id":<uint>,"total":<uint>,"known":<bool>}
The flash worker's first line, answering what will be written: total is the unpacked size
when known is true and the file's own size otherwise. Every flashprogress and the one
flashdone behind it carry the same id.
{"t":"flashprogress","id":<uint>,"phase":"prepare|password|write|flush|verify","bytes":<uint>,"total":<uint>,"permille":<uint>}
At most one line per 150 ms, the transfer rule, whatever the drive answers. password runs
from the helper's spawn to its descriptor, so the card says "waiting for your password";
flush covers the final fsync, during which Cancel is dimmed, and prepare precedes
the password prompt while the drive is re-read. See flash for what
bytes and permille count in each phase.
{"t":"flashdone","id":<uint>,"ok":<bool>,"phase":"<string>","at":<uint>,"err":"<string>","blank":<bool>}
The flash worker's one terminal line, which releases the backend's flash slot. phase
names where it ended: verify on success, the failing phase otherwise. at is the first
differing offset on a verify failure and 0 elsewhere. See flash for every err and
what blank promises about the drive.
{"t":"flasheject","ok":<bool>,"err":"busy|gone|changed|error"}
The helper's eject verdict: busy keeps the rail's shipped "still mounted" sentence,
gone names a drive that left, changed one that changed since it was chosen, and
error everything else.
{"t":"trashed","id":<uint>,"ok":<uint>,"failed":<uint>,"moved":[<string>,...]}
Example: {"t":"trashed","id":3,"ok":1,"failed":0,"moved":["/home/gm/old.txt"]}
id echoes the request. moved names the original paths that went, so a client records an undo step for only those. Counts, plus the batch's own reason when anything failed: {"t":"trashed","id":3,"ok":0,"failed":1,"err":"<string>","moved":[]}.
Unlike transferitem there is no per-path error text, because trash is one gio call for
the batch and its exit status cannot attribute a failure to a single path; a path that is still on disk
afterwards is counted in failed. err rides only on a failure, so a successful line has no err key.
gio runs under a 10 s deadline, so a hung mount answers "The Trash took too long to answer"
instead of holding the single operation slot.
A batch that ran gio sends the line once gio has returned and each path has been checked on disk (lstat), whether
or not every path went, so a failure goes out the same way with its failed count and err. It is sent before the second
gio trash --list, which only names the undo journal's URIs. The operation slot is freed with that line: the next write
(a second trash included) is accepted at once, while undo and redo answer busy naming the batch's first path until
the list lands and the batch's undo entry is journaled, so an undo never reverses an earlier entry in its place. Entries
journal in the order operations were accepted, so a write accepted while the list is out lands after the trash. A batch
that ran no gio (every path renamed into the home Trash, or none present) sends its line once, with its journal entry.
The line is sent once per batch.
{"t":"slow","op":"<string>","path":"<string>","msg":"<string>"}
Example: {"t":"slow","op":"rename","path":"/hung/a.txt","msg":"/hung is slow. The rename will finish on its own."}
A remote rename, mkdir, bulkrename or settags past the single-call deadline answers this line and moves
on: the write stays running on its own worker, so the loop keeps answering every other request,
and the mount is never marked stuck for a write still running. op names the request (rename,
mkdir, bulkrename or settags), path the path it is writing (the rename source, the mkdir parent, the
bulk batch's folder or the folder of the first remote row a settags names), and msg the sentence the client shows as information, never as an error. The
slow line releases the one-at-a-time slot at once, so writes on other mounts and on local paths
still run; the write stays pending under its mount root instead. A write touching a mount with a
pending slow write answers an operation is already running and journals nothing, and undo and
redo answer the same while any slow write is pending, naming its path. The late reply clears
only its own pending entry. There is still no cancel id and no progress for the running write.
The write's own reply follows whenever it lands: the same renamed, made, bulkrenamed or settagged line the
in-time path writes, or the same error line if the write failed, journalled exactly once either
way, so one undo reverses it.
{"t":"renamed","ok":<bool>,"path":"<string>"}
Example: {"t":"renamed","ok":true,"path":"/home/gm/new.txt"}
path is the full path the file now has. A refusal is an error line instead, never this line with
ok false.
{"t":"duplicated","ok":<bool>,"path":"<string>"}
Example: {"t":"duplicated","ok":true,"path":"/home/gm/photo copy.jpg"}
path is the sibling that was written. A failure is an error line with where of duplicate, and a
copy that failed partway leaves its partial sibling in place and journals it, so an undo removes it.
{"t":"made","ok":<bool>,"path":"<string>"}
Example: {"t":"made","ok":true,"path":"/home/gm/New Folder"}
path is the full path of the directory that now exists, the chosen default included when the request
sent no name, which is what lets a client re-list with that row under the cursor and open its rename
field on it. A refusal is an error line with where of mkdir instead, never this line with ok
false.
{"t":"undone","op":"<string>","ok":<bool>}
Example: {"t":"undone","op":"move","ok":true}
op is the kind of operation that was reversed, one of rename, duplicate, mkdir, trash, copy,
move or merge, which is what lets the status bar say what it just put back. A copy merge journals
merge, and the bar words its undo whole: "Undid the merge." Its redo refuses instead, since the
pre-existing folder is still there. A move merge journals move, so its redo reads as a move.
{"t":"jumped","id":<uint>,"favourites":[<string>,...],"zoxide":[<string>,...],"recent":[<string>,...],"frecency":{<string>:<float>,...},"ms":<float>}
Example: {"t":"jumped","id":3,"favourites":["/home/gm/Projects"],"zoxide":["/home/gm/Documents"],"recent":["/home/gm/Pictures/screenshots"],"frecency":{"/home/gm/Documents":80},"ms":4.210}
The answer to one jump: the folders of each source that exist now, each source in its own order.
A favourite or a zoxide row must itself be a directory; a recent entry stands for the folder it sits in,
unless it is a folder itself. A folder appears once, in the first source that names it, so a favourite
zoxide also ranks is drawn as the favourite. frecency is zoxide's score for every folder answered that
zoxide ranks, whichever source draws it, and the client ranks the one list by it after the match itself.
Anything that is not an absolute path is dropped, and so is a score that is not a finite number. ms is
the whole answer's time, zoxide and the existence checks together.
{"t":"devs","devs":{<string>:<uint>,...},"id":<uint optional>}
Example: {"t":"devs","devs":{"/":66305,"/home":66306,"/home/gm/gone":0}}
The answer to one devs: each asked path once, in the order asked, with its device number. A path that cannot
be read, a missing one, an empty one, a relative one (it would name the backend's own directory, which the client
never means) and one on a mount that is not answering all answer 0, and the client reads 0 as unknown and copies:
copying where a move was possible is an annoyance, and moving across volumes loses the original. The line carries
the request's positive id when supplied; the rail accepts only the current hover's id and path. Untagged answers
continue to fill the breadcrumb and column device map, while tagged hover answers never enter that cache.
{"t":"changed","path":"<string>"}
Example: {"t":"changed","path":"/home/gm/Downloads"}
The one line no request asks for. Every other response answers a request; this one says the
directory the current listing came from is no longer what list answered with, because another
program created, deleted, renamed, wrote or chmod'd something in it. Nothing the backend holds
changes with it: the rows, the count and the sort order are exactly what they were, and a client
that wants the new directory sends list again. path is the watched directory, so a client that
has navigated since the notification was written can tell it is not about the folder it is on now,
and drop it.
A list starts watching its path before it reads the directory, not after, because a change
landing while the read runs is missing from the rows that list is about to answer with and is
therefore exactly the change the client has to be told about. It is armed beside the watch the
client is already on rather than in place of it, so a list that then fails to scan costs the
directory still listed nothing at all: its watch was never removed, and the descriptor its own
events carry is still the current one. search and listpaths both stop watching, because a set of
matches and a set of named paths are not directories.
A column's directory is watched too, and answers this same line. A peek that carries
"watch":true, which only the columns view sends, arms a non-recursive watch on its directory before
it scans, on a second inotify descriptor of its own so that removing one can never remove the listed
folder's watch. The watch fires the changed line with path naming the peeked directory, and the
client re-asks that column; a client on another path drops the line as it always did. Only the
directories the latest watching peek names in "keep" stay watched, and a peek without the flag watches nothing.
"keep":[...] is every column directory the client draws, the peeked one among them: the backend unwatches every
other peeked directory before it arms this one, and unwatches at once a directory armed after the client moved on.
Eight directories is a guard for a client that sends no keep, the oldest dropped first, and a directory the
kernel stops watching (deleted, unmounted) leaves the set after its last changed line.
The mechanism is one inotify watch on that one directory, non-recursive, with the mask
IN_ATTRIB | IN_CLOSE_WRITE | IN_MOVED_FROM | IN_MOVED_TO | IN_CREATE | IN_DELETE | IN_MOVE_SELF,
which is exactly the set of events that changes what a listing says: which names are in it, and the
size, date and mode its columns draw. Deleting the watched directory needs no bit of its own: the
kernel removes the watch along with it and reports that removal whatever the mask holds. The listed
directory itself going or moving ends in a gone line (below), never in a failed re-list, and only
an expanded child going re-lists its parent.
A file growing under an open handle is not one of them. IN_MODIFY fires on every write(2)
and a listing does not draw a partial size, so a row's size follows the writer closing the file
rather than the writer writing to it.
One burst is one line. The event payload is read only far enough to name its watch descriptor,
never for which file moved, and the reader then pauses 100 ms before reading again, so a directory
being rewritten costs one changed line per 100 ms rather than one per file. Anything the kernel
drops in that window costs nothing, because every event in a burst says the same thing to a client
that re-reads the whole directory anyway.
--backend on a box whose inotify instance limit is exhausted prints one sentence to stderr at
startup and then never sends this line, and a list whose directory the kernel refuses a watch on
(max_user_watches, most often) prints one naming that directory; every other request answers
exactly as before. A client must therefore treat a live listing as an improvement it may not get,
not as a guarantee. A
network mount is the other case: inotify sees the local kernel's own view of a directory, so a
change another machine makes to an NFS or SMB share is not delivered, and Flea is stale there in
exactly the way it was before this line existed.
{"t":"gone","path":"<string>","parent":"<string>"}
Example: {"t":"gone","path":"/home/gm/parent/open-me","parent":"/home/gm"}
The listed directory, or a directory above it, was deleted or moved away. path is the listed
directory and parent the nearest directory above it that still exists; the directory that went is
the one directly under parent on the way to path. A client on path, or on a directory under it,
opens parent without adding a history step and says why, dropping any list still out inside the
directory that went, exactly as it does for unmounted, the line the backend sends when the listed
directory's volume goes; a client that has moved on drops the line. For either line, every hidden
tab the client holds inside the directory that went opens parent too.
Every directory from the listed one up to, but not including, / is watched for its own
IN_DELETE_SELF and IN_MOVE_SELF on one inotify instance the backend's watches share, armed off the
loop each time a list lands. When one fires, or the listed directory's own watch reports it went,
the backend checks the listed path against the directory the list landed on: gone when no
directory answers there, a changed line when a different directory now answers to it, and nothing
when it is the same directory, unless the listed directory's own watch asked, which always gets a
changed line. A listed directory the backend could not look up when the list landed (a share
whose mount stopped answering) is never called gone this way; only its own failed re-list is. The
line is sent once. Until a list lands again, a list inside the directory that went, sent before
the client read the line, is answered with that same line again whether it would have failed or
landed, so a list the client dropped never lands in place of the one it sent next. A list that
fails because its directory does not exist, or is no longer a directory, is answered with gone
instead of an error when it names the listed directory or the parent the last gone line named.
So the re-list a delete's own changed line starts never draws an unreadable folder, nor does a
folder the client was entering or going up into, and a parent deleted before the client lands there
sends it on again. No gone line is sent while a search or a path list stands, since neither is a
directory.
{"t":"plugins","id":1,"plugins":[{"id":"flea.shelf","name":"Shelf","version":"0.4.0","author":"Flea","license":"MIT","description":"...","kinds":["shelf"],"glyph":"flea","mark":"","access":["shelf:pile"],"source":"builtin","origin":"","enabled":false,"failure":"","detail":"","schema":[],"settings":{},"shelf":{"enabled":false,"bar":true,"rail":"off","screenshots":true,"recordings":true,"recent":3,"pins":[]}}]}
The whole installed list after the request named by id; see plugins above. mark is an absolute path to the
plugin's own SVG when it has one. shelf is null on every plugin but the Shelf.
{"t":"pluginop","id":2,"op":"add","plugin":"mtorvik.checksums","ok":true,"code":"","detail":"","version":"0.2.0"}
One change's outcome. A refusal has ok false and a code with one detail argument; the codes are the ones
src/ui_logic_plugin_settings.rs and src/ui_logic_plugin_settings/wire.rs list, each selecting a plugins.error.* or
plugins.invalid.* catalog sentence. version is the plugin's version after an add or update.
{"t":"pluginprogress","id":44,"plugin":"example.send-target","message":{"op":"progress","done":1,"total":1,"message":"Receiving selection."}}A progress event for the outer runtime request identified by id and plugin. The outer message holds the
plugin's progress object. Its done and total are whole numbers from 0 through 9,000,000,000,000,000, with
done no greater than total. The inner message is an optional string. Progress is streamed while the request
runs, before its terminal pluginruntime reply. Clients should correlate events by id rather than count lines.
{"t":"pluginruntime","id":41,"plugin":"example.send-target","ok":true,"message":{"op":"targets","targets":[{"id":"receiver","label":"Local Receiver","state":"ready"},{"id":"offline","label":"Offline Receiver","state":"offline"}]},"progress":[],"code":"","error":""}The terminal outcome of one runtime request. The envelope always includes t, id, plugin, ok, message,
progress, code and error. id and plugin identify the outer request. On success, ok is true, message
contains the result object, and code and error are empty strings. progress holds the accepted progress objects
in order, including objects already sent through pluginprogress. Do not apply them twice.
For example, this send emits the progress line above and then the terminal line below:
{"c":"plugins","op":"runtime","id":44,"plugin":"example.send-target","request":{"op":"send","target":"receiver","paths":["/home/me/notes.txt"]}}
{"t":"pluginruntime","id":44,"plugin":"example.send-target","ok":true,"message":{"op":"done","message":"Selection received."},"progress":[{"op":"progress","done":1,"total":1,"message":"Receiving selection."}],"code":"","error":""}A plugin's error result is an operation failure: ok is false, code is operation, error is the plugin's
message string, and the original error object remains in message. Accepted progress is retained. This result
does not itself mark the plugin failed.
{"t":"pluginruntime","id":45,"plugin":"example.send-target","ok":false,"message":{"op":"error","message":"Choose the ready receiver and at least one file."},"progress":[],"code":"operation","error":"Choose the ready receiver and at least one file."}A host refusal or runtime failure instead has ok:false, message:null, progress:[], and a code and error
describing the failure. Previously streamed progress can therefore exist even when the terminal array is empty.
Codes include unknown for an unrecognized installed id, request for an invalid operation or its validated
fields, busy for a concurrent ordinary lasting-session request or a full plugin-host worker pool, start for startup or
runtime failures and for a disabled or failed plugin, and write when the host cannot initialize plugin storage.
These fields are code and error, rather than the management reply's code and detail.
{"t":"pluginruntime","id":46,"plugin":"example.send-target","ok":false,"message":null,"progress":[],"code":"busy","error":"plugin busy"}Preview results are normalized before they reach this envelope. Text is reduced to at most 1,000 plain lines with
control characters other than tab removed from each line. A PNG result's png names the retained host file, with
width and height; it is not the subprocess's /out/preview.png path.
{"t":"error","where":"<string>","path":"<string>","msg":"<string>"[,"mode":<uint>][,"code":"<string>"]}
Example: {"t":"error","where":"scan","path":"/root","msg":"permission denied","mode":16872}
where names the failing operation, path names the input that failed, msg is the
underlying message. code rides only on a refusal the UI words itself (emptyclipboard, from pasteimage). Over --backend's stdout, where is scan (a list whose path
failed to read), sort (a sort whose key names no order this wire defines; path
carries the key as sent), window (a remote metadata window whose mount did not
respond or whose worker stopped; path matches the current listing header's path
byte for byte, including its original spelling), stale (a row-indexed request naming
a numbering the listing has left; path carries the command, see "listing"), flash (a second
flash while one runs; path carries the device), or read (the
stdin stream itself could not be decoded; the loop stops right after emitting this
line, because the framing cannot be trusted past that point; thumbnail work already
running is still drained after it, so a thumbed line can follow). The write
operations answer over the same stdout and name themselves the same way, and
rename-kept and rename-stranded (see rename) are the only values on this wire that are not one lowercase
word, so a client matching this field must allow the hyphen. error_line
is also how flea --prewarm reports a failure, to stderr rather than over this wire
protocol. where names whichever operation actually failed: a missing or unreadable
path propagates scan's error unchanged, so where reads scan there too; only a
failure inside prewarm's own file handling (creating, writing or renaming the temp
file) reports where":"prewarm". An error line is sent instead of listed or
rows; it never changes the backend process's exit code.
mode is the st_mode of the path a scan could not read, in decimal, and it is written only when
the backend actually read it. It is a directory's mode in the case the field exists for; a list of
a regular file fails with ENOTDIR and carries that file's mode instead, which no client draws,
because only a denial reaches the Locked state. The stat outlives the denial: /root answers 16872, which is
0o40750, while opendir on it is refused. No other where ever carries the field, and a scan
whose path could not be stat'd either leaves it out, which a client reads as "I could not look" and
draws as a sentence with no permission string under it. It exists because a typed path, or
FLEA_PATH, reaches the denial with no parent listing to remember the mode from.
flea --prewarm <path> <first> <dest> writes exactly a listed line then a rows
line, the same two lines --backend would print for an equivalent list, to dest
instead of stdout. See AGENTS.md, "Prewarm".
--prewarm exits 0 if and only if dest holds a complete listing of path; on
failure it writes an error line to stderr, exits non-zero, leaves no temp file, and
does not touch dest, so a caller must check the exit status before reading the
file.
peek, paths, archive, convert and formats are on the wire and are not documented
here yet. tools/flea-acceptance derives its checklist from this file, so each one is a gap in that
battery until its section is written.
The formats and archive parts of that set are named here exactly, because they changed. A formats reply's extract
object carries one bit per extension class: {"archive":<bool>,"sevenZip":<bool>,"zip":<bool>}, where
archive is the tar class on bsdtar, sevenZip is the .7z and package (.deb, .rpm, .apk, .jar,
.cab, .cpio, .AppImage) class on 7z, and zip is the
.zip/.rar class served by whichever of those two is installed. The client offers Extract on a package only
when sevenZip is set; the backend's own listing of a package still falls back to bsdtar where 7z is missing,
as v0.3.8 did, except an .AppImage, whose squashfs image only 7z reads. An archive request with an op of
extract joins the destination-drive queue transfer describes. It answers archivestarted with its
own id even while waiting, drives that same transfer card through extractstarted and
transferprogress, and answers archivedone, never transferdone. A transfercancel naming its
id cancels only that extraction, whether waiting or running. It is not journaled, so no undo
reverses it.
An archive request is {"c":"archive","op":"compress"|"extract","paths":[<string>,...],"path":"<string>","dest":"<string>","format":"<string>","password":"<string>","encryptNames":<bool>}.
A compress names absolute paths sharing one parent and the format to write; an extract names the
one archive in path. password is empty for a plain operation: only a 7z compress or an extract that
7z reads (a .zip too, where 7z is installed) takes a non-empty one, and any other reader answers err of "only an archive that 7-Zip reads can take a password" without piping the secret. The secret travels this stdin wire and leaves it only on
7z's own stdin pipe, never in argv, an environment variable, a log or /proc/<pid>/cmdline. A compress
argv carries a bare -p (7z then reads one stdin line), an extract carries none (7z reads a bare -p
as an empty password). encryptNames hides the entry names of a password .7z (-mhe=on) and is
ignored for .zip, which a password writes as AES-256 (-mem=AES256). Absent password is today's
plain path, so every older client is unchanged. A plain .zip is written by 7z -tzip when 7z is
installed and by bsdtar otherwise, and every 7z compress stores a symbolic link as a link (-snl), as
bsdtar does, so a dangling one no longer fails the archive.
Before a plain extract starts, an archive that 7z reads is probed with 7z l -slt and stdin closed: exit
255 (the headers are encrypted) or exit 0 with an Encrypted = + line (entries are encrypted) answers
err of "encrypted", and so does a plain extract that still exits 255. A password run that exits 2
answers "wrong-password" only when the same technical listing proves a password guards the archive: 7z
exits 2 for a wrong password, for damaged encrypted data and for a file that is no archive at all, so
without that proof the run answers as a plain failure and the card never asks again. Both are codes, never sentences, read from exit
codes and technical listing keys and never from the tool's words; the card words its own sentence from a
template, the client asks again on both rather than messaging, and Cancel runs nothing. A line carrying
either code also names the retry: {"t":"archivedone","id":<uint>,"ok":false,"verified":true,"err":"encrypted"|"wrong-password","path":"<archive>","dest":"<destination>"},
so the card opens over the archive that asked and no client-side stash can name another extract's.
A successful extract names the same two fields, {"t":"archivedone","id":<uint>,"ok":true,"verified":<bool>,"err":"","path":"<archive>","dest":"<destination>"},
so a client tells it from a compress, whose success line names neither.
A dest already taken is never written over or merged into. The result lands beside it under the next
free name in Duplicate's words: pack.zip becomes pack copy.zip, then pack copy 2.zip, keeping the
whole format as the extension (pack copy.tar.gz), and an extract folder plain becomes plain copy.
The name is picked when the finished result is renamed into place, so one taken while the tool ran is
passed over too; dest in the success line stays the name the request asked for. A taken dest whose
name is not UTF-8 has no copy name, as with Duplicate, and answers err of
"that name is taken and no copy name can be made from it". When bsdtar runs the extract, a member that
would land outside the folder (a ../ entry, or one written through a link the archive made) refuses the
whole extract with err of "an entry in this archive would land outside its folder, so nothing was extracted";
7z, which runs password and .7z extracts, drops the ../ and keeps the member inside the folder.
A .iso lists and is never extracted: an extract naming one answers one archivedone with ok false
and err of "a disk image opens as a listing and is never extracted", and starts nothing, so no archivestarted
line is sent and no slot is taken. Before extracting, the archive's unpacked
size from its own index is weighed against the destination's free space, and a fit that cannot land is
refused the same way: {"t":"archivedone","id":<uint>,"ok":false,"verified":true,"err":"Extracting <leaf> needs <needed>, and <target> has <free> free."}, where <target> is the name of the folder the
extract lands in, or / for the root. An index that cannot be read refuses nothing, because unknown is not evidence
the extract cannot fit.
A peek request with "details":true is used by TUI folder previews. Only returned
rows, already limited by first and PEEK_CAP, pay one no-follow metadata read
inside the existing bounded mount worker. Their s (entry bytes) and p (mode)
fields let the TUI draw child sizes. A vanished or unreadable entry carries zero
mode and size, which the TUI leaves unavailable. The default is false: ancestor,
network and other existing peeks keep their name-only path and perform no
per-entry metadata reads.
One peek field is worth naming ahead of that section, because it is new. A peeked line whose scan
failed carries "failed":true, with "mode":<uint> beside it under the same rule the error line
uses, so a column can tell an unreadable directory from an empty one instead of drawing both as the
empty state. A peeked line that succeeded carries neither field, whatever n is.
More peek fields are worth naming for the same reason. Every peeked line, failed or not,
echoes the hidden, hiddenLast and first its request carried, because three clients read this wire at once: ui/ColumnsArea.qml
peeks the pane's ancestors with the listing's own flags and the pane's window size, ui/NetworkMounts.qml peeks with a first of 1 or of 512,
and the path bar's Tab peeks with whatever the typed leaf asks for. The repair legs ask 512 and the folder check asks 1. path alone cannot tell one client's reply from another's, and path
plus hidden plus hiddenLast plus first can, which is all the correlation any needs: the same quad answers the same rows,
so no request id has to be threaded through. A client that ignores the fields reads the line exactly
as it did before. A peeked line echoes by and desc only when its request carried by, so a column re-asked after its folder's remembered order changed tells a reply sorted under the old order from the one it waits for, and a request without by gets the line it always got. A peek request carries optional hiddenLast, false unless true: with
it on the peek sorts dotfiles last the way the listing does, so the columns beside a hidden-last
listing draw the same order instead of today's dotfiles-first one. A peek request carries optional by (name, size or mtime) and desc, sent only by the columns view for a folder with its own remembered order while remembering is on; absent is name order, a key the wire never defined answers the same "where":"sort" error a sort does and no peeked, and only size and mtime pay a stat per entry. A peek request carries optional watch,
false unless true, and keep, a list of paths: the columns view sets both so the backend arms a watch on that
directory, see "A column's directory is watched too" above; the peeked reply is the same either way. A peeked line also carries v, the directory's device, and w, whether it can be written, the
same two fields a listed line carries, read once per peek so a drag from a column takes the verb a drag from the
listing takes; a failed peek carries neither.
- The two-line prewarm file names its directory, as every
listedline does, but nothing in it says whether that directory changed after it was written, so a stale file cannot be told from a fresh one and production ignoresFLEA_PREWARM. Add a freshness proof and prove a first-paint win before re-enabling a reader. - The pool is built when the backend starts, not when the first
thumbarrives. That costs every backend process about 1.2 ms of startup and about 0.5 MB of PSS for a subsystem a client may never use; see AGENTS.md "Thumbnail requests". thumbcancelnames rows, and only rows this process actually queued can be cancelled. Cancelling a row that was answered from the cache, or that no thumbnailer declares, is silently a no-op, because there was never a job to drop.tis true for a symlink whose name resolves to a declared type, whatever the link points at. The flag reads the file type out of the row's ownp, which for a symlink isS_IFLNKand says nothing about the target, so a symlink to a directory, to a FIFO, to a loop, or to nothing at all still reportst:true. Every one of them is answered with an emptyfilein microseconds when it is actually asked for, because the request path stats the target, so nothing blocks and no marker is written. It is an over-promise on the wire rather than a hazard, and a client that renders per-row state fromtalone will show a thumbnail slot that never fills. The shipped GUI renders defensively instead of the wire narrowing: an emptyfileis a terminal answer in its row map and the delegate falls back to the themed icon, so such a row simply keeps the icon it already drew. Narrowing the flag stays undone on purpose, because it is a wire change with its own documentation and test surface and half-narrowing it is worse than leaving it whole.- A non-UTF8 filename arrives lossy, and the thumbnail path inherits that. Two names in one
directory differing only in their invalid bytes collapse to the same string, so the backend
maps one path where the client named two rows and the second row's
thumbedline arrives only at the nextlist,sortor shutdown. See AGENTS.md "Deliberate corners". - The
fileathumbedline names is read from the shared cache, which every application on the box writes, and nothing sandboxes the client that decodes it. Generation runs underbwrap; display does not. The shipped GUI does hand this path straight to a QMLImage, so Qt's PNG decoder runs unconfined in the shell process on bytes it did not write. That is a known residual risk, parked for a later plan rather than closed here. See AGENTS.md "Deliberate corners".
Jobs are additive to the existing transfer, archive, and LocalSend requests and replies. The backend still emits the existing single-operation events with their existing fields. Clients that do not consume jobs can ignore the new event types. Each copy, move, compression, extraction, background action, and LocalSend send has a backend job id, independent of a caller's request id. Empty Trash adopts its existing operation id and cancellation flag through the same model, with the head Emptying Trash.
Requests:
{"c":"jobs","op":"list"}
{"c":"jobs","op":"cancel","id":12}
{"c":"jobs","op":"retry","id":12}
{"c":"jobs","op":"dismiss","id":12}
{"c":"jobs","op":"undo","id":12}list returns a jobs snapshot. A snapshot also accompanies membership and scheduling changes. jobs contains the ordered list, newest first, unfinished counts only running and waiting jobs, and newest identifies the newest unfinished job or is null. head is that job's head, or an empty string. This supplies the TUI status row's newest operation and its · 3 jobs suffix. A job update replaces the matching id without moving its row. Progress updates are limited to one per job per 150 ms; scheduling, completion, cancellation, and Undo availability changes are immediate.
{"t":"jobs","jobs":[],"unfinished":0,"newest":null,"head":""}
{"t":"job","job":{"id":12,"kind":"copy","head":"Copying 10 of 18 to NAS","file":"DSC_4944.jpg","done":9,"total":18,"bytes":5300000,"totalBytes":9700000,"itemBytes":458300,"rate":1100000,"left":4,"state":"running","reason":"","output":[],"undo":false,"cancelled":false},"unfinished":3}
{"t":"joberror","id":12,"error":"Only a failed job can be retried."}A queued job (copy, move, compress, extract, send or action) sends a roots line before its first job line, and a retry sends another before the job line that requeues it: {"t":"roots","id":12,"job":true,"kind":"copy","paths":["/home/user/Photos/a.jpg","/run/media/user/STICK"]}. kind is the job's own kind, so a retry names its job's. paths are the sources, the destination folder, an archive, and the destination row a menu transfer resolved by identity, each absolute and sorted, from the backend's own resolution of the request, so a menu or search-result selection names each row where it lives. A LocalSend, AirDrop or rclone send's first roots line also names the request that started it as requestId ({"t":"roots","id":21,"job":true,"kind":"send","requestId":3,"paths":["/run/media/user/STICK/a.jpg"]}); its retries do not. A later roots line for the same id replaces the earlier set. Empty Trash adopts its job and sends none. A shelf drop sends the same line after its transferstarted, with job false and kind copy or move, naming the shelf entries and the destination. A client holds a request's own paths from the time it sends it until the backend ends or refuses the request, or a roots line takes them over: a transfer's at its transferdone or a refusing error, an archive's at its archivedone or a refusing error, an action run's at its job's roots line or at an actionstarted that names no job (a terminal handoff or a refusal), and a send's at the roots line naming its requestId or an rclonestarted that refuses it. A LocalSend or AirDrop send always queues a job, so its roots line always comes. The client holds a job's paths from its roots line until a job line reports it failed or done, or a snapshot no longer lists it, and holds a drop's until its transferdone; it checks them before it unmounts or ejects a volume, and names the holding transfer's kind when it refuses. Older clients ignore the type and the new fields.
Kinds are copy, move, compress, extract, send, action, and the adoption kind emptyTrash. States are waiting, running, failed, and done. done counts completed top-level items; total counts this attempt's items. Extraction starts with zero unknown entry counts until its producer supplies archive entry counts and reports unpacked bytes through OpMsg::JobEntries, without changing the wire. file is the current item's name; itemBytes is its known size. bytes is cumulative progress and totalBytes is the settled byte total, with zero meaning unknown. rate is bytes per second and left is estimated seconds or null when no estimate is available. A background action has null byte fields and a file-count bar. Empty Trash has null byte fields and counts successfully deleted filesystem nodes, including descendants, against the reviewed recursive total. Its initial total is zero until the worker reads the confirmation. It retains the current top-level item's reviewed size in itemBytes; left uses deleted nodes and elapsed time. Its terminal legacy replies still count top-level Trash entries, cancellation keeps completed deletions, and retry requires a fresh Trash confirmation.
Copies, moves, compressions, and extractions are queued in arrival order per destination filesystem. The device is resolved off the request loop, following a symlinked target. Btrfs subvolumes share the mount's source key because their anonymous st_dev values can differ. Separate destination filesystems run concurrently. A waiting copy uses Copy 8 items to NAS and names its predecessor in reason, for example waiting for the copy to NAS. Cancellation addresses only the named job, including a queued job. transfercancel also reaches jobs with that id, including compression. A clean shutdown cancels queued and running jobs through the existing drain.
A failure retains its position, with a failure head and its reason. retry preserves the row and id, requeues behind jobs already accepted, and narrows the attempt to failed items. The queued work retains each failed source's identity, including its birth time when available. Transfers check that identity before each item, actions before each invocation, and indivisible archive or send operations before their invocation. A replacement is refused and never becomes the identity of a subsequent retry. A compression or extraction is one indivisible failed operation. dismiss accepts only failed or done rows.
A successful journalled transfer has undo:true only after its journal entry is published. The offer belongs to that backend's job and expires when another operation, Undo, or Redo changes the history, including in another window. The shared journal claim compares the saved history revision and exact entry under its lock; an expired offer is refused with That job can no longer be undone. and revoked without consuming any entry. Reversal replies use the existing undone or error events and update search indexes and tag state through the same path as ordinary Undo, including paths changed before a partial failure. undo refuses while another job is unfinished. Compressions, extractions, sends, and arbitrary actions do not invent undo records. A done row is a completion notification and is omitted from the visible card; the backend retains it until the next job starts so its Undo remains addressable. Failed and done jobs do not contribute to unfinished.
Archive workers capture source identities before their first invocation and carry them with the completion, including menu selections. Completion handling never inspects those paths to construct a failed set. Later retries retain the captured identities even when a changed source is refused. Job-offer expiry uses its own shared history revision; the generation that guards Redo publication changes only on a new operation push, so overlapping successful Undos both remain redoable when no new operation was pushed.
Actions requests use absolute selection paths, resolved by the caller from one listing before sending. A preview request carries only the cursor file, never the marked selection.
{"c":"actions","op":"list","id":4,"paths":["/home/user/Photos/photo.jpg"]}
{"t":"actions","id":4,"actions":[{"id":"action:resize.toml","name":"Resize to 1600 px","mode":"background","selection":"many","script":false}],"errors":[],"error":""}
{"c":"actions","op":"run","id":5,"action":"action:resize.toml","paths":["/home/user/Photos/photo.jpg"]}
{"t":"actionstarted","requestId":5,"id":13,"ok":true,"error":""}
{"c":"actions","op":"preview","id":6,"action":"action:describe.toml","paths":["/home/user/Photos/photo.jpg"]}
{"t":"actionpreview","id":6,"ok":true,"text":"Description from the previewer\n","error":""}A terminal handoff or refused run answers actionstarted with requestId, ok, and error, without a job id. A terminal action opens each expanded argv through xdg-terminal-exec --dir=... -- ..., the Open in Terminal launcher. A preview-only action refuses run. A preview answers text suitable for the existing code request's text input and the code renderer. Its process runs in the existing read-only preview jail with only the cursor file and executable added, a five-second wall deadline, the existing CPU and address-space limits, and a 1,048,576-byte output cap. A newer preview request cancels and suppresses the older reply.
The manifest directory is $XDG_CONFIG_HOME/flea/actions or $HOME/.config/flea/actions. The parser accepts the specimen's TOML subset: five unique required keys, double-quoted basic strings with JSON-compatible escapes, and possibly multiline string arrays with comments and trailing commas. Raw C0 control bytes other than tab, and raw DEL, are prohibited in strings; supported escaped values remain valid. Other keys, tables, duplicate keys, missing fields, wrong types, empty arrays, invalid modes or selection rules, invalid escapes or placeholders, and files over 16,384 bytes are refused whole. Directory discovery examines at most 257 entries to detect overflow, counting unrelated entries too, and reports when that entry limit truncates discovery; it reads at most 256 manifests; arrays hold at most 128 elements. Nonregular files are refused without blocking. Each refusal appears in the actions.errors array as {"file":"bad.toml","error":"..."}; valid siblings remain available.
name = "Resize to 1600 px"
mime = ["image/*"]
selection = "many"
run = ["magick", "{path}", "-resize",
"1600x1600>", "{dir}/{stem}-1600.{ext}"]
mode = "background"MIME patterns match the entire MIME string and accept literal characters, *, and ?. Every selected item must match a pattern; one requires exactly one item, while many accepts one or more. MIME comes from the existing name database, with directories reported as inode/directory and unknown files as application/octet-stream. Listing and running recheck the actual selected paths. No directory listing is MIME-scanned to populate Actions.
{path}, {dir}, {name}, {stem}, and {ext} expand separately within each argv element, once per selected file. Replacements are not expanded again. The program is literal and cannot contain placeholders. Paths remain absolute; a placeholder-led argument whose result begins with - is prefixed with ./, so a filename cannot become an option. Invocation uses argv without a shell unless the manifest explicitly names one. A background job retains only its last two merged stdout and stderr lines, each bounded to 4,096 decoded UTF-8 bytes with lossy decoding. output replaces the file line once nonempty. The invocation owns its entire process group: cancellation and leader exit, successful or unsuccessful, kill remaining descendants with SIGKILL before reaping the leader, including children that ignore SIGTERM.
Executable regular files directly under $XDG_CONFIG_HOME/flea/scripts remain Actions entries, with ids script:<filename> and labels omitting the final extension. They retain the existing Run script contract: one invocation receives all selected absolute paths. The Actions switch retains the runScript id in menu.hidden and remains hidden by default. No src/uischema.rs defaults change.
{"c":"airdrop","op":"send","id":1,"peer":"3a9f0c2be41d","name":"Jane's iPhone","paths":["/home/u/a.png"]} sends the
files to one AirDrop device by the service ID owly browse printed before its name, since two devices can share a name,
as a send job headed by name (the service ID when name is absent or empty): the backend runs
owly send --to=<peer> -- <paths>, turns its <sent> / <total> bytes progress into job progress, and kills it on
{"c":"jobs","op":"cancel","id":<job>}. It answers one line when the job ends:
{"t":"airdropsent","id":1,"ok":true,"code":"delivered","reason":""}
code is delivered, declined (the device refused), failed (with owly's own reason), cancelled, missing
(owly is not on PATH) or stale (a path is gone). The window owns the radio, the receiver and discovery: it runs
owly doctor --json, owly radio up --for 600, owly receive --dir <folder> and owly browse itself, and the
backend's providers facts name owly's path. The machine has one radio: the window that turns it on holds an
exclusive lock on $XDG_RUNTIME_DIR/flea/airdrop.lock (with FLEA_AIRDROP_DIR set, the three files sit directly in that
directory) and writes airdrop.state beside it, three lines: its token, starting or on, and the card. Every other
window reads that state, browses and sends over it, and asks the owner to stop by writing the owner's token to
airdrop.stop, which the owner checks once a second. A window reads the state, asks a stop, withdraws one, takes the
lock and writes or removes its own state off its own thread on the background executor, each after the one it asked
before; the look before a Receiving On takes the lock when no radio is up, and gives it back if that On does not start
the radio. A read that a later Receiving choice
overtook never lands: a Receiving On waiting for it is dropped, the once-a-second look waits for its next second, and
a menu or Settings look is taken again. A Receiving Off while an On waits asks the stop again, a shut menu drops a menu
open still waiting for its read, and a stop asked just before the window closes, Flea quits or Flea is ended by
SIGTERM, SIGINT or SIGHUP is still written, Flea waiting up to 1 s for it as it exits. The owner's withdrawal removes
the state before releasing the lock; the lock stays held until the stopped radio has exited, and a Receiving On asked
meanwhile starts once it has, under the same lock. When the receiver or the
radio exits, the window takes both down and says owly's reason unless the ten minutes ran out. A window that closes, a
quit, and a Flea ended by SIGTERM, SIGINT or SIGHUP (each one still at its default action when the first owly run
started, the first stop was asked or Receiving was first set to On, whichever came first) send
SIGTERM to every owly run and wait up to 5 s for them to exit, which gives Wi-Fi back. The receiver asks
accept? [y/N] for each incoming request; the window answers it from a notification with Accept and Decline buttons,
and anything but Accept within 12 s declines; the window then closes that notification by its id. The footer names
each file the receiver saved (several within 2 s as one count) and each link it was sent (shown, never opened), and
says when a transfer failed or the sender withdrew its request. owly is MIT, by
Tristan (t4t5).
The menu's executable capabilities include providers.rclone with the existing installed, command, and reason fields. Request configured remotes only when opening the send menu:
{"c":"rclone","op":"remotes","id":71}
{"t":"rcloneremotes","id":71,"visible":true,"remotes":["gdrive","b2-photos","nas-crypt"]}
{"c":"rclone","op":"send","id":72,"remote":"gdrive","folder":"Uploads","paths":["/absolute/photo.jpg"]}
{"t":"rclonestarted","requestId":72,"id":12,"ok":true,"error":""}listremotes runs off the loop, inherits RCLONE_CONFIG, contacts no remote and has a two-second deadline. A missing or unusable rclone, no remotes, or failed discovery answers visible:false and remotes:[]: hide the menu row. Names omit the trailing colon. Send rechecks that the remote is configured. folder is a path within it; empty means its configured root. A folder with any .. component is refused before a job starts. Source paths must be absolute and are resolved once by the caller. A refused request answers rclonestarted with requestId, ok:false, error, and no job id.
A send uses the ordinary jobs list, kind:"send", with independent per-item copyto or directory copy invocations followed by a separate verification pass using check --one-way. Source and target argv follow --; no shell is involved. Directory copies preserve the selected directory and empty descendants. A remote that cannot store empty directories refuses any selected tree containing one instead of issuing a checked receipt. Selected symlinks, unsupported item kinds and duplicate destination basenames are refused. Directory descendants are inspected without following links; symlinks, pipes, sockets and other unsupported descendants fail the item with their path. A skip reported during copy or check also fails the item, even when rclone exits successfully. A nonempty remote folder ending in a colon still separates its selected basename with a slash. Source identities are retained through retries and revalidated before every invocation. Originals are never removed.
Job updates add phase, check, receipt, and note strings, empty for existing producers. Rclone phases are sending, checking, checked, and finished; checks are none, checksum, and size. Sending uses the existing counts and byte fields, with monotonic absolute JSON-stat bytes and rclone's speed and ETA. Checking remains state:"running", with a heading such as Checking 3 items on gdrive, file:"comparing checksums" or file:"comparing sizes", an indeterminate bar and no rendered byte line. Numeric byte fields retain their prior values. State and phase changes are immediate; ordinary progress remains limited to one update per 150 ms.
Inherited global copy, filter and reporting options, including quiet/verbose and local traversal aliases, are removed from rclone children, while configuration, authentication and unrelated backend options remain inherited. Copy and check explicitly disable link following, link translation, filesystem-boundary filtering and silent skip settings, overriding backend and per-remote traversal settings. A checked receipt covers the explicitly selected content. Remote features are queried before copying and determine available hashes and empty-directory support; a remote with no locally supported hash uses size-only verification. If an individual object cannot supply a hash, the receipt is downgraded to size. Only a successful copy and completed check produce a verified receipt. The terminal notification follows the terminal job update:
{"t":"rclonesent","id":12,"requestId":72,"ok":true,"cancelled":false,"check":"checksum","receipt":"Sent 3 items to Uploads on gdrive","note":"","error":""}The receipt has no full stop; clients append muted · checked by checksum or · checked by size. A mismatch fails the job with Send failed and a reason naming the failed file and remote. The existing jobs Cancel kills the current process group, including descendants that ignore SIGTERM. Files already copied remain remote; a cancelled check has check:"none", note:"not checked", and ok:false. Retry keeps the id and row and resends only failed top-level items with their captured identities. It forces retransmission so a checksum failure can be repaired even when the destination retains the source size and timestamp. Retry counts describe that attempt. Dismiss uses the ordinary job contract. Sends never offer Undo.
searchcontents takes path (an absolute folder), query (one nonempty literal,
case-sensitive line), hidden, positive gen and optional count. The default
count is the existing search first-window size; counts above 4096 are refused.
The producer runs ripgrep once in the read-only sandbox, honors ignore files,
does not follow discovered symlinks, skips binary matches, and keeps the first
matching line per file. No shell interprets the query or path.
The previous complete listing remains current until ripgrep finishes successfully.
The new snapshot emits contentsmatches for the first window, then ordinary
listed, rows, and terminal searched. All carry the query generation;
contentsmatches, listed and rows also carry the operation listing identity.
window emits its matching metadata before its rows, retaining both identities.
The complete result set remains pageable. Match metadata may use several bounded
envelopes for a window; each envelope's start and contiguous row values name
its portion. Consumers assemble metadata and rows before presenting the snapshot.
{"c":"searchcontents","path":"/work","query":"needle","hidden":false,"gen":7,"count":40}
{"t":"contentsmatches","gen":7,"listing":2,"start":0,"matches":[{"row":0,"path":"notes.txt","pathBytes":"6e6f7465732e747874","lineNo":3,"line":"needle first","operable":true}]}pathBytes is hexadecimal encoding of the exact relative filename bytes.
path is display text only. Line numbers are one-based. Non-UTF-8 paths retain
their lossy display, matching the previous listing behavior, but carry
operable:false. A real UTF-8 filename sharing that display also carries false
while this snapshot is held. Backend row and explicit-path requests for either
ambiguous identity are refused with where:"contentsidentity" before resolution.
An adapter must refuse external open, reveal, clipboard, drag and operation
dispatch for these rows; it must never construct an operation path from display
text. The shared ui_logic_file_search parser validates metadata for both front ends.
This producer does not enable either adapter's contents capability.
searchcancel and searchclose stop and reap the running jail, including startup.
Their cancellation or close receipt follows cleanup and names the newest requested
generation, including a request waiting for an older worker to stop. Older or
duplicate generations and stale completion tickets publish nothing. Replacement
queries serialize after cleanup. Navigation discards the old worker's result.
A file or folder that ripgrep cannot open or read, the root included, is skipped
as the names walk skips it: when ripgrep exits 2 after writing its summary and
every line it wrote to stderr names a path with its OS error ((os error 13)),
the snapshot publishes what it read and the terminal searched carries
partial:true with partial_reason:"unreadable". Any other stderr line makes the
exit a failure.
On missing ripgrep, a sandbox that refuses to start, any other exit failure,
malformed output, output limits or the 30-second wall deadline, the backend emits
a generation-keyed error and preserves the previous listing, with no success
receipt. The GUI ends that generation's walk with nothing found and says the
error's sentence in the footer.
Retained match data and a single pending rg JSON record each have an independent
64 MiB bound. Both stores may coexist, in addition to transient parser and wire
allocations. Exceeding either bound fails the request rather than returning an
apparently complete cap. Full matching lines within these bounds are retained.
The worker reads at most 8 KiB per pipe iteration. A finished search ignores
searchcancel; searchclose acknowledges its scope once. Closing retains the
displayed snapshot and its identity guard until navigation or replacement, so
closing cannot make an ambiguous filename operable. Failed or cancelled queries
also preserve the previous folder's watch and any previous name-search session.
An explicit searchclose closes that previous names session and walk too, before
the contents close receipt; late names completion events then publish nothing.
Sorting a snapshot reorders match metadata with its listing and advances the
listing identity. Name and kind sorts work for every snapshot; size and date
sorts refuse snapshots containing non-operable paths to avoid statting aliases.