@makerstufferupper/flypi 0.0.0-stage → 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 makerstufferupper
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,45 @@
-# Temporary Holding Version
+# flypi
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A local, multi-model agent tool with a browser UI and a personal knowledge wiki, built on the
+[pi SDK](https://www.npmjs.com/package/@earendil-works/pi-coding-agent) running in-process.
+Everything it reads or writes lives in `.flypi/` — never in `~/.pi`.
+
+![flypi in the browser: a session sidebar, the chat with its model and thinking selectors, and an activity panel](assets/screenshot.png)
+
+## Install
+
+```bash
+npm install -g @makerstufferupper/flypi
+```
+
+Requires Node ≥ 22.19 (24 or newer is recommended, for the built-in `node:sqlite`).
+
+## Run
+
+```bash
+flypi start      # starts the daemon and prints the URL with a per-run token
+flypi status     # what is running, and which version
+flypi logs -f
+flypi stop
+```
+
+The first start downloads two local models (~900 MB) for the memory store — an embedder and a
+contradiction judge. Skip them with `flypi start --embeddings none --judge none`.
+
+## Configure
+
+`.flypi/agent/models.json` names your providers and models, and `.flypi/agent/settings.json` picks
+the default pair. The settings page in the UI edits the same two files. Until you add a provider the
+UI comes up normally and the model turn says out loud that no default is set.
+
+## What you get
+
+- A chat UI with thinking, tool output, sessions, and image paste.
+- A memory wiki: every turn is searched against it before the model is asked anything, and the model
+  can write to it over MCP.
+- A daemon with a scheduler, a tool permission gate, and an encrypted secrets vault.
+- Any endpoint pi supports, including local OpenAI-compatible servers.
+
+## License
+
+MIT

package/bin/flypi.mjs

@@ -0,0 +1,28 @@
+#!/usr/bin/env node
+/**
+ * The installed entry point (`bin: flypi`). Its only job is the default state directory: a published app
+ * keeps its `.flypi/` in the home directory, so `npx flypi` from anywhere finds the same memories and the
+ * same vault, instead of one per cwd. `--root DIR` or `FLYPI_ROOT` override it.
+ *
+ * A checkout is unchanged: `scripts/flypi.mjs` still defaults to cwd, which is what `npm run flypi`,
+ * `./start.sh` and the tests rely on. So the two defaults live in two files, deliberately.
+ */
+import { readFileSync } from "node:fs";
+import { homedir } from "node:os";
+import { resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+
+// Checked before anything is imported, so an old Node gets this sentence rather than a tsx stack trace.
+// Read from package.json rather than repeated here: this floor is pi's own, and start.mjs cannot import
+// anything (it runs before npm install), so the two entry points would otherwise drift.
+const pkg = resolve(import.meta.dirname, "..", "package.json");
+const min = /(\d+\.\d+\.\d+)/.exec(JSON.parse(readFileSync(pkg, "utf8")).engines.node)?.[1] ?? "0.0.0";
+const compare = (a, b) => a.split(".").reduce((diff, part, i) => diff || Math.sign(Number(part) - Number(b.split(".")[i] ?? 0)), 0);
+if (compare(process.versions.node, min) < 0) {
+	console.error(`flypi needs Node >= ${min}; this is ${process.versions.node}. Install a newer Node (24+ recommended for node:sqlite).`);
+	process.exit(1);
+}
+
+// `??=` so an explicit FLYPI_ROOT, or `--root`, still wins inside scripts/flypi.mjs.
+process.env.FLYPI_ROOT ??= homedir();
+await import("../scripts/flypi.mjs");