Documentation
¶
Overview ¶
Package main is the root Compozy CLI entrypoint for go install github.com/compozy/compozy.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
compozy
command
Package main is the CompozyOS CLI entrypoint.
|
Package main is the CompozyOS CLI entrypoint. |
|
compozy-catalog
command
|
|
|
compozy-codegen
command
|
|
|
compozy-desktop-release
command
|
|
|
compozy-manifest-check
command
|
|
|
desktop
|
|
|
schema
Package appschema embeds the canonical cross-language desktop app state schema.
|
Package appschema embeds the canonical cross-language desktop app state schema. |
|
extensions
|
|
|
internal
|
|
|
acp
Package acp provides the Compozy ACP client implementation.
|
Package acp provides the Compozy ACP client implementation. |
|
admission
Package admission owns the daemon-wide new-work admission boundary.
|
Package admission owns the daemon-wide new-work admission boundary. |
|
agentidentity
Package agentidentity resolves daemon-validated caller identity for agent-facing CLI and UDS operations.
|
Package agentidentity resolves daemon-validated caller identity for agent-facing CLI and UDS operations. |
|
agentmemory
Package agentmemory owns bounded, explicit agent notes.
|
Package agentmemory owns bounded, explicit agent notes. |
|
api/core
Package core provides the shared transport-facing API layer used by HTTP and UDS bindings.
|
Package core provides the shared transport-facing API layer used by HTTP and UDS bindings. |
|
api/ginutil
Package ginutil owns process-wide Gin runtime coordination shared by Compozy transports.
|
Package ginutil owns process-wide Gin runtime coordination shared by Compozy transports. |
|
api/testutil
Package testutil provides shared helpers for API-layer tests.
|
Package testutil provides shared helpers for API-layer tests. |
|
appstatecontract
Package appstatecontract owns the shared desktop app-state wire version.
|
Package appstatecontract owns the shared desktop app-state wire version. |
|
automation
Package automation hosts the runtime automation components and re-exports the canonical automation model from `internal/automation/model`.
|
Package automation hosts the runtime automation components and re-exports the canonical automation model from `internal/automation/model`. |
|
automation/model
Package model defines the transport-agnostic automation domain model shared by configuration, persistence, runtime, and API layers.
|
Package model defines the transport-agnostic automation domain model shared by configuration, persistence, runtime, and API layers. |
|
clientstate
Package clientstate persists opaque, workspace-scoped client state and publishes committed changes in workspace sequence order.
|
Package clientstate persists opaque, workspace-scoped client state and publishes committed changes in workspace sequence order. |
|
cmdpalette
Package cmdpalette owns the daemon-canonical command catalog and invocation contract.
|
Package cmdpalette owns the daemon-canonical command catalog and invocation contract. |
|
cmdpalette/corecmds
Package corecmds provides the complete daemon-owned core command inventory.
|
Package corecmds provides the complete daemon-owned core command inventory. |
|
codegen/jsbin
Package jsbin resolves workspace-pinned JS tool binaries with a bunx fallback.
|
Package jsbin resolves workspace-pinned JS tool binaries with a bunx fallback. |
|
codegen/storeschema
Package storeschema owns deterministic sqlc and Atlas generation for Compozy stores.
|
Package storeschema owns deterministic sqlc and Atlas generation for Compozy stores. |
|
command
Package command owns session-aware slash command projection and parsing.
|
Package command owns session-aware slash command projection and parsing. |
|
config/lifecycle
Package lifecycle owns the config-apply lifecycle matrix shared by runtime, API, CLI, web, docs, and codegen checks.
|
Package lifecycle owns the config-apply lifecycle matrix shared by runtime, API, CLI, web, docs, and codegen checks. |
|
daemon
Package daemon wires the Compozy runtime packages into a single long-lived process.
|
Package daemon wires the Compozy runtime packages into a single long-lived process. |
|
deadentity
Package deadentity owns workspace-scoped failure streaks and durable dead-runtime recovery.
|
Package deadentity owns workspace-scoped failure streaks and durable dead-runtime recovery. |
|
demoseed
Package demoseed prepares a coherent local workspace for product demonstrations.
|
Package demoseed prepares a coherent local workspace for product demonstrations. |
|
events
Package events owns canonical runtime event names and metadata shared by producers, logs, notifications, and contract tests.
|
Package events owns canonical runtime event names and metadata shared by producers, logs, notifications, and contract tests. |
|
extension/agentplugin
Package agentplugin reads and validates portable Agent Plugins packages.
|
Package agentplugin reads and validates portable Agent Plugins packages. |
|
extension/surfaces
Package surfaces defines the static extension resource surface policy.
|
Package surfaces defines the static extension resource surface policy. |
|
extensionenv
Package extensionenv defines the persistence boundary for extension environment bindings.
|
Package extensionenv defines the persistence boundary for extension environment bindings. |
|
extensioninput
Package extensioninput defines the persistence boundary for non-secret extension inputs.
|
Package extensioninput defines the persistence boundary for non-secret extension inputs. |
|
extensionmcp
Package extensionmcp defines instance-scoped MCP overrides and sticky runtime names.
|
Package extensionmcp defines instance-scoped MCP overrides and sticky runtime names. |
|
fileutil
Package fileutil provides shared filesystem helpers for Compozy components.
|
Package fileutil provides shared filesystem helpers for Compozy components. |
|
gateway
Package gateway owns durable exposure policy and reconciliation contracts.
|
Package gateway owns durable exposure policy and reconciliation contracts. |
|
hooks
Package hooks defines the dependency-free core types for the Compozy lifecycle hooks platform.
|
Package hooks defines the dependency-free core types for the Compozy lifecycle hooks platform. |
|
listcursor
Package listcursor provides versioned, query-bound opaque cursors for stable list pagination.
|
Package listcursor provides versioned, query-bound opaque cursors for stable list pagination. |
|
logger
Package logger configures Compozy structured logging.
|
Package logger configures Compozy structured logging. |
|
loop
Package loop owns loop-domain validation and compile surfaces.
|
Package loop owns loop-domain validation and compile surfaces. |
|
loop/dsl
Package dsl defines the compozy.loop/v1 authoring document.
|
Package dsl defines the compozy.loop/v1 authoring document. |
|
loop/dsl/refs
Package refs validates loop template and CEL references against one namespace.
|
Package refs validates loop template and CEL references against one namespace. |
|
loop/gate
Package gate evaluates loop verification gates.
|
Package gate evaluates loop verification gates. |
|
loop/goal
Package goal defines the durable convergence contracts implemented by the Loop store.
|
Package goal defines the durable convergence contracts implemented by the Loop store. |
|
marketplace
Package marketplace owns Compozy-curated discovery feeds and their durable projection.
|
Package marketplace owns Compozy-curated discovery feeds and their durable projection. |
|
mcp/securehttp
Package securehttp provides outbound HTTP clients for remote MCP and OAuth services.
|
Package securehttp provides outbound HTTP clients for remote MCP and OAuth services. |
|
mcpbridge
Package mcpbridge serves a stdio MCP server's tools to an ACP agent over loopback streamable HTTP.
|
Package mcpbridge serves a stdio MCP server's tools to an ACP agent over loopback streamable HTTP. |
|
mcppolicy
Package mcppolicy owns the shared security policy for remote MCP endpoints.
|
Package mcppolicy owns the shared security policy for remote MCP endpoints. |
|
mention
Package mention parses @-mention tokens from prompt text.
|
Package mention parses @-mention tokens from prompt text. |
|
monitor
Package monitor owns daemon-native session monitors: durable-for-the-daemon watches that wake their owning agent session when a terminal exits, a terminal prints a pattern, a timer elapses, other sessions reach a state, or a pull request changes.
|
Package monitor owns daemon-native session monitors: durable-for-the-daemon watches that wake their owning agent session when a terminal exits, a terminal prints a pattern, a timer elapses, other sessions reach a state, or a pull request changes. |
|
outboundpolicy
Package outboundpolicy defines the shared destination boundary for outbound network clients.
|
Package outboundpolicy defines the shared destination boundary for outbound network clients. |
|
procutil
Package procutil provides shared process helpers for Compozy runtime components.
|
Package procutil provides shared process helpers for Compozy runtime components. |
|
profile
Package profile owns durable profile identity, selection, resolution, and crash-convergent lifecycle operations.
|
Package profile owns durable profile identity, selection, resolution, and crash-convergent lifecycle operations. |
|
providerauth
Package providerauth contains provider-auth diagnostics shared by CLI and daemon settings surfaces.
|
Package providerauth contains provider-auth diagnostics shared by CLI and daemon settings surfaces. |
|
providers
Package providers owns provider authentication classification and probes.
|
Package providers owns provider authentication classification and probes. |
|
providerusage
Package providerusage owns profile-scoped, in-memory usage snapshots and collection lifetimes.
|
Package providerusage owns profile-scoped, in-memory usage snapshots and collection lifetimes. |
|
reasoning
Package reasoning owns the cross-surface reasoning-effort vocabulary.
|
Package reasoning owns the cross-surface reasoning-effort vocabulary. |
|
redact
Package redact provides the process-wide canonical secret redactor.
|
Package redact provides the process-wide canonical secret redactor. |
|
resources
Package resources provides the canonical desired-state persistence kernel and typed adapter boundary for extensibility resources.
|
Package resources provides the canonical desired-state persistence kernel and typed adapter boundary for extensibility resources. |
|
retention
Package retention provides lifecycle management for periodic retention work.
|
Package retention provides lifecycle management for periodic retention work. |
|
retry
Package retry provides small context-aware retry and backoff primitives.
|
Package retry provides small context-aware retry and backoff primitives. |
|
scheduler
Package scheduler implements the daemon-owned mechanical task scheduler.
|
Package scheduler implements the daemon-owned mechanical task scheduler. |
|
session
Package session orchestrates Compozy session lifecycle around ACP-backed agents.
|
Package session orchestrates Compozy session lifecycle around ACP-backed agents. |
|
sessionprocess
Package sessionprocess tracks session-owned OS processes independently of agent lifetime.
|
Package sessionprocess tracks session-owned OS processes independently of agent lifetime. |
|
shellwait
Package shellwait recognizes provider shell commands that block on external work, so a session can be redirected to a daemon-owned monitor instead.
|
Package shellwait recognizes provider shell commands that block on external work, so a session can be redirected to a daemon-owned monitor instead. |
|
skills
Package skills provides the core types and loading primitives for AgentSkills `SKILL.md` files.
|
Package skills provides the core types and loading primitives for AgentSkills `SKILL.md` files. |
|
skillscan
Package skillscan discovers skill definition files under filesystem roots.
|
Package skillscan discovers skill definition files under filesystem roots. |
|
speed
Package speed owns the cross-surface ACP speed vocabulary.
|
Package speed owns the cross-surface ACP speed vocabulary. |
|
sse
Package sse provides shared server-sent event decoding helpers.
|
Package sse provides shared server-sent event decoding helpers. |
|
store
Package store provides shared persistence types, validation, and helper primitives.
|
Package store provides shared persistence types, validation, and helper primitives. |
|
store/globaldb/schema
Package schema embeds the global database schema and migration directory.
|
Package schema embeds the global database schema and migration directory. |
|
store/sessiondb/schema
Package schema embeds the session database schema and migration directory.
|
Package schema embeds the session database schema and migration directory. |
|
store/telemetrydb
Package telemetrydb owns append-only observability independently of the core database.
|
Package telemetrydb owns append-only observability independently of the core database. |
|
store/telemetrydb/schema
Package schema embeds the telemetry schema and its independent migration history.
|
Package schema embeds the telemetry schema and its independent migration history. |
|
store/workspacedb
Package workspacedb owns per-workspace SQLite database lifecycle helpers.
|
Package workspacedb owns per-workspace SQLite database lifecycle helpers. |
|
store/workspacedb/schema
Package schema embeds the workspace database schema and migration directory.
|
Package schema embeds the workspace database schema and migration directory. |
|
task
Package task defines the canonical task-domain models, interfaces, limits, and validation helpers shared by persistence, runtime, and transport layers.
|
Package task defines the canonical task-domain models, interfaces, limits, and validation helpers shared by persistence, runtime, and transport layers. |
|
terminal
Package terminal owns resident terminal processes, their byte streams, and shared attachments.
|
Package terminal owns resident terminal processes, their byte streams, and shared attachments. |
|
terminal/idgen
Package idgen creates permanent terminal identifiers from cryptographic entropy.
|
Package idgen creates permanent terminal identifiers from cryptographic entropy. |
|
terminal/journal
Package journal owns terminal command persistence and retained byte artifacts.
|
Package journal owns terminal command persistence and retained byte artifacts. |
|
testutil
Package testutil provides shared test helpers for internal packages.
|
Package testutil provides shared test helpers for internal packages. |
|
testutil/mcpfixture
Package mcpfixture provides deterministic official-MCP-SDK fixtures for runtime and OAuth integration tests.
|
Package mcpfixture provides deterministic official-MCP-SDK fixtures for runtime and OAuth integration tests. |
|
toolmeta
Package toolmeta renders safe, provider-neutral tool progress presentation metadata.
|
Package toolmeta renders safe, provider-neutral tool progress presentation metadata. |
|
toolruntime
Package toolruntime tracks long-running tool subprocess ownership and scoped interrupts.
|
Package toolruntime tracks long-running tool subprocess ownership and scoped interrupts. |
|
tools
Remove the leftover-reference filter in v0.6.1; retain the retired ID tombstones.
|
Remove the leftover-reference filter in v0.6.1; retain the retired ID tombstones. |
|
vault
Package vault owns encrypted daemon-managed secret material.
|
Package vault owns encrypted daemon-managed secret material. |
|
version
Package version provides build metadata injected via ldflags.
|
Package version provides build metadata injected via ldflags. |
|
windowmanager
Package windowmanager owns workspace-scoped window topology and semantic mutations.
|
Package windowmanager owns workspace-scoped window topology and semantic mutations. |
|
workref
Package workref provides tiny shared workspace reference value objects used to pass workspace identifiers and paths through transport and runtime helpers.
|
Package workref provides tiny shared workspace reference value objects used to pass workspace identifiers and paths through transport and runtime helpers. |
|
workspace
Package workspace defines workspace domain models, sentinel errors, and resolver contracts used across Compozy runtime packages.
|
Package workspace defines workspace domain models, sentinel errors, and resolver contracts used across Compozy runtime packages. |
|
workspacefiles
Package workspacefiles serves ranked file and folder search under one directory root from a cached, git-backed index with a bounded walk fallback.
|
Package workspacefiles serves ranked file and folder search under one directory root from a cached, git-backed index with a bounded walk fallback. |
|
scripts
|
|
|
air-state-dir
command
|
|
|
air-state-lock
command
|
|
|
demo-seed
command
|
|
|
dev-http-endpoint
command
Command dev-http-endpoint prints the daemon's configured HTTP connect endpoint as "host\tport" without requiring a running daemon.
|
Command dev-http-endpoint prints the daemon's configured HTTP connect endpoint as "host\tport" without requiring a running daemon. |
|
sqlite-contention
command
Command sqlite-contention measures the same public store workload at two commits.
|
Command sqlite-contention measures the same public store workload at two commits. |
|
sdk
|
|
|
go
module
|
|
|
web
|
|
|
e2e/fixtures/session-pull-request-seeder
command
Command session-pull-request-seeder gives an existing workspace-root session a settled branch snapshot and caches the pull request for that branch in a stopped isolated daemon home, for the topbar PR chip journeys (E2E-001, E2E-003).
|
Command session-pull-request-seeder gives an existing workspace-root session a settled branch snapshot and caches the pull request for that branch in a stopped isolated daemon home, for the topbar PR chip journeys (E2E-001, E2E-003). |
|
e2e/fixtures/sessions-board-seeder
command
Command sessions-board-seeder writes stopped sessions for the Sessions board browser journeys (E2E-005..E2E-007) into a stopped isolated daemon home.
|
Command sessions-board-seeder writes stopped sessions for the Sessions board browser journeys (E2E-005..E2E-007) into a stopped isolated daemon home. |
Click to show internal directories.
Click to hide internal directories.