commonHelp

tcmts.cli.commands.commonHelp · #esvktiyi · term · runs anywhere

The descriptions of parameters many commands share (fresh, into, readBranch, …), by name: a command's own help says otherwise for its own.

export const commonHelp: Record<string, string> = {
  fresh: "re-run watch expressions and tests even when their results are cached",
  into: "the namespace to save into (default: the file's `// tcm: namespace` pragma)",
  files: "scratch files (default: the codebase's scratch.ts)",
  branch:
    "read this branch instead (another session's, say), changing nothing: you stay on your own",
  remote: "the remote it's on",
  http: "serve a namespace's functions as HTTP endpoints: <namespace>[=/prefix]",
  port: "port to listen on",
  tls: "serve HTTPS; without --tls-cert, with a self-signed certificate",
  "tls-cert": "certificate file (PEM)",
  "tls-key": "private key file (PEM)",
  id: "its number (see tcm contribution)",
  name: "a name or #hash",
  message:
    "what the history entry is for, kept with it: a line saying what and why, then more after a blank line if it needs it (`tcm describe` changes it later)",
}

used by