Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
clank
command
|
|
|
clank-auth-stub
command
clank-auth-stub is a minimal OAuth 2.0 Authorization Code + PKCE server (RFC 6749 + RFC 7636) for clank dev/testing.
|
clank-auth-stub is a minimal OAuth 2.0 Authorization Code + PKCE server (RFC 6749 + RFC 7636) for clank dev/testing. |
|
clank-host
command
clank-host is the Host plane binary.
|
clank-host is the Host plane binary. |
|
clankd
command
|
|
|
internal
|
|
|
agent
Package agent defines the interface and types for coding agent backends.
|
Package agent defines the interface and types for coding agent backends. |
|
agent/acp
Package acp adapts Agent Client Protocol (ACP) agents to clank's SessionBackend seam.
|
Package acp adapts Agent Client Protocol (ACP) agents to clank's SessionBackend seam. |
|
agent/acp/acptest
Package acptest provides an in-process scripted ACP agent for tests: a real agent speaking real JSON-RPC over real pipes through the same SDK clank uses — the protocol-level analog of hosttest.StubBackend.
|
Package acptest provides an in-process scripted ACP agent for tests: a real agent speaking real JSON-RPC over real pipes through the same SDK clank uses — the protocol-level analog of hosttest.StubBackend. |
|
agent/acptools
Package acptools provisions the pinned ACP adapter packages onto a host.
|
Package acptools provisions the pinned ACP adapter packages onto a host. |
|
agent/guidance
Package guidance assembles the stack-specific guidance that clank injects as the building agent's system prompt at session start, and materializes the stack's detailed playbook as an on-demand skill in the user's personal skills directory (~/.claude/skills).
|
Package guidance assembles the stack-specific guidance that clank injects as the building agent's system prompt at session start, and materializes the stack's detailed playbook as an on-demand skill in the user's personal skills directory (~/.claude/skills). |
|
agent/presets
Package presets defines agent presets: named bundles of session config values (mode, model, effort, …) a client applies when creating or steering a session.
|
Package presets defines agent presets: named bundles of session config values (mode, model, effort, …) a client applies when creating or steering a session. |
|
bridge
Package bridge is the daemon's durable laptop↔phone connection, built on per-device public keys — nothing secret ever crosses the wire.
|
Package bridge is the daemon's durable laptop↔phone connection, built on per-device public keys — nothing secret ever crosses the wire. |
|
cli/clankcli
Package clankcli provides the root cobra command for the clank binary.
|
Package clankcli provides the root cobra command for the clank binary. |
|
cli/daemoncli
Package daemoncli provides the cobra commands for managing the Clank daemon.
|
Package daemoncli provides the cobra commands for managing the Clank daemon. |
|
cloud
Package cloud is the laptop's HTTP client for the user's clank gateway deployment.
|
Package cloud is the laptop's HTTP client for the user's clank gateway deployment. |
|
daemonclient
Package hubclient is the canonical Go client for talking to clankd's Hub HTTP API.
|
Package hubclient is the canonical Go client for talking to clankd's Hub HTTP API. |
|
git
Package git provides helpers for interacting with git repositories, focused on worktree and branch management for Clank's session isolation.
|
Package git provides helpers for interacting with git repositories, focused on worktree and branch management for Clank's session isolation. |
|
host
Package host defines the value types for Clank's Host plane and the host.Service that runs agent backends, owns clones of remote repos, and exposes an HTTP API to the Hub.
|
Package host defines the value types for Clank's Host plane and the host.Service that runs agent backends, owns clones of remote repos, and exposes an HTTP API to the Hub. |
|
host/client
Package hostclient is the Hub-side handle for talking to a Host.
|
Package hostclient is the Hub-side handle for talking to a Host. |
|
host/github
Package github holds the host-side GitHub integration: the credential store, the device-flow runtime, the GitHub API client, and the orchestration that combines them for "create a PR from a worktree" requests.
|
Package github holds the host-side GitHub integration: the credential store, the device-flow runtime, the GitHub API client, and the orchestration that combines them for "create a PR from a worktree" requests. |
|
host/hosttest
Package hosttest provides shared test doubles for wiring an in-process host.Service in end-to-end tests: a stub backend manager standing in for the real opencode/claude process boundary, and a throwaway git repo factory.
|
Package hosttest provides shared test doubles for wiring an in-process host.Service in end-to-end tests: a stub backend manager standing in for the real opencode/claude process boundary, and a throwaway git repo factory. |
|
host/mux
Package hostmux exposes a *host.Service over HTTP.
|
Package hostmux exposes a *host.Service over HTTP. |
|
host/petname
Package petname generates short, memorable identifiers in the form adjective-animal-hex4 (e.g.
|
Package petname generates short, memorable identifiers in the form adjective-animal-hex4 (e.g. |
|
host/preview
Package preview resolves, spawns, and supervises per-worktree development servers on a Clank host.
|
Package preview resolves, spawns, and supervises per-worktree development servers on a Clank host. |
|
host/store
Package store is the host's local SQLite for session metadata and the primary-agent cache.
|
Package store is the host's local SQLite for session metadata and the primary-agent cache. |
|
keepalive
Package keepalive sends an "agent is active" signal to a provider- specific Listener whenever a backend event arrives.
|
Package keepalive sends an "agent is active" signal to a provider- specific Listener whenever a backend event arrives. |
|
keepalive/exit
Package exit implements a keepalive.Listener that shuts the process down after a period of inactivity — the "inactivity-detection (we kill)" listener anticipated by the keepalive package doc.
|
Package exit implements a keepalive.Listener that shuts the process down after a period of inactivity — the "inactivity-detection (we kill)" listener anticipated by the keepalive package doc. |
|
keepalive/noop
Package noop provides a Listener that does nothing.
|
Package noop provides a Listener that does nothing. |
|
keepalive/sprites
Package sprites implements a keepalive.Listener backed by the Fly Sprites Tasks API (https://docs.sprites.dev/keeping-sprites-running/).
|
Package sprites implements a keepalive.Listener backed by the Fly Sprites Tasks API (https://docs.sprites.dev/keeping-sprites-running/). |
|
lannet
Package lannet answers "what address can peers on the local network reach this host at" — shared by the CLI (QR links) and the daemon's bridge listener.
|
Package lannet answers "what address can peers on the local network reach this host at" — shared by the CLI (QR links) and the daemon's bridge listener. |
|
launchconfig
Package launchconfig loads Clank's project-specific web preview launch files.
|
Package launchconfig loads Clank's project-specific web preview launch files. |
|
notifier
Package notifier is the host's outbound-notification delivery pipeline.
|
Package notifier is the host's outbound-notification delivery pipeline. |
|
notifier/noop
Package noop implements notifier.Provider as a logger-only sink.
|
Package noop implements notifier.Provider as a logger-only sink. |
|
notifier/webhook
Package webhook implements notifier.Provider as an HTTP POST to a configured URL.
|
Package webhook implements notifier.Provider as an HTTP POST to a configured URL. |
|
repolabel
Package repolabel derives the owner-independent display label for a git repository, used as the `origin_repo` group key on worktree listings.
|
Package repolabel derives the owner-independent display label for a git repository, used as the `origin_repo` group key on worktree listings. |
|
socketutil
Package socketutil provides safe filesystem operations for Unix domain sockets shared across the clank-host and clankd binaries.
|
Package socketutil provides safe filesystem operations for Unix domain sockets shared across the clank-host and clankd binaries. |
|
sqlmigrate
Package sqlmigrate applies embedded goose migrations to a SQLite database.
|
Package sqlmigrate applies embedded goose migrations to a SQLite database. |
|
store
Package store provides SQLite-backed persistence for the provisioner's host registry (the `hosts` table) and push-notification devices (the `devices` table).
|
Package store provides SQLite-backed persistence for the provisioner's host registry (the `hosts` table) and push-notification devices (the `devices` table). |
|
version
Package version reports the build version shared by every clank binary.
|
Package version reports the build version shared by every clank binary. |
|
webpreview
Package webpreview is the browser twin of the phone preview: an overlay-injecting reverse proxy that `clank preview` puts in front of a KindWeb dev server (see internal/host/preview), plus the dictation service the overlay's push-to-talk streams into.
|
Package webpreview is the browser twin of the phone preview: an overlay-injecting reverse proxy that `clank preview` puts in front of a KindWeb dev server (see internal/host/preview), plus the dictation service the overlay's push-to-talk streams into. |
|
pkg
|
|
|
auth
Package auth is the single contract for authenticating inbound HTTP requests in clank.
|
Package auth is the single contract for authenticating inbound HTTP requests in clank. |
|
blobstore
Package blobstore is a provider-agnostic object-storage layer: a minimal presigned-URL contract plus path-safety primitives, with no knowledge of what the blobs are.
|
Package blobstore is a provider-agnostic object-storage layer: a minimal presigned-URL contract plus path-safety primitives, with no knowledge of what the blobs are. |
|
gateway
Package gateway is the daemon's single ingress: it authenticates, resolves the user to a persistent host via the provisioner, and reverse-proxies everything else through.
|
Package gateway is the daemon's single ingress: it authenticates, resolves the user to a persistent host via the provisioner, and reverse-proxies everything else through. |
|
gateway/previewtunnel
Package previewtunnel exposes the preview-app's HTTP transport: a thin wrapper around an stdlib *http.Transport whose DialContext opens a fresh net.Conn to a sprite's internal port via the configured Provisioner.
|
Package previewtunnel exposes the preview-app's HTTP transport: a thin wrapper around an stdlib *http.Transport whose DialContext opens a fresh net.Conn to a sprite's internal port via the configured Provisioner. |
|
images
Package images is the gateway-side presign service for user image uploads: its own blobstore.Storage (its own bucket) and its own /v1/images route, built on pkg/blobstore.
|
Package images is the gateway-side presign service for user image uploads: its own blobstore.Storage (its own bucket) and its own /v1/images route, built on pkg/blobstore. |
|
notify
Package notify implements the clankd-side push delivery for host-emitted notifier webhooks.
|
Package notify implements the clankd-side push delivery for host-emitted notifier webhooks. |
|
preview/routestore
Package routestore is the contract for preview-route persistence.
|
Package routestore is the contract for preview-route persistence. |
|
preview/routestore/memstore
Package memstore is an in-memory routestore.Store for tests.
|
Package memstore is an in-memory routestore.Store for tests. |
|
preview/tokens
Package tokens holds the constants and helpers shared between clank-host (which receives a token in the webhook response and returns it to mobile) and clankgw (which mints tokens, resolves them on subdomain requests, and gates visibility).
|
Package tokens holds the constants and helpers shared between clank-host (which receives a token in the webhook response and returns it to mobile) and clankgw (which mints tokens, resolves them on subdomain requests, and gates visibility). |
|
provisioner
Package provisioner defines the contract between the gateway/hub layers and the cloud-side machinery that owns persistent per-user hosts.
|
Package provisioner defines the contract between the gateway/hub layers and the cloud-side machinery that owns persistent per-user hosts. |
|
provisioner/flymachines
GetHostByID + OpenInternalConn capability extensions.
|
GetHostByID + OpenInternalConn capability extensions. |
|
provisioner/flysprites
Sprites-side implementation of the GetHostByID + OpenInternalConn capability extensions on provisioner.Provisioner.
|
Sprites-side implementation of the GetHostByID + OpenInternalConn capability extensions on provisioner.Provisioner. |
|
provisioner/hoststore
Package hoststore defines the persistence contract used by cloud provisioners (flysprites, flymachines, …) for tracking the per-(userID, provider) host record.
|
Package hoststore defines the persistence contract used by cloud provisioners (flysprites, flymachines, …) for tracking the per-(userID, provider) host record. |
|
provisioner/local
Local-subprocess implementation of GetHostByID + OpenInternalConn.
|
Local-subprocess implementation of GetHostByID + OpenInternalConn. |
|
provisioner/transport
Package transport holds RoundTripper helpers shared across provisioners.
|
Package transport holds RoundTripper helpers shared across provisioners. |
|
provisioner/tunnelclient
Package tunnelclient dials clank-host's GET /tunnel/{port} endpoint and adapts the WebSocket to a net.Conn carrying the raw TCP bytes of a port on the host's loopback.
|
Package tunnelclient dials clank-host's GET /tunnel/{port} endpoint and adapts the WebSocket to a net.Conn carrying the raw TCP bytes of a port on the host's loopback. |
Click to show internal directories.
Click to hide internal directories.