@phreshos/cli 0.1.10 → 0.1.12

package/README.md

@@ -151,8 +151,6 @@ export default defineConfig({
 
     description: "A file manager",
 
-    apiDocs: "api.md",
-
     icon: "icon.png",
 
     buildCommand: "bun run build",
@@ -397,20 +395,11 @@ are the canonical locations the package just created. An explicit
 `start: false` crosses with its half; an omitted value remains omitted
 and means `true`. At least one declared half must resolve to true.
 
-When `apiDocs` is declared, its Markdown file is copied to `api-docs.md` and
-the packaged description names that canonical entry point. A missing declared
-file is an error, not an undocumented Program.
-
-The document covers only what the Program owns: its capabilities, operation
-and event names, payloads, behavior, state, and Program-defined failures. It
-does not explain how to find a Program, obtain an Endpoint, publish or ask, or
-register a subscription. Those are system contracts documented once by the
-SDKs; `api-docs.md` supplies only the Program-specific meaning carried through
-them.
-
 There is **no wrapping directory**: `program.json`, `server/`, `client/`,
-optional `icon.png`, and optional `api-docs.md` sit at the package's root, and the system names the
-directory it installs into from your program's `identity`.
+and optional `icon.png` sit at the package's root, and the system names the
+directory it installs into from your program's `identity`. Service API
+documentation belongs to the live service that exposes it and is therefore
+not part of the Program package.
 
 Nothing about the system moves because this exists. `program.json` is
 still the only thing the system reads, and a package assembled by hand

package/dist/build-template.js

@@ -6,8 +6,8 @@ import AdmZip from "adm-zip";
 import { readConfig } from "./project.js";
 const repository = "PhreshOS/phresh-program";
 const release = {
-    version: "0.1.1",
-    sha256: "9e29d6c04435f4095a4e03410e77bc0f3d25ac6658316f2d14558b935b10a36c"
+    version: "0.1.2",
+    sha256: "dba5f1fd868c46501d5bd3463f4f8f0e098c7a231cb75794c01118689dc69339"
 };
 const archiveUrl = `https://github.com/${repository}/archive/refs/tags/v${release.version}.zip`;
 const output = resolve(import.meta.dirname, "template");

package/dist/cli.js

@@ -46,7 +46,6 @@ describe(program.command("create")
 describe(program.command("init")
     .description("initialize an existing Program project")
     .option("--name <name>", "human-readable Program name")
-    .option("--api-docs <path>", "official Program API documentation")
     .option("--build-command <command>", "prepare production files before use")
     .option("--server", "include a Server endpoint")
     .option("--server-location <path>", "production Server directory")
@@ -60,7 +59,6 @@ describe(program.command("init")
     .action(async function (options) {
     await init({
         name: options.name,
-        apiDocs: options.apiDocs,
         buildCommand: options.buildCommand,
         server: options.server === true || options.serverLocation !== undefined || options.serverStartCommand !== undefined,
         serverLocation: options.serverLocation,

package/dist/derive.js

@@ -27,11 +27,6 @@ export default function derive(config, directory, which) {
         name: config.name,
         version: config.version,
         description: config.description,
-        // Like the icon, the document stays where the author put it for an
-        // attached run. Installation and packaging give it its canonical
-        // name; the runtime receives an absolute source path here because a
-        // derived description has no file beside which to resolve it.
-        apiDocs: config.apiDocs && resolve(directory, config.apiDocs),
         // Where it already is. Unlike pack, which gives it its canonical
         // name, this points into the authoring tree and leaves it alone.
         icon: config.icon && resolve(directory, config.icon),

package/dist/init.js

@@ -47,15 +47,6 @@ export default async function init(options = {}, directory = process.cwd(), core
     const name = options.name ?? (interactive ? await ask("This name is shown to people; the package name remains the Program identity.", "What name should people see?", manifest.name) : undefined);
     if (name !== undefined && name.trim().length === 0)
         throw new Error("--name must not be empty");
-    let apiDocs = options.apiDocs;
-    if (interactive && apiDocs === undefined) {
-        const suggested = ["api-docs.md", "README.md"].find(file => existsSync(resolve(directory, file)));
-        if (await yes("API documentation explains only the services this Program itself provides.", "Does this Program provide API documentation?", false)) {
-            apiDocs = await ask("The path is resolved from the project root and becomes the official API entry point.", "Where is the API documentation file?", suggested);
-        }
-    }
-    if (apiDocs !== undefined && apiDocs.trim().length === 0)
-        throw new Error("An API documentation path must not be empty");
     let buildCommand = options.buildCommand;
     if (interactive && buildCommand === undefined) {
         const suggested = manifest.scripts?.build && projectScript(directory, manifest.packageManager, "build");
@@ -118,7 +109,6 @@ export default async function init(options = {}, directory = process.cwd(), core
         name,
         version: manifest.version,
         description: manifest.description,
-        apiDocs,
         buildCommand
     };
     const config = server
@@ -147,7 +137,6 @@ function compose(config) {
         field("name", config.name),
         field("version", config.version),
         field("description", config.description),
-        field("apiDocs", config.apiDocs),
         field("buildCommand", config.buildCommand),
         half("server", config.server && {
             location: config.server.location,

package/dist/pack.js

@@ -44,8 +44,6 @@ export default async function pack(directory = process.cwd()) {
     }
     if (config.icon)
         file(zip, directory, config.icon, "icon.png", "Program icon");
-    if (config.apiDocs)
-        document(zip, directory, config.apiDocs);
     zip.addFile("program.json", Buffer.from(JSON.stringify(program(config, version), null, 4) + "\n"));
     const archive = `${config.identity}@${version ?? "0.0.0"}.zip`;
     const bytes = zip.toBuffer();
@@ -64,7 +62,6 @@ function program(config, version) {
         name: config.name,
         version,
         description: config.description,
-        apiDocs: config.apiDocs ? "api-docs.md" : undefined,
         icon: config.icon ? "icon.png" : undefined,
         ...config.server && { server: { location: "server", start: config.server.start, installCommand: config.server.installCommand, startCommand: config.server.startCommand } },
         ...config.client && { client: { location: "client", start: config.client.start, title: config.client.title, size: config.client.size, position: config.client.position, layer: config.client.layer, minimize: config.client.minimize } }
@@ -78,9 +75,6 @@ function place(zip, directory, location, half) {
         throw new Error(`The ${half} files are not at ${location} — nothing was built there`);
     zip.addLocalFolder(from, half);
 }
-function document(zip, directory, location) {
-    file(zip, directory, location, "api-docs.md", "API documentation file");
-}
 function file(zip, directory, location, target, label) {
     const from = resolve(directory, location);
     if (!existsSync(from) || !statSync(from).isFile())

package/dist/program-release.js

@@ -5,6 +5,10 @@ import { tmpdir } from "node:os";
 import { dirname, isAbsolute, join, relative, resolve } from "node:path";
 import AdmZip from "adm-zip";
 const officialPrograms = {
+    phresh: {
+        identity: "phresh-program",
+        repository: "PhreshOS/phresh-program"
+    },
     setup: {
         identity: "setup",
         repository: "PhreshOS/setup-program"
@@ -95,7 +99,6 @@ async function readProgram(directory, release) {
         throw new Error("A published Program package cannot choose its installed storage");
     return {
         ...value,
-        ...pathField(value, directory, "apiDocs", "api-docs.md"),
         ...pathField(value, directory, "icon", "icon.png"),
         ...half(value, directory, "server"),
         ...half(value, directory, "client")

package/dist/project.js

@@ -43,8 +43,6 @@ function coherent(config) {
         if (config[field] !== undefined && typeof config[field] !== "string")
             throw new Error(`A program's ${field} must be text`);
     }
-    if (config.apiDocs !== undefined && (typeof config.apiDocs !== "string" || config.apiDocs.trim().length === 0))
-        throw new Error("A program's apiDocs must be a non-empty path");
     if (config.buildCommand !== undefined && (typeof config.buildCommand !== "string" || config.buildCommand.trim().length === 0))
         throw new Error("A program's buildCommand must be non-empty text");
     for (const half of ["server", "client"]) {

package/dist/template/package.json

@@ -1,7 +1,7 @@
 {
     "name": "phresh-program",
     "private": true,
-    "version": "0.1.1",
+    "version": "0.1.2",
     "type": "module",
     "scripts": {
         "dev": "phresh dev",
@@ -16,7 +16,7 @@
         "react-dom": "^19.2.8"
     },
     "devDependencies": {
-        "@phreshos/cli": "^0.1.10",
+        "@phreshos/cli": "^0.1.12",
         "@types/node": "^26.2.0",
         "@types/react": "^19.2.18",
         "@types/react-dom": "^19.2.4",

package/dist/template/phresh.config.ts

@@ -22,7 +22,7 @@ export default defineConfig({
     // these values determines the Program's identity.
     name: "Phresh Program",
     description: "A simple counter whose state lives on the Server.",
-    version: "0.1.1",
+    version: "0.1.2",
 
     // Markdown entry point for the API owned by this Program. It documents the
     // counter service contract; PhreshOS endpoint mechanics belong in PhreshOS

package/dist/template.json

@@ -1,5 +1,5 @@
 {
     "repository": "PhreshOS/phresh-program",
-    "version": "0.1.1",
+    "version": "0.1.2",
     "development": true
 }

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@phreshos/cli",
     "type": "module",
-    "version": "0.1.10",
+  "version": "0.1.12",
     "description": "The Phresh command-line interface for Program projects and system management.",
     "engines": {
         "node": ">=20.10"
@@ -47,7 +47,7 @@
     "packageManager": "bun@1.3.14",
     "dependencies": {
         "@clack/prompts": "^1.7.0",
-        "@phreshos/core": "^0.1.1",
+    "@phreshos/core": "^0.1.4",
         "adm-zip": "^0.6.0",
         "commander": "^15.0.0",
         "picocolors": "^1.1.1"