import type { Command, Help } from "commander"; /** * Three groups, the way gh and fly group theirs: the one thing a new person * runs, the few things they run afterwards, and everything else behind one * line. A person meeting Relay should read three rows, not sixty-three. */ export declare const HELP_GROUPS: { readonly getStarted: "Get started:"; readonly everyDay: "Every day:"; readonly everythingElse: "Everything else:"; /** Reachable, described, and named nowhere in the help: an older name kept * working for the scripts that already use it. */ readonly unlisted: ""; }; export declare const DOCS_URL = "https://docs.relayapp.im"; export declare const STAGING_DOCS_URL = "https://docs.staging.relayapp.im"; export declare const ISSUES_URL = "https://github.com/RelayMessenger/Relay-SDK/issues"; /** * The docs for the Relay this CLI talks to. `RELAY_API_URL` names the * environment when it points at a Relay host, the way it overrides the API * (config.ts `resolveAuth`); otherwise a `-staging` build means staging, the * rule `defaultCreationApiURL` and the hosted MCP address already follow. */ export declare const docsURL: (env?: NodeJS.ProcessEnv, version?: string) => string; /** * The last line of every help screen: where to read more and where to report * a problem (GNU Coding Standards 4.8.2; gh closes with "Read the manual at * https://cli.github.com/manual", ledger captures/tools/gh.help.plain:68-71; * ledger rows P06, P07, P37). The text is the decision page's last block. */ export declare const docsLine: (env?: NodeJS.ProcessEnv, version?: string) => string; /** clig.dev "Lead with examples"; gh, flyctl and codex do (ledger row P08). Three, from the decision page. */ export declare const EXAMPLES: string[]; export interface CommandRow { /** Space-separated path, for example `chats messages send`. */ path: string; description: string; } /** Every command under this one, at any depth, with the description it shows. */ export declare const commandRows: (command: Command, path?: readonly string[]) => CommandRow[]; export interface FlagRow { /** The command path, then the flags or the argument name. */ path: string; description: string; } /** Every option and argument in the tree, hidden ones included, with its description. */ export declare const flagRows: (command: Command, path?: readonly string[]) => FlagRow[]; /** * The rest of "Everything else": the names on one line. Built from the program * itself, so a command added later cannot fall out of the help by being * forgotten here. */ export declare const everythingElseNames: (program: Command) => string; /** * The help layout the decision page shows, and gh's: usage, the purpose, * examples, the commands, then the options (commander's default puts options * first). Nothing wraps: gh and stripe print each row on one line whatever the * terminal width, and the page's rows run past 80 columns. */ export declare const formatRelayHelp: (cmd: Command, helper: Help, heading?: string) => string; /** What follows the built-in help on every screen; the root also states the environment rule first. */ export declare const helpFooter: (_root: boolean, env?: NodeJS.ProcessEnv, version?: string) => string; //# sourceMappingURL=help-groups.d.ts.map