helpAnnounce

tcmts.cli.commands.helpAnnounce · #4qhispgl · term · runs anywhere

import type { Help } from "#codebase/tcmts/cli/commands";

export const helpAnnounce: Help = {
  description:
    "list this codebase on the AT Protocol, so registries show it for anyone to browse: a codes.tcm.codebase record in your repository naming where it's served",
  params: {
    url: "the `tcm serve --public` server it's at (kept for next time; default origin's URL)",
    name: "its name: letters, digits, '.', '_' and '-' (kept; default the project directory's name)",
    description: "what it is, in a line or two (300 characters at most; kept)",
    as: "the AT Protocol account to list it as, a handle or DID (signed in in the browser once, then kept; default the last)",
    withdraw: "stop listing it: its record is deleted",
  },
}

uses

used by