bdy 1.22.96-dev → 1.22.97-dev

package/distTs/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bdy",
   "preferGlobal": false,
-  "version": "1.22.96-dev",
+  "version": "1.22.97-dev",
   "type": "commonjs",
   "license": "MIT",
   "homepage": "https://buddy.works/docs/cli",

package/distTs/src/command/agent/install.js

@@ -79,6 +79,8 @@ const installService = async (options) => {
     const target = !!options.target;
     const tunneling = !!options.tunnels;
     const proxy = !!options.proxy;
+    const note = options.note;
+    const agentNote = options.agentNote;
     let agent;
     if (id) {
         try {
@@ -90,7 +92,10 @@ const installService = async (options) => {
     }
     if (!agent) {
         const tags = prepareTags(options.tag);
-        agent = await ApiBuddy.register(true, target, tunneling, proxy, host, token, tags, (0, utils_1.getServiceUser)(options.user, options.pass), (region) => {
+        agent = await ApiBuddy.register(true, target, tunneling, proxy, host, token, tags, (0, utils_1.getServiceUser)(options.user, options.pass), {
+            note,
+            agentNote,
+        }, (region) => {
             cfg_1.default.setRegionIfNotSet(region);
         });
         id = agent.id;
@@ -156,9 +161,14 @@ const installApp = async (options) => {
     const { token, host } = await input_1.default.tunnelToken(addToken);
     if (!id) {
         const tags = prepareTags(options.tag);
+        const note = options.note;
+        const agentNote = options.agentNote;
         try {
             output_1.default.normal(texts_1.TXT_AGENT_STANDALONE_AGENT_REGISTERING, false);
-            const agent = await ApiBuddy.register(true, !!options.target, !!options.tunnels, !!options.proxy, host, token, tags, (0, utils_1.getCurrentUser)(), (region) => {
+            const agent = await ApiBuddy.register(true, !!options.target, !!options.tunnels, !!options.proxy, host, token, tags, (0, utils_1.getCurrentUser)(), {
+                note,
+                agentNote,
+            }, (region) => {
                 cfg_1.default.setRegionIfNotSet(region);
             });
             logger_1.default.info(texts_1.TXT_AGENT_STANDALONE_AGENT_REGISTERED);
@@ -220,6 +230,8 @@ commandAgentInstall.option('--proxy', texts_1.OPTION_AGENT_PROXY);
 commandAgentInstall.option('--no-tunnels', texts_1.OPTION_AGENT_TUNNELING);
 commandAgentInstall.option('--tag <tag...>', texts_1.OPTION_AGENT_TAG);
 commandAgentInstall.option('-d, --debug', texts_1.OPTION_AGENT_DEBUG);
+commandAgentInstall.option('--note <note>', texts_1.OPT_COMMAND_NOTE);
+commandAgentInstall.option('--agent-note <note>', texts_1.OPT_COMMAND_AGENT_NOTE);
 commandAgentInstall.action(async (options) => {
     const AgentManager = require('../../agent/manager').default;
     options.start = options.start === 'true' || options.start === true;

package/distTs/src/command/tunnel/http.js

@@ -20,7 +20,7 @@ commandHttp.action(async (target, options) => {
     const { host, token } = await Input.tunnelToken(options.token);
     const prepared = await Cfg.prepareTunnel(tunnel_1.TUNNEL_TYPE.HTTP, target, options, true);
     await output_1.default.spinner(texts_1.TXT_OPENING_TUNNEL);
-    const agent = await ApiBuddy.register(false, false, true, false, host, token, [], (0, utils_1.getCurrentUser)(), (region) => {
+    const agent = await ApiBuddy.register(false, false, true, false, host, token, [], (0, utils_1.getCurrentUser)(), {}, (region) => {
         Cfg.setRegionIfNotSet(region);
     });
     await agent.start();

package/distTs/src/command/tunnel/start.js

@@ -20,7 +20,7 @@ commandStart.action(async (name, options) => {
     const { token, host } = await Input.tunnelToken(options.token);
     const prepared = Cfg.getTunnel(name);
     await output_1.default.spinner(texts_1.TXT_OPENING_TUNNEL);
-    const agent = await ApiBuddy.register(false, false, true, false, host, token, [], (0, utils_1.getCurrentUser)(), (region) => {
+    const agent = await ApiBuddy.register(false, false, true, false, host, token, [], (0, utils_1.getCurrentUser)(), {}, (region) => {
         Cfg.setRegionIfNotSet(region);
     });
     await agent.start();

package/distTs/src/command/tunnel/tcp.js

@@ -19,7 +19,7 @@ commandTcp.action(async (target, options) => {
     const { host, token } = await Input.tunnelToken(options.token);
     const prepared = await Cfg.prepareTunnel(tunnel_1.TUNNEL_TYPE.TCP, target, options, true);
     await output_1.default.spinner(texts_1.TXT_OPENING_TUNNEL);
-    const agent = await ApiBuddy.register(false, false, true, false, host, token, [], (0, utils_1.getCurrentUser)(), (region) => {
+    const agent = await ApiBuddy.register(false, false, true, false, host, token, [], (0, utils_1.getCurrentUser)(), {}, (region) => {
         Cfg.setRegionIfNotSet(region);
     });
     await agent.start();

package/distTs/src/command/tunnel/tls.js

@@ -19,7 +19,7 @@ commandTls.action(async (target, options) => {
     const { token, host } = await Input.tunnelToken(options.token);
     const prepared = await Cfg.prepareTunnel(tunnel_1.TUNNEL_TYPE.TLS, target, options, true);
     await output_1.default.spinner(texts_1.TXT_OPENING_TUNNEL);
-    const agent = await ApiBuddy.register(false, false, true, false, host, token, [], (0, utils_1.getCurrentUser)(), (region) => {
+    const agent = await ApiBuddy.register(false, false, true, false, host, token, [], (0, utils_1.getCurrentUser)(), {}, (region) => {
         Cfg.setRegionIfNotSet(region);
     });
     await agent.start();

package/distTs/src/format.js

@@ -86,6 +86,19 @@ class Format {
             return 'Not set';
         return host;
     }
+    static note(note) {
+        if (!note)
+            return 'Not set';
+        return this.noteInline(note);
+    }
+    /**
+     * Notes are free text and may contain newlines. Every place we render one
+     * sits on a single line — a log entry or a fixed-height terminal row — so
+     * collapse whitespace runs before display.
+     */
+    static noteInline(note) {
+        return note.replace(/\s+/g, ' ').trim();
+    }
     static basicAuth(login, pass) {
         if (!login || !pass)
             return 'Not set';

package/distTs/src/output.js

@@ -204,7 +204,12 @@ class Output {
         }
     }
     static async spinner(txt) {
-        if (!this.s && this.isStdOutTTY()) {
+        // Both streams must be a TTY, not just stdout: terminal-kit's inline
+        // spinner awaits a cursor-position reply read from stdin, so with stdout on
+        // a terminal but stdin redirected (e.g. `bdy tunnel http 3000 < /dev/null`)
+        // that reply can never arrive. A spinner is interactive-session animation
+        // anyway, so requiring both is also the correct predicate.
+        if (!this.s && this.isTTY()) {
             this.s = await getTerminal().spinner();
             if (txt)
                 getTerminal()(` ${txt}`);

package/distTs/src/texts.js

@@ -412,7 +412,7 @@ exports.OPTION_ARTIFACT_ID = 'Human-readable ID of the artifact and optionally v
 exports.OPTION_ARTIFACT_PUBLISH_CREATE = 'Create artifact if not exists';
 exports.OPTION_ARTIFACT_VERSION_FROM = 'Version to copy content from';
 exports.OPTION_ARTIFACT_VERSION_NOTE = 'Note of the artifact version';
-exports.OPTION_ARTIFACT_VERSION_AGENT_NOTE = 'YAML note of the artifact version for AI agents';
+exports.OPTION_ARTIFACT_VERSION_AGENT_NOTE = 'Note of the artifact version for AI agents';
 exports.OPTION_ARTIFACT_PUBLISH_OVERWRITE_VERSION = 'Allow overwriting existing version';
 exports.OPTION_ARTIFACT_DOWNLOAD_MERGE = 'Merge contents of the directory with artifact';
 exports.OPTION_ARTIFACT_DOWNLOAD_REPLACE = 'Replace contents of the directory with artifact';
@@ -634,7 +634,7 @@ exports.DESC_COMMAND_SANDBOX_APP = 'Manage sandbox apps';
 exports.OPTION_SANDBOX_IDENTIFIER = 'Sandbox identifier';
 exports.OPTION_SANDBOX_NAME = 'Sandbox display name';
 exports.OPTION_SANDBOX_NOTE = 'Sandbox note';
-exports.OPTION_SANDBOX_AGENT_NOTE = 'Sandbox YAML note for AI agents';
+exports.OPTION_SANDBOX_AGENT_NOTE = 'Sandbox note for AI agents';
 exports.OPTION_SANDBOX_OS = `Operating system image (ubuntu:24.04 (default), ubuntu:22.04)`;
 exports.OPTION_SANDBOX_RESOURCES = 'Resource allocation: 1x2, 2x4, 4x8, 8x16, 12x24 (CPUxRAM)';
 exports.OPTION_SANDBOX_INSTALL_COMMANDS = 'Setup commands to run on creation (can be used multiple times)';
@@ -954,7 +954,7 @@ exports.DESC_COMMAND_ROUTE_DELETE = 'Delete route. Required scopes: DISTRIBUTION
 exports.DESC_COMMAND_ROUTE_UPDATE = 'Update route. Required scopes: DISTRIBUTION_MANAGE';
 exports.DESC_COMMAND_ROUTE = 'Manage distribution routes';
 exports.OPT_COMMAND_NOTE = 'Resource note';
-exports.OPT_COMMAND_AGENT_NOTE = 'YAML note for AI agents operating on this resource';
+exports.OPT_COMMAND_AGENT_NOTE = 'Note for AI agents operating on this resource';
 exports.OPT_COMMAND_SCOPE = 'Force scope (WORKSPACE, PROJECT). By default calculated by provided options and environmental variables (--project, BUDDY_PROJECT, linked project)';
 exports.OPT_COMMAND_DISTRO_IDENTIFIER = 'Human-readable ID of the distribution';
 exports.OPT_COMMAND_ROUTE_ID = 'ID of the route (find via "bdy distro route ls")';
@@ -963,7 +963,7 @@ exports.OPT_COMMAND_ROUTE_SUBDOMAIN = 'Optional sub-name prepended to --domain (
 exports.OPT_COMMAND_ROUTE_DOMAIN = 'Zone for the route — pass the WHOLE string from `bdy domain ls` (e.g. "example.com" or "my-app.example.dev"). Do NOT split a multi-level zone into subdomain+domain; the entire bought/claimed string is one zone and goes here as-is. Use --subdomain only to route a sub-name within this zone';
 exports.OPT_COMMAND_ROUTE_PATH = 'Path of the route';
 exports.OPT_COMMAND_ROUTE_NOTE = 'Note of the route';
-exports.OPT_COMMAND_ROUTE_AGENT_NOTE = 'YAML note of the route for AI agents';
+exports.OPT_COMMAND_ROUTE_AGENT_NOTE = 'Note of the route for AI agents';
 exports.OPT_COMMAND_ROUTE_TARGET = `Target of the route (can be used multiple times).
 Format: "region=default,url=https://example.com,artifact=artifact:version,sandbox=sandbox:endpoint"
 To use "," in value use \\,
@@ -974,7 +974,7 @@ Region can be Default, NorthAmerica, Europe, Asia, Oceania, SouthAmerica, Africa
 If no region is specified or default is used, the target is used as the fallback for all locations. Default region is mandatory`;
 exports.OPT_COMMAND_DISTRO_NAME = 'Name of the distribution';
 exports.OPT_COMMAND_DISTRO_NOTE = 'Note of the distribution';
-exports.OPT_COMMAND_DISTRO_AGENT_NOTE = 'YAML note of the distribution for AI agents';
+exports.OPT_COMMAND_DISTRO_AGENT_NOTE = 'Note of the distribution for AI agents';
 exports.OPT_COMMAND_DISTRO_ENABLE = 'Enable the distribution';
 exports.OPT_COMMAND_DISTRO_DISABLE = 'Disable the distribution';
 exports.ERR_COMMAND_SCOPE_NO_PROJECT = 'Project must be provided for PROJECT scope';
@@ -1156,7 +1156,7 @@ exports.EXAMPLE_DISTRO_UPDATE = `
   bdy distro update distro-identifier -n "new name"
   ### set note (pass an empty value to clear it)
   bdy distro update distro-identifier --note "owned by team web"
-  ### set the YAML note read by AI agents
+  ### set the note read by AI agents
   bdy distro update distro-identifier --agent-note "deploy: manual-approval-required"
   ### disable distribution
   bdy distro update distro-identifier --disable`;

package/distTs/src/tunnel/api/buddy.js

@@ -49,12 +49,12 @@ const makeRequest = async (host, path, body, method = 'POST', respAsJson = true,
     }
 };
 class ApiBuddyClass {
-    async register(service, target, tunneling, proxy, host, token, tags, user, onDefaultRegion) {
+    async register(service, target, tunneling, proxy, host, token, tags, user, options, onDefaultRegion) {
         const version = (0, utils_1.getVersion)();
         const hostname = (0, utils_1.getHostname)();
         const platform = (0, utils_1.getPlatform)();
         logger_1.default.info(texts_1.LOG_REGISTERING_AGENT);
-        const r = await makeRequest(host, '/tunnel/agent/add', {
+        const data = {
             token,
             version,
             hostname,
@@ -64,8 +64,17 @@ class ApiBuddyClass {
             user,
             target,
             tunneling,
-            proxy
-        });
+            proxy,
+            note: '',
+            agentNote: ''
+        };
+        if (options) {
+            if (options.note)
+                data.note = options.note;
+            if (options.agentNote)
+                data.agentNote = options.agentNote;
+        }
+        const r = await makeRequest(host, '/tunnel/agent/add', data);
         logger_1.default.info((0, texts_1.LOG_AGENT_REGISTERED)(r.id));
         logger_1.default.info((0, texts_1.LOG_REGION_DETECTED)(r.region));
         if (onDefaultRegion)

package/distTs/src/tunnel/cfg.js

@@ -73,6 +73,12 @@ class Cfg {
             type,
             target: Input.target(target, type),
         };
+        if (options.note !== undefined) {
+            tunnel.note = options.note;
+        }
+        if (options.agentNote !== undefined) {
+            tunnel.agentNote = options.agentNote;
+        }
         if (options.region !== undefined)
             tunnel.region = Input.region(options.region);
         else if (useDefaults)

package/distTs/src/tunnel/config.js

@@ -38,13 +38,15 @@ class TunnelConfig {
     sshUser;
     sshPassword;
     sshForwardPort;
+    note;
+    agentNote;
     sshClientUser;
     sshClientPassword;
     targetProto;
     targetHost;
     targetPort;
     targetAuth;
-    constructor({ type, target, region, timeout, domain, subdomain, name, whitelist, tlsSettings, httpSettings, sshSettings, }) {
+    constructor({ type, target, region, timeout, domain, subdomain, name, whitelist, tlsSettings, httpSettings, sshSettings, resourceNote, }) {
         this.type = type;
         this.region = region;
         this.target = target;
@@ -56,6 +58,8 @@ class TunnelConfig {
         this.useragents = [];
         this.headers = [];
         this.responseHeaders = [];
+        this.note = resourceNote?.note;
+        this.agentNote = resourceNote?.agentNote;
         if (tlsSettings) {
             this.terminate = tlsSettings.terminate;
             this.key = tlsSettings.key;

package/distTs/src/tunnel/output/interactive/tunnel.js

@@ -67,6 +67,7 @@ class OutputInteractiveTunnel {
         y += this.updateSpriteDns(y);
         y += this.updateSpriteType(y);
         y += this.updateSpriteRegion(y);
+        y += this.updateSpriteNote(y);
         y += this.updateSpriteTarget(y);
         y += this.updateSpriteIdentify(y);
         y += this.updateSpriteTerminate(y);
@@ -554,6 +555,13 @@ class OutputInteractiveTunnel {
             },
         }, fillString('Region:', ROW_LENGTH));
     }
+    createSpriteNote() {
+        this.sprites.note = termkit_no_lazy_require_1.default.ScreenBuffer.createFromString({
+            attr: {
+                color: COLOR_LIGHT_GRAY,
+            },
+        }, fillString('Note:', ROW_LENGTH));
+    }
     createSpriteIdentify() {
         this.sprites.identify = termkit_no_lazy_require_1.default.ScreenBuffer.createFromString({
             attr: {
@@ -704,6 +712,22 @@ class OutputInteractiveTunnel {
         });
         return this.sprites.region.height;
     }
+    updateSpriteNote(y) {
+        if (!this.tunnel.note)
+            return 0;
+        this.sprites.note.put({
+            x: COLUMN_LENGTH,
+            y: 0,
+            attr: {
+                color: COLOR_WHITE,
+            },
+        }, fillString(format_1.default.noteInline(this.tunnel.note), ROW_LENGTH - COLUMN_LENGTH));
+        this.sprites.note.draw({
+            dst: this.viewPort,
+            y,
+        });
+        return this.sprites.note.height;
+    }
     updateSpriteTerminate(y) {
         if (this.tunnel.type === tunnel_1.TUNNEL_TYPE.TLS) {
             this.sprites.terminate.put({
@@ -820,6 +844,7 @@ class OutputInteractiveTunnel {
         this.createSpriteType();
         this.createSpriteDns();
         this.createSpriteRegion();
+        this.createSpriteNote();
         this.createSpriteTarget();
         this.createSpriteIdentify();
         this.createSpriteTerminate();

package/distTs/src/tunnel/output/noninteractive/config/tunnel.js

@@ -26,6 +26,8 @@ class OutputNoninteractiveConfigTunnel {
                 format_1.default.target(this.tunnel.type, this.tunnel.target),
             ]);
         }
+        data.push(['Note', format_1.default.note(this.tunnel.note)]);
+        data.push(['Agent Note', format_1.default.note(this.tunnel.agentNote)]);
         data.push(['Region', format_1.default.tunnelRegion(this.tunnel.region)]);
         data.push(['Timeout', format_1.default.tunnelTimeout(this.tunnel.timeout)]);
         data.push(['Whitelist', format_1.default.tunnelWhitelist(this.tunnel.whitelist)]);

package/distTs/src/tunnel/output/noninteractive/tunnel.js

@@ -17,7 +17,11 @@ class OutputNoninteractiveTunnel {
         this.terminal(`${format_1.default.date()}: Tunnel ${t.type} to ${t.serve || t.target} ${status}\n`);
     }
     onOpen(t) {
-        this.status(t, `open. Entry: ${format_1.default.entry(t)}`);
+        // Appended after the entry URL, so a consumer scraping the URL out of this
+        // line still terminates it on whitespace. Omitted entirely when unset to
+        // keep the common line unchanged.
+        const note = t.note ? ` Note: ${format_1.default.noteInline(t.note)}` : '';
+        this.status(t, `open. Entry: ${format_1.default.entry(t)}${note}`);
     }
     onClosed(t) {
         this.status(t, 'closed');
@@ -57,6 +61,14 @@ class OutputNoninteractiveTunnel {
         this.tunnel.on(tunnel_1.TUNNEL_EVENT.HTTP_REQUEST, (t, logRequest) => this.onHttpRequest(t, logRequest));
         this.tunnel.on(tunnel_1.TUNNEL_EVENT.HTTP_RESPONSE, (t, logRequest) => this.onHttpResponse(t, logRequest));
         this.tunnel.on(tunnel_1.TUNNEL_EVENT.STOPPED, () => this.onStopped());
+        // This renderer is otherwise purely event-driven, so a tunnel handed to it
+        // already open — `agent tunnel status <id>` attaches to a live one — has
+        // already missed its OPEN event and would print nothing at all. Dump the
+        // current state once, the way the interactive dashboard's first draw does.
+        // Tunnels we open ourselves are not yet OPEN at this point, so they still
+        // print exactly once, from the event.
+        if (this.tunnel.status === tunnel_1.TUNNEL_STATUS.OPEN)
+            this.onOpen(this.tunnel);
     }
 }
 exports.default = OutputNoninteractiveTunnel;

package/distTs/src/tunnel/tunnel.js

@@ -97,6 +97,9 @@ class Tunnel extends events_1.default {
     get target() {
         return this.config.target;
     }
+    get note() {
+        return this.config.note;
+    }
     get whitelist() {
         return this.config.whitelist;
     }

package/distTs/src/utils.js

@@ -543,6 +543,8 @@ const getBasicCommandTcp = () => {
     commandTcp.option('-w, --whitelist <cidrs...>', texts_1.OPTION_WHITELIST);
     commandTcp.option('-n, --name <name>', texts_1.OPTION_NAME);
     commandTcp.option('-t, --timeout <seconds>', texts_1.OPTION_TIMEOUT);
+    commandTcp.option('--note <note>', texts_1.OPT_COMMAND_NOTE);
+    commandTcp.option('--agent-note <note>', texts_1.OPT_COMMAND_AGENT_NOTE);
     return commandTcp;
 };
 exports.getBasicCommandTcp = getBasicCommandTcp;
@@ -594,6 +596,8 @@ const getBasicCommandHttp = () => {
     commandHttp.option('-2, --http2', texts_1.OPTION_HTTP_2);
     commandHttp.option('-c, --compression', texts_1.OPTION_HTTP_COMPRESSION);
     commandHttp.option('--ca <ca>', texts_1.OPTION_TLS_CA);
+    commandHttp.option('--note <note>', texts_1.OPT_COMMAND_NOTE);
+    commandHttp.option('--agent-note <note>', texts_1.OPT_COMMAND_AGENT_NOTE);
     commandHttp.option('--circuit-breaker <threshold>', texts_1.OPTION_HTTP_CIRCUIT_BREAKER);
     return commandHttp;
 };
@@ -609,6 +613,8 @@ const getBasicCommandTls = () => {
     commandTls.option('-c, --cert <cert>', texts_1.OPTION_TLS_CERT);
     commandTls.option('--ca <ca>', texts_1.OPTION_TLS_CA);
     commandTls.option('-i, --terminate <at>', texts_1.OPTION_TLS_TERMINATE);
+    commandTls.option('--note <note>', texts_1.OPT_COMMAND_NOTE);
+    commandTls.option('--agent-note <note>', texts_1.OPT_COMMAND_AGENT_NOTE);
     return commandTls;
 };
 exports.getBasicCommandTls = getBasicCommandTls;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bdy",
   "preferGlobal": false,
-  "version": "1.22.96-dev",
+  "version": "1.22.97-dev",
   "type": "commonjs",
   "license": "MIT",
   "homepage": "https://buddy.works/docs/cli",