isorite 0.3.1 → 0.6.0

package/README.md

@@ -6,13 +6,13 @@ Needs Node 24 or later. For the terminal, OpenCode 2: `npm i -g @opencode/cli`.
 
 ```sh
 npm install -g isorite
-isorite --tutorial          # the tutorial: the terminal's tour, and the browser's beside it, on an example base
+isorite guide               # the guide: a knowledge base about isorite, with things to do, in ~/isorite-guide
 ```
 
 On your own notes, a folder of Markdown files (`isorite new <notes>` starts one):
 
 ```sh
-isorite serve <notes>       # the browser, at http://localhost:4767/; set Iso's provider key behind the logo
+isorite serve <notes>       # the browser, at http://localhost:4767/; set up Iso's provider in Iso's settings
 cd <your code> && isorite term <notes>   # OpenCode here, with the notes beside it
 isorite model               # optional: search by meaning (fetches a 53 MB model, once)
 ```
@@ -21,6 +21,6 @@ Setting it up, at work too (a company's gateway, a client certificate, a proxy):
 When something fails, `isorite doctor` says what to change; `isorite doctor --report` gives it as one block, its
 secrets hidden, to paste to someone helping. For an AI helping you: `isorite help setup`.
 
-The tutorial in a browser alone: https://lachlanjs.github.io/isorite/
+The guide in a browser alone: https://lachlanjs.github.io/isorite/
 
 Source, and what is on disk: https://github.com/lachlanjs/isorite

package/dist/core.js

@@ -511,6 +511,8 @@ function outwardLinks(body) {
 }
 //#endregion
 //#region packages/core/src/bundle.ts
+/** The base's own instructions, for Iso and any other agent, at the top of the notes (M15). Not a note. */
+const AGENTS_FILE = "AGENTS.md";
 const OKF_VERSION = "0.2";
 const ARTIFACT = /\.html?$/i;
 const IMAGE = /\.(png|jpe?g|gif|svg|webp|avif)$/i;
@@ -668,7 +670,7 @@ var Bundle = class Bundle {
 				this.ensureDir(rel);
 				continue;
 			}
-			if (!rel.endsWith(".md")) {
+			if (!rel.endsWith(".md") || rel === "AGENTS.md") {
 				this.files.add(rel);
 				continue;
 			}
@@ -2214,4 +2216,4 @@ function ago(at, now = Date.now()) {
 /** A moment is named by its last entry: the one the note is shown at. */
 const momentKey = (m) => m.ids.at(-1);
 //#endregion
-export { ABOUT, Bundle, CONFIG_FILE, Concept, DEVICE_RE, DONE, DiffError, Directory, FrontmatterError, GITATTRIBUTES, ID_RE, KINDS, LearnerError, MAX_EVENT_BYTES, OKF_VERSION, OWN_DIR, OWN_FORMAT, RATINGS, SESSION_GAP_MS, SETTINGS_FILE, SNAPSHOT_EVERY, STRENGTH, STUDY_DIR, STUDY_FORMAT, SearchIndex, StudyError, agentName, ago, anchorOf, applyHunks, authors, blocks, change, citeKind, cleanEvent, cmp, cmpTuple, codeTarget, contentHash, describe, diffLines, doneOf, dumpFrontmatter, editFrontmatter, embedFor, embedRefs, findAnchor, findPassage, floatRepr, frontmatterText, hashText, headings, idsOf, impliedLinks, insertAt, iso, journalLine, journalPath, kindOf, legacyId, linkRefs, linkTexts, locate, mapModel, mergeRecords, momentKey, moments, newId, noteIds, outwardLinks, pagerank, parseSettings, parseStudyConfig, parseYaml, passageOf, pending, pyRepr, rating, reach, readJournal, readRecord, reconcile, recordPath, replay, round3, section, sessionMoments, settingsText, sha256, slugify, snippet, spliceText, splitFrontmatter, splitSource, stamp, strengthEdges, strip, stronglyConnected, text, textAt, toTime, tokenize, touched, wordAuthors, written };
+export { ABOUT, AGENTS_FILE, Bundle, CONFIG_FILE, Concept, DEVICE_RE, DONE, DiffError, Directory, FrontmatterError, GITATTRIBUTES, ID_RE, KINDS, LearnerError, MAX_EVENT_BYTES, OKF_VERSION, OWN_DIR, OWN_FORMAT, RATINGS, SESSION_GAP_MS, SETTINGS_FILE, SNAPSHOT_EVERY, STRENGTH, STUDY_DIR, STUDY_FORMAT, SearchIndex, StudyError, agentName, ago, anchorOf, applyHunks, authors, blocks, change, citeKind, cleanEvent, cmp, cmpTuple, codeTarget, contentHash, describe, diffLines, doneOf, dumpFrontmatter, editFrontmatter, embedFor, embedRefs, findAnchor, findPassage, floatRepr, frontmatterText, hashText, headings, idsOf, impliedLinks, insertAt, iso, journalLine, journalPath, kindOf, legacyId, linkRefs, linkTexts, locate, mapModel, mergeRecords, momentKey, moments, newId, noteIds, outwardLinks, pagerank, parseSettings, parseStudyConfig, parseYaml, passageOf, pending, pyRepr, rating, reach, readJournal, readRecord, reconcile, recordPath, replay, round3, section, sessionMoments, settingsText, sha256, slugify, snippet, spliceText, splitFrontmatter, splitSource, stamp, strengthEdges, strip, stronglyConnected, text, textAt, toTime, tokenize, touched, wordAuthors, written };