Skip to main content

Module guidance

Module guidance 

Source
Expand description

The instruction files of a QCode high profile: the file each harness reads its standing instructions from in the workspace, and QCode’s own section in it.

Two parties write into these files, and the person is a third. graphify writes its own section and hooks itself, from inside the profile’s container (graphify <platform> install); QCode writes only the section between BEGIN and END, which tells the agent that it is one of several tabs of a workspace and how to reach the others. Everything outside the markers is left byte for byte as it was, and a file that already says what QCode would write is not written.

The merging is plain text in, plain text out, so it is tested here without a disk; write() is the one function that touches the workspace folder.

Enums§

Unguided
Why the instruction file of a harness could not be brought up to date. The tab starts all the same; the person is told.

Constants§

BEGIN
The line QCode’s own words start after. An HTML comment, so a Markdown reader shows nothing.
END
The line QCode’s section ends with.
HEADING
The heading QCode’s section stands under. It comes before BEGIN, not after it, because of how graphify finds its own section again: measured in graphify 0.9.65, its section runs from its ## graphify heading to the next line that starts with ## , and a second install writes that whole stretch anew. An opening line right after graphify’s section and before any heading of ours was taken as graphify’s and dropped; a heading of ours ends graphify’s section first.
SECTION
What QCode tells every agent of a workspace, in English, the language of the agents and of the bridge server’s own words. The same text for every harness, because two of them read the same file (AGENTS.md) and Antigravity IDE reads the others’ files as well as its own; so every sentence has to be true whichever agent reads it.

Functions§

block
QCode’s whole section as it stands in a file: HEADING, then SECTION between the markers.
file
The file harness reads its standing instructions from, relative to the workspace folder.
graphify_file
The file graphify’s workspace installer (graphify <platform> install) writes its section into, relative to the folder it runs in, as measured with graphify 0.9.67.
graphify_leftovers
What else graphify’s workspace installer leaves in the folder it runs in, run in the home directory, and where each belongs so that the harness reads it for every folder: (from, to), both relative to the home directory, with to empty for what has no place there and goes.
lock
Held while one tab’s graphify and QCode write a workspace’s instruction files.
merge
existing with QCode’s section in it, for harness; None when it says so already and nothing is to be written.
platform
The word graphify’s own installers know harness by: graphify <word> install writes its section and hooks into the workspace, graphify install --platform <word> its skill into the home directory.
skill
Where graphify’s skill for harness lands, relative to the home directory, as measured: the image build checks that it is there.
user_file
The file harness reads standing instructions from for every folder it works in, relative to the home directory: where QCode basic puts graphify’s section, so that nothing is written into the person’s own files.
write
Brings QCode’s section of harness’s instruction file in the workspace folder code up to date, and says whether anything was written.