agentry-cli

module
v0.7.16-dev.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 4, 2026 License: MIT

README

agentry: the Agentry CLI

agentry is the command-line client for Agentry. It installs, runs, publishes and drafts QuickAgents, and it contains the local runner that executes a QuickAgent under the capabilities its manifest declares. Every install checks the archive digest and the DSSE signature before anything lands on the machine.

This repository holds the CLI and the runner. It depends on the core module github.com/blaktron/agentry for the package format (pkg/manifest), the scanners (pkg/rules, pkg/ruleset), deterministic archives (pkg/archive), attestation verification (pkg/attest) and the generated API client (pkg/apiclient).

Prerequisites

  • Go, at the version named by the go line of go.mod.
  • A container engine for agentry run with the default container adapter: Docker Engine, Docker Desktop or podman (podman with gVisor holds the sandbox too). See https://docs.secureagentry.net/runner/#container-engines.
  • golangci-lint, optional: make lint runs it when it is installed.

Build, test, lint

make build    # bin/agentry, with the version taken from git describe
make test     # go test -race ./...
make lint     # gofmt -l, go vet ./..., golangci-lint run ./...
make check    # lint, test and build
make dist     # the five release binaries into dist/
make clean    # remove bin/
make workflows-check  # no fork-reachable workflow job on a self-hosted runner (python3 with PyYAML)

make dist builds linux/amd64, linux/arm64, darwin/amd64, darwin/arm64 and windows/amd64 with CGO_ENABLED=0, unsigned. DIST_VERSION sets the version string, AGENTRY_DEFAULT_REGISTRY bakes in the registry the binary falls back to when none is configured (a source build falls back to http://localhost:8080), and EXTRA_LDFLAGS adds linker flags. A source build carries no OAuth client metadata document, so a sign-in to an MCP server registers a client with the vendor or asks for your own, and agentry connect huggingface needs AGENTRY_HF_CLIENT_ID.

make accept-runner runs the runner acceptance scripts under scripts/acceptance/. The first two need no Docker; the third needs a Docker daemon and ANTHROPIC_API_KEY, and skips itself without them.

Layout

Path Contents
cmd/agentry The agentry command and its subcommands.
pkg/runner The runner: it compiles a run plan from a release's declared capabilities, drives the Docker engine, hosts the harness adapters and the MCP gateway, decodes input files, applies the operator policy and writes the receipt.
runnerimage The runner image: the in-container tools server, the socket filter, the network proxy, the decoders and the host link.
pkg/drafter, pkg/examiner, pkg/knowledge/creator, pkg/voice/writer The built-in QuickAgents the binary embeds.
pkg/trust, pkg/installed, pkg/schedule, pkg/tui and the other pkg/ packages Key pinning, the local install store, scheduling, the terminal UI and the helpers around them.
internal/ Packages private to the CLI.
scripts/ Image verification, pin and lock checks, the workflow fork-guard check, and acceptance scripts.
testdata/ QuickAgent fixtures the runner tests use.

Downloads

Signed builds of each release are published as this repository's GitHub Releases, with SHA256SUMS, its signature SHA256SUMS.minisig and BUILD-INFO. How to install and check them: https://docs.secureagentry.net/agentry/downloads/.

Using it

To start a new QuickAgent, use the template.

Security

See SECURITY.md to report a vulnerability.

Licence

MIT. See LICENSE. The licences of the third-party modules built into the binaries are in THIRD_PARTY_NOTICES, generated by scripts/notices/generate.sh (make notices); make check fails when it is out of date.

Directories

Path Synopsis
cmd
agentry command
The advisories on a QuickAgent this machine holds: asked of the registry with the archive digest of the release laid down here, which proves the holding, so a QuickAgent that has since gone private, been retired or been deleted still answers its advisories, signed in or not.
The advisories on a QuickAgent this machine holds: asked of the registry with the archive digest of the release laid down here, which proves the holding, so a QuickAgent that has since gone private, been retired or been deleted still answers its advisories, signed in or not.
internal
highlights
Package highlights is what each release of the agentry CLI brings, in a few plain lines for the person using it.
Package highlights is what each release of the agentry CLI brings, in a few plain lines for the person using it.
origin
Package origin compares URLs by origin: scheme, host and port.
Package origin compares URLs by origin: scheme, host and port.
pastruns
Package pastruns reads the runs a person has made from their output folders: every folder directly under an output directory (./agentry-out by default) that holds a result.json, read as the run's envelope, with its timing from the receipts' meta.json.
Package pastruns reads the runs a person has made from their output folders: every folder directly under an output directory (./agentry-out by default) that holds a result.json, read as the run's envelope, with its timing from the receipts' meta.json.
storefile
Package storefile holds the file primitives the stores under the runner home share (the credential stores of pkg/runner/connection and pkg/runner/modelsignin, the MCP server store of pkg/runner/mcpinstall): an exclusive lock file a writer holds, waited for or tried, a 0600 write by rename, and a removal that takes a missing file as done.
Package storefile holds the file primitives the stores under the runner home share (the credential stores of pkg/runner/connection and pkg/runner/modelsignin, the MCP server store of pkg/runner/mcpinstall): an exclusive lock file a writer holds, waited for or tried, a 0600 write by rename, and a removal that takes a missing file as done.
version
Package version carries the CLI's build-stamped version.
Package version carries the CLI's build-stamped version.
pkg
authflow
Package authflow is the client half of browser sign-in: a one-shot loopback listener that receives a single-use CODE from the registry's /ui/authorize page after the user signs in (through the directory service) and clicks Authorize, then exchanges that code for the PAT from this process — POST /api/v1/auth/desktop/exchange — so the token never rides a URL or lands in the browser's history.
Package authflow is the client half of browser sign-in: a one-shot loopback listener that receives a single-use CODE from the registry's /ui/authorize page after the user signs in (through the directory service) and clicks Authorize, then exchanges that code for the PAT from this process — POST /api/v1/auth/desktop/exchange — so the token never rides a URL or lands in the browser's history.
browsersignin
Package browsersignin lets a person sign in to a web site in a browser window and hands back the cookies that browser would send to one address: how a calendar feed whose address answers only a signed-in browser (a Google Workspace calendar, which redirects to Google's sign-in page) is read.
Package browsersignin lets a person sign in to a web site in a browser window and hands back the cookies that browser would send to one address: how a calendar feed whose address answers only a signed-in browser (a Google Workspace calendar, which redirects to Google's sign-in page) is read.
configdir
Package configdir resolves the agentry client configuration directory (default ~/.config/agentry, relocated by AGENTRY_CONFIG_DIR).
Package configdir resolves the agentry client configuration directory (default ~/.config/agentry, relocated by AGENTRY_CONFIG_DIR).
dirpublish
Package dirpublish replaces a directory whole: the new tree is built in a staging directory beside the destination and published by rename, so a reader finds either the previous tree or the new one, never a mix, and two writers of the same destination at once never share a half-built tree.
Package dirpublish replaces a directory whole: the new tree is built in a staging directory beside the destination and published by rename, so a reader finds either the previous tree or the new one, never a mix, and two writers of the same destination at once never share a half-built tree.
drafter
Package drafter is the Drafter: the QuickAgent package that turns a person's description into a draft for the Builder, embedded in the CLI beside the Knowledge Creator and run by the runner as the second built-in package.
Package drafter is the Drafter: the QuickAgent package that turns a person's description into a draft for the Builder, embedded in the CLI beside the Knowledge Creator and run by the runner as the second built-in package.
examiner
Package examiner is the Examiner: the built-in QuickAgent that reviews a QuickAgent a person has built and reports what the registry's pipeline would be expected to say about it at Submit, embedded in the CLI and run by the runner as the fourth built-in package, the one granted the review grant.
Package examiner is the Examiner: the built-in QuickAgent that reviews a QuickAgent a person has built and reports what the registry's pipeline would be expected to say about it at Submit, embedded in the CLI and run by the runner as the fourth built-in package, the one granted the review grant.
export
Package export holds the interop exporters: pure functions of (archive, manifest, target) that emit the claude-skill and agents-md install formats, and the two tree writers that lay them on disk from an extracted archive.
Package export holds the interop exporters: pure functions of (archive, manifest, target) that emit the claude-skill and agents-md install formats, and the two tree writers that lay them on disk from an extracted archive.
installed
Package installed is the shared install-state record and the capability diff: an install shows the capability summary and the diff against the currently installed version, and requires confirmation when a capability is widened.
Package installed is the shared install-state record and the capability diff: an install shows the capability summary and the diff against the currently installed version, and requires confirmation when a capability is widened.
knowledge
Package knowledge is the knowledge pack: an LLM wiki — compiled markdown pages with an index — together with the documents it was compiled from, at most 10 MB, that a run searches through the tools server's knowledge tools over a read-only /knowledge mount.
Package knowledge is the knowledge pack: an LLM wiki — compiled markdown pages with an index — together with the documents it was compiled from, at most 10 MB, that a run searches through the tools server's knowledge tools over a read-only /knowledge mount.
knowledge/build
Package build makes or extends a knowledge pack with the Knowledge Creator: it stages the documents, decodes them before any agent sees them (pkg/runner/decode), runs the built-in Creator over their text with the pack as it stands attached (pkg/runner/localrun, pkg/runner/engine), and applies the pages it wrote — with the documents themselves and their decoded text, which only this step, never the model, puts in the pack's sources/ — through pkg/knowledge's apply step.
Package build makes or extends a knowledge pack with the Knowledge Creator: it stages the documents, decodes them before any agent sees them (pkg/runner/decode), runs the built-in Creator over their text with the pack as it stands attached (pkg/runner/localrun, pkg/runner/engine), and applies the pages it wrote — with the documents themselves and their decoded text, which only this step, never the model, puts in the pack's sources/ — through pkg/knowledge's apply step.
knowledge/creator
Package creator is the Knowledge Creator: the QuickAgent package that compiles documents into a knowledge pack, embedded in the CLI and run by the runner as a built-in package — part of the application, never a release a person installs.
Package creator is the Knowledge Creator: the QuickAgent package that compiles documents into a knowledge pack, embedded in the CLI and run by the runner as a built-in package — part of the application, never a release a person installs.
knowledge/knowledgetest
Package knowledgetest makes knowledge packs for other packages' tests, through the format's own apply step, the way every pack a person attaches is made.
Package knowledgetest makes knowledge packs for other packages' tests, through the format's own apply step, the way every pack a person attaches is made.
knowledge/remote
Package remote is the client of a registry's knowledge routes: wrap and unwrap a pack's data key, create a pack, upload and download its sealed tree, list and delete, for the account a session token or a personal access token with knowledge:read and knowledge:write speaks for.
Package remote is the client of a registry's knowledge routes: wrap and unwrap a pack's data key, create a pack, upload and download its sealed tree, list and delete, for the account a session token or a personal access token with knowledge:read and knowledge:write speaks for.
knowledge/ship
Package ship lays a knowledge pack into a QuickAgent's package so the release carries it: the pack's files under knowledge/<name>/ with the manifest.json the registry holds a shipped pack to, the entry in the package's knowledge.ships and the patterns of publish.include that put it in the archive, and the sidecar that records where the pack was laid down from.
Package ship lays a knowledge pack into a QuickAgent's package so the release carries it: the pack's files under knowledge/<name>/ with the manifest.json the registry holds a shipped pack to, the entry in the package's knowledge.ships and the patterns of publish.include that put it in the archive, and the sidecar that records where the pack was laid down from.
knowledge/store
Package store is the local knowledge store: the knowledge packs a person keeps on this machine, sealed, under the runner home the CLI and the desktop share, so that both clients list, open, attach and export the same packs.
Package store is the local knowledge store: the knowledge packs a person keeps on this machine, sealed, under the runner home the CLI and the desktop share, so that both clients list, open, attach and export the same packs.
mcpauth
Package mcpauth signs a person in to a remote MCP server by OAuth, as the MCP authorization specification (2026-07-28) asks of a client: Protected Resource Metadata (RFC 9728) from the server's 401, the authorization server's metadata (RFC 8414, OpenID discovery), the client the vendor will take (the person's own, Agentry's Client ID Metadata Document, or dynamic registration, in that order here), PKCE with S256, the resource parameter (RFC 8707), the iss check on the redirect (RFC 9207), the code exchange, refresh and revocation (RFC 7009).
Package mcpauth signs a person in to a remote MCP server by OAuth, as the MCP authorization specification (2026-07-28) asks of a client: Protected Resource Metadata (RFC 9728) from the server's 401, the authorization server's metadata (RFC 8414, OpenID discovery), the client the vendor will take (the person's own, Agentry's Client ID Metadata Document, or dynamic registration, in that order here), PKCE with S256, the resource parameter (RFC 8707), the iss check on the redirect (RFC 9207), the code exchange, refresh and revocation (RFC 7009).
mcpauth/mcpauthtest
Package mcpauthtest is a fake vendor for tests of OAuth connections: a remote MCP server that answers 401 with its resource metadata, and the authorization server behind it (metadata, consent, the token endpoint with refresh-token rotation, dynamic registration, revocation), on one TLS httptest server.
Package mcpauthtest is a fake vendor for tests of OAuth connections: a remote MCP server that answers 401 with its resource metadata, and the authorization server behind it (metadata, consent, the token endpoint with refresh-token rotation, dynamic registration, revocation), on one TLS httptest server.
pathguard
Package pathguard is the refusal every recursive delete of a derived directory passes, and the containment check every write at a manifest-named path passes.
Package pathguard is the refusal every recursive delete of a derived directory passes, and the containment check every write at a manifest-named path passes.
persistent/assistant
Package assistant is the Assistant: the built-in persistent agent that is the person's own assistant, embedded in the CLI and run by the runner as a persistent agent (pkg/runner/persistent).
Package assistant is the Assistant: the built-in persistent agent that is the person's own assistant, embedded in the CLI and run by the runner as a persistent agent (pkg/runner/persistent).
persistent/coder
Package coder is the Coding agent: the built-in persistent agent for software work, embedded in the CLI.
Package coder is the Coding agent: the built-in persistent agent for software work, embedded in the CLI.
persistent/main
Package mainagent is Agentry Helper (agentry/main): the built-in persistent agent that helps the person with Agentry itself, embedded in the CLI and run by Agentry Desktop as a persistent agent (pkg/runner/persistent).
Package mainagent is Agentry Helper (agentry/main): the built-in persistent agent that helps the person with Agentry itself, embedded in the CLI and run by Agentry Desktop as a persistent agent (pkg/runner/persistent).
persistent/offer
Package offer is the shape of an MCP server a persistent built-in comes with: an offered server, named in the built-in's own Go value rather than its manifest, so the manifest's contract is unchanged.
Package offer is the shape of an MCP server a persistent built-in comes with: an offered server, named in the built-in's own Go value rather than its manifest, so the manifest's contract is unchanged.
plainpath
Package plainpath checks a path under an os.Root before a tree that a container wrote is read: every part of the path is looked at with Lstat and must be a plain directory, and the last must be a regular file (or a plain directory, for Dir).
Package plainpath checks a path under an os.Root before a tree that a container wrote is read: every part of the path is looked at with Lstat and must be a plain directory, and the last must be a regular file (or a plain directory, for Dir).
removal
Package removal deletes what a run or a build leaves that must not stay on disk (a run's secrets file, a knowledge pack's pages and documents in the clear), and says when it could not.
Package removal deletes what a run or a build leaves that must not stay on disk (a run's secrets file, a knowledge pack's pages and documents in the clear), and says when it could not.
reportthumbs
Package reportthumbs holds a thumbnail of each built-in report theme: the first page of one sample report (runnerimage/toolsrv/testdata/pdf/ thumbnail.md) rendered by the runner's own template and the pinned Typst image, as a PNG.
Package reportthumbs holds a thumbnail of each built-in report theme: the first page of one sample report (runnerimage/toolsrv/testdata/pdf/ thumbnail.md) rendered by the runner's own template and the pinned Typst image, as a PNG.
runhost
Package runhost holds what a remote runhost is made of on both sides of the SSH connection that reaches it: where things live on the server, the device's record of each runhost, the device's keys, the line that installs a run key behind its forced command, and the frames the server's service answers in.
Package runhost holds what a remote runhost is made of on both sides of the SSH connection that reaches it: where things live on the server, the device's record of each runhost, the device's keys, the line that installs a run key behind its forced command, and the frames the server's service answers in.
runhost/clirelease
Package clirelease decides whether a CLI binary is one of Agentry's signed releases: SHA256SUMS signed with an update-signing key this build carries, a signed trusted comment naming the product and the version, and the binary's own line in those sums.
Package clirelease decides whether a CLI binary is one of Agentry's signed releases: SHA256SUMS signed with an update-signing key this build carries, a signed trusted comment naming the product and the version, and the binary's own line in those sums.
runhost/job
Package job is the document a device sends a remote runhost to start one run: the release it verified, what it decided about the run, and what the run needs from the device.
Package job is the document a device sends a remote runhost to start one run: the release it verified, what it decided about the run, and what the run needs from the device.
runhost/output
Package output is a remote run's output at rest on the runhost: the run's output folder packed into one tar of the members a device takes back, and that tar sealed to every paired device's sealing key, so the server keeps no plaintext output once the run has ended.
Package output is a remote run's output at rest on the runhost: the run's output folder packed into one tar of the members a device takes back, and that tar sealed to every paired device's sealing key, so the server keeps no plaintext output once the run has ended.
runhost/payload
Package payload carries the files a run on a remote runhost takes from the device: its inputs, the files that answer its intake questions, the knowledge packs it attaches, its Writing Voice and its report design.
Package payload carries the files a run on a remote runhost takes from the device: its inputs, the files that answer its intake questions, the knowledge packs it attaches, its Writing Voice and its report design.
runhost/setup
Package setup makes a Linux server the person owns into a remote runhost, over SSH, and takes it away again.
Package setup makes a Linux server the person owns into a remote runhost, over SSH, and takes it away again.
runhost/signin
Package signin is a sign-in made for a remote runhost: Claude Code's own sign-in, Sign in with ChatGPT and Sign in with GitHub for a Copilot plan, and an OAuth connection of the runhost's own to a release's server, each run on the runhost while the person's browser is on the device.
Package signin is a sign-in made for a remote runhost: Claude Code's own sign-in, Sign in with ChatGPT and Sign in with GitHub for a Copilot plan, and an OAuth connection of the runhost's own to a release's server, each run on the runhost while the person's browser is on the device.
runhost/store
Package store is the runhost's store of the releases it has run: each one's archive and the facts it arrived with, encrypted at rest, so a later run of the same release need not send it again.
Package store is the runhost's store of the releases it has run: each one's archive and the facts it arrived with, encrypted at rest, so a later run of the same release need not send it again.
runner/acpagent
Package acpagent is the agent side of the Agent Client Protocol: it lets an editor or an orchestrating agent drive one QuickAgent over a pair of pipes, as the runner itself drives a harness (the other direction, in pkg/runner/adapter).
Package acpagent is the agent side of the Agent Client Protocol: it lets an editor or an orchestrating agent drive one QuickAgent over a pair of pipes, as the runner itself drives a harness (the other direction, in pkg/runner/adapter).
runner/adapter
Package adapter defines the harness adapter interface and its registry.
Package adapter defines the harness adapter interface and its registry.
runner/adapter/copilottest
Package copilottest is a fake Copilot CLI server mode for tests: the JSON-RPC 2.0 server of `copilot --headless --stdio`, framed by Content-Length, in the shapes Copilot CLI 1.0.95 answers with (recorded against the real binary with no account) and copilot-sdk go/v1.0.19 names.
Package copilottest is a fake Copilot CLI server mode for tests: the JSON-RPC 2.0 server of `copilot --headless --stdio`, framed by Content-Length, in the shapes Copilot CLI 1.0.95 answers with (recorded against the real binary with no account) and copilot-sdk go/v1.0.19 names.
runner/adapter/signintest
Package signintest is a fake harness adapter for tests of model sign-ins: a container harness that reads its model credential from the file or directory a model sign-in hands it, and speaks a small NDJSON event stream the tests script.
Package signintest is a fake harness adapter for tests of model sign-ins: a container harness that reads its model credential from the file or directory a model sign-in hands it, and speaks a small NDJSON event stream the tests script.
runner/browser
Package browser holds what the runner knows of the browser server, the gateway-launched container a release that declares capabilities.browser gets: Microsoft's @playwright/mcp on the agentry-browser image, driving a headless Chromium whose only route out is the run's browse proxy.
Package browser holds what the runner knows of the browser server, the gateway-launched container a release that declares capabilities.browser gets: Microsoft's @playwright/mcp on the agentry-browser image, driving a headless Chromium whose only route out is the run's browse proxy.
runner/clamdb
Package clamdb keeps this machine's copy of the ClamAV signature bundle the decode step checks every input against.
Package clamdb keeps this machine's copy of the ClamAV signature bundle the decode step checks every input against.
runner/claudesignin
Package claudesignin is "Use your Claude subscription (runs Claude Code)": Claude Code's own sign-in into a config directory of Agentry's, and its removal.
Package claudesignin is "Use your Claude subscription (runs Claude Code)": Claude Code's own sign-in into a config directory of Agentry's, and its removal.
runner/compile
Package compile is the capability compiler: it turns manifest + operator policy into the run plan — generated gateway file set, tools-server spec, harness definition, and container topology.
Package compile is the capability compiler: it turns manifest + operator policy into the run plan — generated gateway file set, tools-server spec, harness definition, and container topology.
runner/connection
Package connection keeps a person's OAuth connections to remote MCP servers on this machine: one per QuickAgent release (ref plus archive digest) and server, never opened for another QuickAgent or another version of the same one, always kept until the person removes it or the version is uninstalled.
Package connection keeps a person's OAuth connections to remote MCP servers on this machine: one per QuickAgent release (ref plus archive digest) and server, never opened for another QuickAgent or another version of the same one, always kept until the person removes it or the version is uninstalled.
runner/copilotmodels
Package copilotmodels lists the models a person's Copilot plan offers for `agentry setup` and the desktop's model setup, so there is one implementation per machine: the Copilot sign-in kept on this computer, the images a Copilot run needs made present as setup makes them, then Copilot CLI's own list in a run's container (engine.ListCopilotModels).
Package copilotmodels lists the models a person's Copilot plan offers for `agentry setup` and the desktop's model setup, so there is one implementation per machine: the Copilot sign-in kept on this computer, the images a Copilot run needs made present as setup makes them, then Copilot CLI's own list in a run's container (engine.ListCopilotModels).
runner/decode
Package decode is the runner's decode step: the documents a run is given are turned into plain text before any agent starts, by the runner image's own `decode` role in an image that holds the decoders and content detectors (the files image, pulled by digest, with the runner binary added), in a container with no network and no capabilities, the documents mounted read-only.
Package decode is the runner's decode step: the documents a run is given are turned into plain text before any agent starts, by the runner image's own `decode` role in an image that holds the decoders and content detectors (the files image, pulled by digest, with the runner binary added), in a container with no network and no capabilities, the documents mounted read-only.
runner/deliver
Package deliver copies a run's deliverables out of its output folder to a folder the person chose.
Package deliver copies a run's deliverables out of its output folder to a folder the person chose.
runner/destination
Package destination is where the person keeps the places a run's deliverables may be sent.
Package destination is where the person keeps the places a run's deliverables may be sent.
runner/dockerx
Package dockerx wraps the docker CLI behind the smallest interface the engine needs.
Package dockerx wraps the docker CLI behind the smallest interface the engine needs.
runner/engine
Package engine executes a compiled run plan: render the plan's placeholder-bearing files into a per-run directory, resolve secrets, stand up the run-scoped network + proxy + gateway + agent containers, stream and budget the harness event stream, collect the result envelope, and tear everything down on every exit path.
Package engine executes a compiled run plan: render the plan's placeholder-bearing files into a per-run directory, resolve secrets, stand up the run-scoped network + proxy + gateway + agent containers, stream and budget the harness event stream, collect the result envelope, and tear everything down on every exit path.
runner/gateway
Package gateway owns the "installed on first agent use" half: making sure the pinned docker-mcp-gateway and harness images are present and the local runner image is built, before any run needs them.
Package gateway owns the "installed on first agent use" half: making sure the pinned docker-mcp-gateway and harness images are present and the local runner image is built, before any run needs them.
runner/harnessbuild
Package harnessbuild makes the harness images that are built on this machine from a vendor artifact and never published.
Package harnessbuild makes the harness images that are built on this machine from a vendor artifact and never published.
runner/harnessprobe
Package harnessprobe describes the host-run harness behind an adapter name on this machine: whether its executable resolves (from the operator policy's harness.<name>.path, PATH, or the adapter's well-known install locations), which release it is, and whether the endpoint the policy points it at is one the run's proxy would let through.
Package harnessprobe describes the host-run harness behind an adapter name on this machine: whether its executable resolves (from the operator policy's harness.<name>.path, PATH, or the adapter's well-known install locations), which release it is, and whether the endpoint the policy points it at is one the run's proxy would let through.
runner/hostpin
Package hostpin pins the hosts a proxy may reach to the addresses this machine resolves for them, as --add-host entries for the proxy's /etc/hosts.
Package hostpin pins the hosts a proxy may reach to the addresses this machine resolves for them, as --add-host entries for the proxy's /etc/hosts.
runner/hybrid
Package hybrid looks up a run's risky inputs on CrowdStrike's Hybrid Analysis by SHA-256 alone.
Package hybrid looks up a run's risky inputs on CrowdStrike's Hybrid Analysis by SHA-256 alone.
runner/imagelabel
Package imagelabel names the label every image the runner builds carries: org.agentry.image=<kind>.
Package imagelabel names the label every image the runner builds carries: org.agentry.image=<kind>.
runner/inference
Package inference is the client of a registry's credits sessions: the sessions a run, or a persistent agent, pays for its model with when its policy names model provider agentry.
Package inference is the client of a registry's credits sessions: the sessions a run, or a persistent agent, pays for its model with when its policy names model provider agentry.
runner/inference/inferencetest
Package inferencetest is a fake registry's credits sessions for tests: it opens, renews and ends sessions as a SecureAgentry registry does, and records each call.
Package inferencetest is a fake registry's credits sessions for tests: it opens, renews and ends sessions as a SecureAgentry registry does, and records each call.
runner/installdir
Package installdir is the runner home's per-release directory: where a verified release is laid down for runs, and where `agentry install` and the desktop put a QuickAgent by default.
Package installdir is the runner home's per-release directory: where a verified release is laid down for runs, and where `agentry install` and the desktop put a QuickAgent by default.
runner/intake
Package intake collects a QuickAgent's up-front questions (manifest v2 `intake`): asked before the sandbox starts, in either run mode, through the same prompter that collects MCP profile secrets, or answered non-interactively with --intake id=value.
Package intake collects a QuickAgent's up-front questions (manifest v2 `intake`): asked before the sandbox starts, in either run mode, through the same prompter that collects MCP profile secrets, or answered non-interactively with --intake id=value.
runner/integritykey
Package integritykey is the runner home's integrity key: 32 random bytes in <runner home>/plan-integrity.key (0600), outside every install directory.
Package integritykey is the runner home's integrity key: 32 random bytes in <runner home>/plan-integrity.key (0600), outside every install directory.
runner/localinstall
Package localinstall installs a QuickAgent from a folder on this machine that was never published, into the runner home, where it lists among the installed QuickAgents and runs by name.
Package localinstall installs a QuickAgent from a folder on this machine that was never published, into the runner home, where it lists among the installed QuickAgents and runs by name.
runner/localrun
Package localrun holds what a run needs besides the registry: the plan's reuse or compile for any run, a release's or not (EnsurePlan); the manifest and the tree digest a local package is read and keyed by; and the built-in run — a package this binary embeds, run with the attestation state builtin, no registry resolve and no consent prompt for a contract the application declares itself.
Package localrun holds what a run needs besides the registry: the plan's reuse or compile for any run, a release's or not (EnsurePlan); the manifest and the tree digest a local package is read and keyed by; and the built-in run — a package this binary embeds, run with the attestation state builtin, no registry resolve and no consent prompt for a contract the application declares itself.
runner/mcpinstall
Package mcpinstall resolves and installs the MCP servers a QuickAgent declares: resolution turns each manifest pin into the exact registry artifact (npm / PyPI metadata, integrity recorded); installation materializes the dependency closure into the signature's server store inside a pinned runtime container.
Package mcpinstall resolves and installs the MCP servers a QuickAgent declares: resolution turns each manifest pin into the exact registry artifact (npm / PyPI metadata, integrity recorded); installation materializes the dependency closure into the signature's server store inside a pinned runtime container.
runner/modelkey
Package modelkey keeps a model provider's API key in the OS keychain — Keychain on macOS, Credential Manager on Windows, the Secret Service on Linux — for the runs a person launches from somewhere with no shell environment of its own: a desktop app opened from the dock or the Start Menu.
Package modelkey keeps a model provider's API key in the OS keychain — Keychain on macOS, Credential Manager on Windows, the Secret Service on Linux — for the runs a person launches from somewhere with no shell environment of its own: a desktop app opened from the dock or the Start Menu.
runner/modelsignin
Package modelsignin keeps a person's model sign-ins on this machine: the grants that let their local runs spend a model vendor's plan, one per vendor, apart from the MCP connections of pkg/runner/connection.
Package modelsignin keeps a person's model sign-ins on this machine: the grants that let their local runs spend a model vendor's plan, one per vendor, apart from the MCP connections of pkg/runner/connection.
runner/osvdb
Package osvdb keeps this machine's copy of OSV's vulnerability databases, which the Coding agent's dependency scan reads offline.
Package osvdb keeps this machine's copy of OSV's vulnerability databases, which the Coding agent's dependency scan reads offline.
runner/owner
Package owner labels the docker objects a run creates with the process that created them, and tells a live owner from a dead one, so a later run on the same host can remove what a crashed run left behind without touching a sibling run that is still going.
Package owner labels the docker objects a run creates with the process that created them, and tells a live owner from a dead one, so a later run on the same host can remove what a crashed run left behind without touching a sibling run that is still going.
runner/persistent
Package persistent runs a persistent agent: a built-in QuickAgent the runner keeps between the person's conversations.
Package persistent runs a persistent agent: a built-in QuickAgent the runner keeps between the person's conversations.
runner/policy
Package policy loads the operator policy — the machine-side half of every run plan.
Package policy loads the operator policy — the machine-side half of every run plan.
runner/procx
Package procx holds what every process the runner starts has in common — one place, so a new spawn site has one call to make rather than a flag to remember (nothing enforces the call).
Package procx holds what every process the runner starts has in common — one place, so a new spawn site has one call to make rather than a flag to remember (nothing enforces the call).
runner/profile
Package profile stores a QuickAgent's MCP profile: the persistent, credentialed half of its gateway configuration, keyed by signature — ns/name@version plus the archive digest, the same identity the install cache uses.
Package profile stores a QuickAgent's MCP profile: the persistent, credentialed half of its gateway configuration, keyed by signature — ns/name@version plus the archive digest, the same identity the install cache uses.
runner/receipt
Package receipt defines the run result envelope — the runtime counterpart of the registry's public scan report.
Package receipt defines the run result envelope — the runtime counterpart of the registry's public scan report.
runner/receipt/internal/genexitclasses command
Command genexitclasses writes the exit-class table as exit-classes.json, the rendering receipt.ExitClassesJSON makes of receipt.ExitClasses, into the file named by its one argument (exit-classes.json in the working folder by default).
Command genexitclasses writes the exit-class table as exit-classes.json, the rendering receipt.ExitClassesJSON makes of receipt.ExitClasses, into the file named by its one argument (exit-classes.json in the working folder by default).
runner/session
Package session is the interactive run API: what a chat surface — the CLI's TUI, the desktop app — talks to.
Package session is the interactive run API: what a chat surface — the CLI's TUI, the desktop app — talks to.
runner/session/protocol
Package protocol is the session protocol: an interactive session driven by a program rather than a person, over pipes and with no terminal.
Package protocol is the session protocol: an interactive session driven by a program rather than a person, over pipes and with no terminal.
runner/setup
TTYPrompter: the CLI's Prompter over stdin/stderr.
TTYPrompter: the CLI's Prompter over stdin/stderr.
runner/skill
Package skill reads Agent Skills folders: a SKILL.md whose frontmatter names the skill and says when to use it, and the files it uses.
Package skill reads Agent Skills folders: a SKILL.md whose frontmatter names the skill and says when to use it, and the files it uses.
runner/sources
Package sources is the input-source seam.
Package sources is the input-source seam.
runner/spec
Package spec defines the run plan — the deterministic artifact the capability compiler produces at install time and the engine executes.
Package spec defines the run plan — the deterministic artifact the capability compiler produces at install time and the engine executes.
runner/targethost
Package targethost readies a run's target hosts before anything starts: a target host is a machine the person names when a run starts, as the answer to an intake question of type host, and the runner reaches it over SSH from the host link (runnerimage/hostlink), never from the agent's containers.
Package targethost readies a run's target hosts before anything starts: a target host is a machine the person names when a run starts, as the answer to an intake question of type host, and the runner reaches it over SSH from the host link (runnerimage/hostlink), never from the agent's containers.
runner/unsafeexec
Package unsafeexec is the data side of Unsafe Mode: the unsafe base image's command index, extras list and ambiguous list, read out of the pulled image and held to a grammar, and the placement of a manifest's declared commands through them.
Package unsafeexec is the data side of Unsafe Mode: the unsafe base image's command index, extras list and ambiguous list, read out of the pulled image and held to a grammar, and the placement of a manifest's declared commands through them.
schedule
Package schedule keeps the schedules of runs on this computer: when a QuickAgent runs again, the store that is the truth about it, the record of every occurrence, and the operating system's own entries that wake `agentry schedule fire` at the right moments.
Package schedule keeps the schedules of runs on this computer: when a QuickAgent runs again, the store that is the truth about it, the record of every occurrence, and the operating system's own entries that wake `agentry schedule fire` at the right moments.
termtext
Package termtext prepares author text (a release guide's overview and key help, the Drafter's narration) for a terminal: cleaned of what a terminal would act on or hide, and set in a gutter so it cannot pass for the CLI's own lines.
Package termtext prepares author text (a release guide's overview and key help, the Drafter's narration) for a terminal: cleaned of what a terminal would act on or hide, and set in a gutter so it cannot pass for the CLI's own lines.
trust
Package trust is the shared client-side provenance layer: fetch a registry's signing keys, pin them on first use (TOFU) with key-id continuity warnings, and verify DSSE envelopes offline against an archive digest.
Package trust is the shared client-side provenance layer: fetch a registry's signing keys, pin them on first use (TOFU) with key-id continuity warnings, and verify DSSE envelopes offline against an archive digest.
tui
Package tui is the terminal chat for an interactive run: one full-screen conversation over a session.Session — transcript pane, input line, status line, and the slash commands /add, /yes, /no, /finish, /quit, /caps.
Package tui is the terminal chat for an interactive run: one full-screen conversation over a session.Session — transcript pane, input line, status line, and the slash commands /add, /yes, /no, /finish, /quit, /caps.
validate
The S1 half of local/remote validation parity.
The S1 half of local/remote validation parity.
voice
Package voice is the Writing Voice: the instructions an LLM follows to write as a person writes, one Markdown file, VOICE.md, at most MaxBytes.
Package voice is the Writing Voice: the instructions an LLM follows to write as a person writes, one Markdown file, VOICE.md, at most MaxBytes.
voice/build
Package build writes a Writing Voice with the Voice Writer: it stages the person's writing samples, decodes them before any agent sees them (pkg/runner/decode, the Knowledge Creator's decode step), runs the built-in Voice Writer over their text with the current voice when there is one (pkg/runner/localrun), and returns the VOICE.md it wrote, held to the format.
Package build writes a Writing Voice with the Voice Writer: it stages the person's writing samples, decodes them before any agent sees them (pkg/runner/decode, the Knowledge Creator's decode step), runs the built-in Voice Writer over their text with the current voice when there is one (pkg/runner/localrun), and returns the VOICE.md it wrote, held to the format.
voice/remote
Package remote is the client of a registry's Writing Voice routes (the core's docs/voice.md): read the account's voice, put a new version for review, and set the account's always-attach flag, for the account a session token or a personal access token with voice:read and voice:write speaks for.
Package remote is the client of a registry's Writing Voice routes (the core's docs/voice.md): read the account's voice, put a new version for review, and set the account's always-attach flag, for the account a session token or a personal access token with voice:read and voice:write speaks for.
voice/writer
Package writer is the Voice Writer: the QuickAgent package that writes a person's Writing Voice from samples of their writing, embedded in the CLI and run by the runner as a built-in package, the third beside the Knowledge Creator and the Drafter.
Package writer is the Voice Writer: the QuickAgent package that writes a person's Writing Voice from samples of their writing, embedded in the CLI and run by the runner as a built-in package, the third beside the Knowledge Creator and the Drafter.
Package runnerimage is the embedded build context of the locally built agentry-runner image.
Package runnerimage is the embedded build context of the locally built agentry-runner image.
applink
Package applink is the app link: the MCP server through which a persistent agent reaches the application that runs it, and nothing else.
Package applink is the app link: the MCP server through which a persistent agent reaches the application that runs it, and nothing else.
beneath
Package beneath holds a name beneath a directory: every open, make, remove, rename and ownership change resolves its path from a directory the caller opened, and a path that would leave it is refused.
Package beneath holds a name beneath a directory: every open, make, remove, rename and ownership change resolves its path from a directory the caller opened, and a path that would leave it is refused.
bridge
Package bridge is the runner image's bridge role: a stdio MCP server the gateway launches like any declared server, which forwards each message to one remote MCP server over streamable HTTP, or over the older HTTP+SSE transport where that is all the server speaks.
Package bridge is the runner image's bridge role: a stdio MCP server the gateway launches like any declared server, which forwards each message to one remote MCP server over streamable HTTP, or over the older HTTP+SSE transport where that is all the server speaks.
brotli
Package brotli decodes the Brotli compressed data format (RFC 7932).
Package brotli decodes the Brotli compressed data format (RFC 7932).
confine
Package confine holds a declared exec command to the places it may write.
Package confine holds a declared exec command to the places it may write.
decode
Package decode is the runner image's `decode` role: it turns the documents under one directory into plain text under another, before any agent sees them, so a run reads text and no model ever runs a decoder.
Package decode is the runner image's `decode` role: it turns the documents under one directory into plain text under another, before any agent sees them, so a run reads text and no model ever runs a decoder.
hostlink
Package hostlink is the runner's host link: the MCP server through which an agent works a target host, a machine the person named when the run started.
Package hostlink is the runner's host link: the MCP server through which an agent works a target host, a machine the person named when the run started.
ical
Package ical reads an iCalendar (RFC 5545) feed, the ICS document a calendar service publishes at a subscription address, and expands its events into the occurrences that fall in a window: recurrences (RRULE, RDATE, EXDATE), the instances a feed overrides (RECURRENCE-ID), all-day events and the time zones events are written in.
Package ical reads an iCalendar (RFC 5545) feed, the ICS document a calendar service publishes at a subscription address, and expands its events into the occurrences that fall in a window: recurrences (RRULE, RDATE, EXDATE), the instances a feed overrides (RECURRENCE-ID), all-day events and the time zones events are written in.
judge
Package judge is the one client for TypeSafe AI's Jev and the question sets it is asked.
Package judge is the one client for TypeSafe AI's Jev and the question sets it is asked.
messenger
Package messenger is the messenger role of the runner image: the one container that holds a messenger account's credential and its connection to that messaging service, for a persistent agent the person can talk to from there.
Package messenger is the messenger role of the runner image: the one container that holds a messenger account's credential and its connection to that messaging service, for a persistent agent the person can talk to from there.
minimize
Package minimize is the runner image's `minimize` role: run once by `docker build`, it turns the shared runner image into a per-QuickAgent exec image that holds ONLY the declared commands.
Package minimize is the runner image's `minimize` role: run once by `docker build`, it turns the shared runner image into a per-QuickAgent exec image that holds ONLY the declared commands.
netaddr
Package netaddr is the runner's one rule for a public address: the ranges web_read, the input-source proxy and the browse proxy never connect to, among them the 6to4 relay anycast range, Azure's wireserver, the IPv6 discard prefix and site-local space, and an ISATAP address that carries an IPv4 address that is not public.
Package netaddr is the runner's one rule for a public address: the ranges web_read, the input-source proxy and the browse proxy never connect to, among them the 6to4 relay anycast range, Azure's wireserver, the IPv6 discard prefix and site-local space, and an ISATAP address that carries an IPv4 address that is not public.
netproxy
Package netproxy is the llm-proxy of the agent-container topology: the run network is created --internal, so the ONLY way anything the agent container runs can reach the outside world is a CONNECT tunnel through this proxy — and the proxy tunnels only to the operator's model endpoints (policy.model.proxyAllow).
Package netproxy is the llm-proxy of the agent-container topology: the run network is created --internal, so the ONLY way anything the agent container runs can reach the outside world is a CONNECT tunnel through this proxy — and the proxy tunnels only to the operator's model endpoints (policy.model.proxyAllow).
portrelay
Package portrelay carries one TCP connection to a port of the container's own loopback over stdio: the runner execs it in the Coding agent's tools server for each connection to a port published on the person's computer.
Package portrelay carries one TCP connection to a port of the container's own loopback over stdio: the runner execs it in the Coding agent's tools server for each connection to a port published on the person's computer.
probe
Package probe is the runner image's gateway probe: the health check every run makes before its agent starts (an authenticated MCP initialize from inside the run network), and, for a session, the listing of the tools the gateway serves.
Package probe is the runner image's gateway probe: the health check every run makes before its agent starts (an authenticated MCP initialize from inside the run network), and, for a session, the listing of the tools the gateway serves.
reportdesign
Package reportdesign is the one definition of a report design: the theme document version 2 that sets the look of a person's PDF reports.
Package reportdesign is the one definition of a report design: the theme document version 2 that sets the look of a person's PDF reports.
send
Package send is the runner image's `deliver` role: the delivery step that hands a finished run's deliverables to a destination the person chose.
Package send is the runner image's `deliver` role: the delivery step that hands a finished run's deliverables to a destination the person chose.
sockfilter
Package sockfilter is the per-run filter between a run's MCP gateway and the docker daemon.
Package sockfilter is the per-run filter between a run's MCP gateway and the docker daemon.
source
Package source is the runner image's `source` role: the fetch step that brings a run's input source in before the run, as plain files under one directory.
Package source is the runner image's `source` role: the fetch step that brings a run's input source in before the run, as plain files under one directory.
toolargs
Package toolargs decodes the arguments of a model's tool call.
Package toolargs decodes the arguments of a model's tool call.
toolsrv
Package toolsrv implements the Agentry companion tools server: one MCP stdio server whose tool surface is constructed from the manifest's capability contract.
Package toolsrv implements the Agentry companion tools server: one MCP stdio server whose tool surface is constructed from the manifest's capability contract.
webscan
Package webscan is AI Review of what the Drafter's web tools bring back, before its model reads any of it.
Package webscan is AI Review of what the Drafter's web tools bring back, before its model reads any of it.
websearch
Package websearch is web search behind one small interface.
Package websearch is web search behind one small interface.
scripts
context-measure command
Command context-measure reads the receipts of runs and of persistent agent segments and reports how large each conversation's context grew, which tools' results filled it, and what a clear of old tool results after a cold pause would have removed.
Command context-measure reads the receipts of runs and of persistent agent segments and reports how large each conversation's context grew, which tools' results filled it, and what a clear of old tool results after a cold pause would have removed.
mcp-server-survey command
Command mcp-server-survey installs and starts declared MCP servers the way the runner does, and records what each one did: which version admits the default runtime, whether it installs, whether it starts and lists its tools, and what one keyless read-only call returned.
Command mcp-server-survey installs and starts declared MCP servers the way the runner does, and records what each one did: which version admits the default runtime, whether it installs, whether it starts and lists its tools, and what one keyless read-only call returned.
notices command
Command notices writes THIRD_PARTY_NOTICES: the licence text of every third-party Go module compiled into the agentry binary, for each target the release builds (linux, darwin and windows, with cgo off, as `make dist` builds them), and the licence of the moby seccomp profile the runner image sources carry.
Command notices writes THIRD_PARTY_NOTICES: the licence text of every third-party Go module compiled into the agentry binary, for each target the release builds (linux, darwin and windows, with cgo off, as `make dist` builds them), and the licence of the moby seccomp profile the runner image sources carry.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL