@mercury-fw/cli 0.28.2 → 0.28.3

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @mercury-fw/cli
 
+## 0.28.3
+
+### Patch Changes
+
+- 5175e10: An app created with the HTTP channel publishes the surface's port on the host (`HTTP_SURFACE_PORT`, 4100 when unset), so it's reachable from outside the container; its README says where it listens and that it has no authentication.
+  - @mercury-fw/core@0.28.3
+
 ## 0.28.2
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mercury-fw/cli",
-  "version": "0.28.2",
+  "version": "0.28.3",
   "type": "module",
   "license": "MIT",
   "repository": {
@@ -36,13 +36,13 @@
   "comment:shape": "The Mercury CLI (`mfw`). `mfw create <dir>` writes a new Mercury app from the template. The framework packages move in lockstep with it, so a new app gets them at the CLI's own version; plugins and channels at the registry's latest. The plugin and channel packages are devDependencies only for the catalog test. `main(argv)` is exported for create-mercury-agent.",
   "dependencies": {
     "@clack/prompts": "^1.8.1",
-    "@mercury-fw/core": "0.28.2",
+    "@mercury-fw/core": "0.28.3",
     "commander": "^15.0.0"
   },
   "devDependencies": {
     "@mercury-fw/channel-google-chat": "0.1.2",
     "@mercury-fw/channel-http": "0.1.0",
-    "@mercury-fw/formatter": "0.28.2",
+    "@mercury-fw/formatter": "0.28.3",
     "@mercury-fw/plugin-atlassian-admin": "0.1.0",
     "@mercury-fw/plugin-bitbucket": "0.1.0",
     "@mercury-fw/plugin-jira": "0.1.1",

package/src/render.ts

@@ -70,7 +70,7 @@ export function renderApp(input: RenderInput): Map<string, string> {
     [".gitignore", gitignore],
     ["Dockerfile", renderDockerfile(tools)],
     ["README.md", renderReadme(input.name, channels, tools)],
-    ["docker-compose.yml", renderCompose(input.name, tools.length > 0)],
+    ["docker-compose.yml", renderCompose(input.name, tools.length > 0, channels.some((c) => c.id === "http"))],
     ["markdown.d.ts", markdownDts],
     ["mercury.config.ts", renderConfig(channels, tools)],
     ["package.json", renderPackageJson(input.name, channels, tools, input.versions)],
@@ -318,8 +318,9 @@ function renderEnv(channels: CatalogEntry[], tools: CatalogEntry[]): string {
 }
 
 /** `docker-compose.yml`: the app and Qdrant, with named volumes prefixed by the
- * app's name; the CLI credentials volume only when a tool plugin was chosen. */
-function renderCompose(name: string, hasTools: boolean): string {
+ * app's name; the CLI credentials volume only when a tool plugin was chosen,
+ * the HTTP surface's port published on the host only with the HTTP channel. */
+function renderCompose(name: string, hasTools: boolean, hasHttp: boolean): string {
   const credentialsMount = hasTools
     ? [
         "      # The tool plugins' CLI credentials, on a volume so what a CLI writes back",
@@ -327,6 +328,13 @@ function renderCompose(name: string, hasTools: boolean): string {
         "      - cli-credentials:/home/mercury/.config",
       ]
     : [];
+  const httpPort = hasHttp
+    ? [
+        "    # The HTTP surface, on the host: no authentication, keep it off the public network.",
+        "    ports:",
+        '      - "${HTTP_SURFACE_PORT:-4100}:${HTTP_SURFACE_PORT:-4100}"',
+      ]
+    : [];
   const credentialsVolume = hasTools ? ["  cli-credentials:", `    name: ${name}_cli-credentials`] : [];
   return [
     "services:",
@@ -340,6 +348,7 @@ function renderCompose(name: string, hasTools: boolean): string {
     "    volumes:",
     "      - wiki-vault:/app/wiki-vault",
     ...credentialsMount,
+    ...httpPort,
     "    extra_hosts:",
     '      - "host.docker.internal:host-gateway"',
     "    depends_on:",
@@ -387,7 +396,18 @@ bunx mfw repl
 \`\`\`
 
 \`bun install\` here gives your editor, \`bun run typecheck\` and \`mfw\` the packages (tool plugins download their CLI binary as they install); the image installs its own copy when it builds. \`bunx mfw start\` builds the image and starts the app with Qdrant in the background, \`bunx mfw repl\` opens a terminal conversation with the assistant. \`bunx mfw --help\` lists the rest: stopping and restarting, logs, a shell in the container, the wiki and the memory, and resetting them.
-${renderCredentialsSection(withCredentials(tools))}`;
+${renderHttpSection(channels)}${renderCredentialsSection(withCredentials(tools))}`;
+}
+
+/** The README section on the HTTP surface, for an app with the HTTP channel;
+ * nothing without it. */
+function renderHttpSection(channels: CatalogEntry[]): string {
+  if (!channels.some((c) => c.id === "http")) return "";
+  return `
+## HTTP surface
+
+The HTTP channel listens on \`http://<host>:4100\`, the port in \`HTTP_SURFACE_PORT\` (the compose file publishes whatever port it holds on the host). It has no authentication: whoever reaches the port can talk to the assistant, so keep it on a network you trust.
+`;
 }
 
 /** The README section on CLI credentials, for an app with tool plugins;