Documentation
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
gen-plugin
command
Command gen-plugin writes the Claude plugin's generated files (see internal/generator/plugin) and prints each path it writes.
|
Command gen-plugin writes the Claude plugin's generated files (see internal/generator/plugin) and prints each path it writes. |
|
gen-prompts
command
Command gen-prompts writes the generated prompts in prompts/ (see internal/generator/prompts) and prints each path it writes.
|
Command gen-prompts writes the generated prompts in prompts/ (see internal/generator/prompts) and prints each path it writes. |
|
tollbit
command
|
|
|
internal
|
|
|
client/versionpolicy
Package versionpolicy reads the CLI version policy (minimum supported and latest released version) from Foundry.
|
Package versionpolicy reads the CLI version policy (minimum supported and latest released version) from Foundry. |
|
cliupdate
Package cliupdate keeps the CLI up to date: it checks the server's version policy, tells the user when a newer version exists, and replaces or stops a version below the supported minimum.
|
Package cliupdate keeps the CLI up to date: it checks the server's version policy, tells the user when a newer version exists, and replaces or stops a version below the supported minimum. |
|
doctor
Package doctor checks whether the CLI can run on this machine: that the binary is where the shell finds it, that the CLI can write every directory it uses, and that every host it calls answers through this network.
|
Package doctor checks whether the CLI can run on this machine: that the binary is where the shell finds it, that the CLI can write every directory it uses, and that every host it calls answers through this network. |
|
generator/plugin
Package plugin generates the Claude plugin's files from the CLI: every skill the CLI embeds, and the CLI version in the plugin's hand-written files.
|
Package plugin generates the Claude plugin's files from the CLI: every skill the CLI embeds, and the CLI version in the plugin's hand-written files. |
|
generator/prompts
Package prompts generates the prompts in prompts/ that agents are given, each from its template (prompts/*.template.md): the install prompt, with its hints table from the platforms file, and the install troubleshooting prompt.
|
Package prompts generates the prompts in prompts/ that agents are given, each from its template (prompts/*.template.md): the install prompt, with its hints table from the platforms file, and the install troubleshooting prompt. |
|
installmethod
Package installmethod detects how this CLI binary was installed so update instructions can name the right command.
|
Package installmethod detects how this CLI binary was installed so update instructions can name the right command. |
|
selfinstall
Package selfinstall holds what every way of updating the CLI binary in place shares: the no-downgrade check, the lock that keeps two processes from installing at once, the check that the new binary runs, and running the command again on it.
|
Package selfinstall holds what every way of updating the CLI binary in place shares: the no-downgrade check, the lock that keeps two processes from installing at once, the check that the new binary runs, and running the command again on it. |
|
selfinstall/npm
Package npm updates a CLI installed with `npm install -g` through npm, so npm keeps owning the package: the package's postinstall (npm/install.js) downloads the matching binary into the same place, and `npm ls` and the package.json stay correct.
|
Package npm updates a CLI installed with `npm install -g` through npm, so npm keeps owning the package: the package's postinstall (npm/install.js) downloads the matching binary into the same place, and `npm ls` and the package.json stay correct. |
|
selfinstall/release
Package release replaces the CLI binary with a published release.
|
Package release replaces the CLI binary with a published release. |
|
selfinstall/selfinstalltest
Package selfinstalltest fakes what the self-install tests need: a CLI binary that answers `version`, a release server laid out the way GoReleaser publishes, and a global npm install with its npm.
|
Package selfinstalltest fakes what the self-install tests need: a CLI binary that answers `version`, a release server laid out the way GoReleaser publishes, and a global npm install with its npm. |
|
selfinstall/selfinstalltest/fakecli
Package fakecli is the program the self-install tests run in place of the CLI binary and of npm.
|
Package fakecli is the program the self-install tests run in place of the CLI binary and of npm. |
|
selfinstall/selfinstalltest/fakecli/cmd
command
Command fakecli is the program selfinstalltest builds for its fake CLI binaries and fake npm; see package fakecli.
|
Command fakecli is the program selfinstalltest builds for its fake CLI binaries and fake npm; see package fakecli. |
|
statefile
Package statefile writes the small files the CLI keeps between runs, such as runtime.json and cached server responses, so a crash or a concurrent run never leaves one half-written.
|
Package statefile writes the small files the CLI keeps between runs, such as runtime.json and cached server responses, so a crash or a concurrent run never leaves one half-written. |
|
version
Package version holds the public CLI and bundled-skill release number.
|
Package version holds the public CLI and bundled-skill release number. |
Click to show internal directories.
Click to hide internal directories.