tcmts.cli.run

test/
1 definitions

Types

Context type
What a command that works on the codebase is given: Started, and the codebase, opened (on another branch, read-only, for `--branch`).
Handler type
How a command runs: with the codebase opened (`run`), or before it is (`alone`: the command finds the codebase itself, if it needs one, as `tcm init` and `tcm migrate` must).
Started type
What every command's handler is given (`dispatch` works it out, then calls the command's handler, from `handlers`), before the codebase is opened.

Server

handlers () => Record<"add" | "alias" | "apps" | "at" | "branch" | "build" | "builds" | "changelog" | "check…
Every command's handler, by name (but `tcm mcp`, which `dispatch` runs itself). Each is its own definition, and a run of tcm calls one: a suite counts the handlers it ran, so a change to one command's runs again only the suites that ran it. (A function making the table, as `routes` is: a table of functions written out would count every function in it.) Its type is every command's name: a command without a handler, or a handler without a command, doesn't typecheck.
registryEnv (from: ProcessEnv) => ProcessEnv
The environment `tcm registry` runs the registry's app in: its own, but not the codebase or branch this command was given, stopping with it, and the forge's pages set up from the start as a registry has them: everyone a reader, the server's token one no one has (left unset until a page ran, a call before it found no token, and took the caller for the maintainer).
runAddUpdate ({ cb, rest, scratch, ...cx }: Context) => number
Runs `tcm add` and `tcm update`.
runAlias ({ cb, cmd, rest }: Context) => Promise<number>
Runs `tcm alias`.
runApps ({ cb, cmd, rest }: Context) => number
Runs `tcm apps`.
runAt ({ cb, cmd, rest }: Context) => number
Runs `tcm at`.
runBranch ({ cb, cmd, rest }: Context) => number
Runs `tcm branch`.
runBuild ({ cb, cmd, rest, cwd }: Context) => Promise<number>
Runs `tcm build`.
runBuilds ({ cmd, rest, cwd, kept }: Started) => number
Runs `tcm builds`, without opening the codebase.
runChangelog ({ cb, cmd, rest, cwd }: Context) => number
Runs `tcm changelog`.
runCheck ({ cb, cmd, rest, scratch }: Context) => number
Runs `tcm check`.
runComplete ({ cmd, rest, cwd }: Started) => number
Runs `tcm complete`, without opening the codebase.
runContribute ({ cb, cmd, rest }: Context) => Promise<number>
Runs `tcm contribute`.
runContribution ({ cb, cmd, rest }: Context) => Promise<number>
Runs `tcm contribution`.
runData ({ cb, cmd, rest }: Context) => Promise<number>
Runs `tcm data`.
runDepsDependentsDocs ({ cb, rest, ...cx }: Context) => Promise<number>
Runs `tcm deps`, `tcm dependents` and `tcm docs`.
runDescribe ({ cb, cmd, rest }: Context) => number
Runs `tcm describe`.
runDev ({ cb, cmd, rest }: Context) => Promise<number>
Runs `tcm dev`.
runDiff ({ cb, cmd, rest }: Context) => number
Runs `tcm diff`.
runEdit ({ cb, cmd, rest, scratch }: Context) => Promise<number>
Runs `tcm edit`.
runExport ({ cb, cmd, rest, cwd }: Context) => number
Runs `tcm export`.
runFind ({ cb, cmd, rest }: Context) => Promise<number>
Runs `tcm find`.
runFmt ({ cb, cmd, rest }: Context) => number
Runs `tcm fmt`.
runHistory ({ cb, cmd, rest }: Context) => number
Runs `tcm history`.
runImport ({ cb, cmd, rest }: Context) => number
Runs `tcm import`.
runInit ({ cmd, rest, cwd }: Started) => number
Runs `tcm init`, without opening the codebase.
runJobs ({ cb, cmd, rest }: Context) => number
Runs `tcm jobs`.
runLib ({ cb, cmd, rest }: Context) => Promise<number>
Runs `tcm lib`.
runLint ({ cb, cmd, rest }: Context) => number
Runs `tcm lint`.
runLs ({ cb, cmd, rest }: Context) => number
Runs `tcm ls`.
runLsp ({ cmd, rest }: Started) => number
Runs `tcm lsp`, without opening the codebase.
runMergeSwitch ({ cb, rest, ...cx }: Context) => Promise<number>
Runs `tcm merge` and `tcm switch`.
runMigrate ({ cmd, rest, cwd }: Started) => number
Runs `tcm migrate`, without opening the codebase.
runMirror ({ cb, cmd, rest, cwd }: Context) => number
Runs `tcm mirror`.
runMv ({ cb, cmd, rest }: Context) => Promise<number>
Runs `tcm mv`.
runPack ({ cb, cmd, rest, cwd }: Context) => Promise<number>
Runs `tcm pack`.
runPackages ({ cb, cmd, rest }: Context) => number
Runs `tcm packages`.
runPatch ({ cb, cmd, rest }: Context) => number
Runs `tcm patch`.
runPull ({ cb, cmd, rest }: Context) => Promise<number>
Runs `tcm pull`.
runPush ({ cb, cmd, rest }: Context) => Promise<number>
Runs `tcm push`.
runRegistry ({ cmd, rest, cwd }: Started) => Promise<number>
Runs `tcm registry`, without opening a codebase: the registry tcm ships (`registry`), copied into `--dir` (again when tcm's changes) and run there by `tcm start`, its jobs with it, until it's stopped.
runRelease ({ cb, cmd, rest, cwd }: Context) => Promise<number>
Runs `tcm release`.
runReleases ({ cb, cmd, rest }: Context) => number
Runs `tcm releases`.
runRemote ({ cb, cmd, rest }: Context) => number
Runs `tcm remote`.
runReset ({ cb, cmd, rest }: Context) => Promise<number>
Runs `tcm reset`.
runResolve ({ cb, cmd, rest }: Context) => Promise<number>
Runs `tcm resolve`.
runRevert ({ cb, cmd, rest }: Context) => Promise<number>
Runs `tcm revert`.
runRm ({ cb, cmd, rest }: Context) => Promise<number>
Runs `tcm rm`.
runRun ({ cb, cmd, rest }: Context) => Promise<number>
Runs `tcm run`.
runSearch ({ cb, cmd, rest }: Context) => Promise<number>
Runs `tcm search`.
runServe ({ cb, cmd, rest, cwd }: Context) => number
Runs `tcm serve`.
runStart ({ cb, cmd, rest }: Context) => Promise<number>
Runs `tcm start`.
runStatus ({ cb, cmd, rest, tcmHash }: Context) => number
Runs `tcm status`.
runTest ({ cb, cmd, rest, cwd, kept }: Context) => Promise<number>
Runs `tcm test`.
runTodo ({ cb, cmd, rest }: Context) => number
Runs `tcm todo`.
runUpgrade ({ cb, cmd, rest }: Context) => Promise<number>
Runs `tcm upgrade`.
runUser ({ cb, cmd, rest }: Context) => Promise<number>
Runs `tcm user`.
runVerify ({ cb, cmd, rest }: Context) => number
Runs `tcm verify`.
runView ({ cb, cmd, rest }: Context) => Promise<number>
Runs `tcm view`.
runWatch ({ cb, cmd, rest }: Context) => number
Runs `tcm watch`.