Directories
¶
| Path | Synopsis |
|---|---|
|
General API metadata swag (`make swagger`) reads to generate the OpenAPI spec committed at api/agent/openapi.json — see that package's doc comment.
|
General API metadata swag (`make swagger`) reads to generate the OpenAPI spec committed at api/agent/openapi.json — see that package's doc comment. |
|
Package apps manages installed applications: web frontends built on top of the agent's public API (vision document, section 7.6).
|
Package apps manages installed applications: web frontends built on top of the agent's public API (vision document, section 7.6). |
|
Package auth issues and validates the "limited sessions" an installed application receives (vision document, section 15.4): a session is scoped to exactly the permissions its application's manifest declares and never carries the rest of the public API's default access.
|
Package auth issues and validates the "limited sessions" an installed application receives (vision document, section 15.4): a session is scoped to exactly the permissions its application's manifest declares and never carries the rest of the public API's default access. |
|
Package bundles installs bundles: packages that group an application, its workflows, and its plugin dependencies into one .patchcord-bundle archive (vision document, section 9.3).
|
Package bundles installs bundles: packages that group an application, its workflows, and its plugin dependencies into one .patchcord-bundle archive (vision document, section 9.3). |
|
Package cli defines the Patchcord command-line interface.
|
Package cli defines the Patchcord command-line interface. |
|
Package config loads the settings `patchcord serve` runs with from three layered sources — a YAML file, environment variables, and CLI flags — in that increasing order of precedence: a flag explicitly passed always wins, then an environment variable, then the config file, then a built-in default (ADR-0038).
|
Package config loads the settings `patchcord serve` runs with from three layered sources — a YAML file, environment variables, and CLI flags — in that increasing order of precedence: a flag explicitly passed always wins, then an environment variable, then the config file, then a built-in default (ADR-0038). |
|
Package connectors manages connector instances: persistent, named configurations for accessing an external system (vision document, section 7.3).
|
Package connectors manages connector instances: persistent, named configurations for accessing an external system (vision document, section 7.3). |
|
Package ghrelease resolves and downloads a pre-built package asset attached to a GitHub repository's Releases — a second, parallel install source alongside internal/registry's configured-registry lookups (ADR-0067).
|
Package ghrelease resolves and downloads a pre-built package asset attached to a GitHub repository's Releases — a second, parallel install source alongside internal/registry's configured-registry lookups (ADR-0067). |
|
Package mcpserver exposes Patchcord's installed-plugin catalog and workflow validation as an MCP (Model Context Protocol) server, so a coding agent (Claude Code, Codex) building a bundle/app can query real action/connector schemas and validate a workflow draft against the live catalog instead of guessing action ids or field names (ADR-0062, ADR-0063, ADR-0064).
|
Package mcpserver exposes Patchcord's installed-plugin catalog and workflow validation as an MCP (Model Context Protocol) server, so a coding agent (Claude Code, Codex) building a bundle/app can query real action/connector schemas and validate a workflow draft against the live catalog instead of guessing action ids or field names (ADR-0062, ADR-0063, ADR-0064). |
|
Package packaging holds the tar.gz archive primitives shared by every installable Patchcord package format (.patchcord-app, .patchcord-plugin, .patchcord-bundle): archiving a validated source directory, and safely extracting an untrusted archive back onto disk.
|
Package packaging holds the tar.gz archive primitives shared by every installable Patchcord package format (.patchcord-app, .patchcord-plugin, .patchcord-bundle): archiving a validated source directory, and safely extracting an untrusted archive back onto disk. |
|
Package persistence manages the agent's SQLite database: opening it with the pragmas Patchcord relies on, and applying versioned migrations.
|
Package persistence manages the agent's SQLite database: opening it with the pragmas Patchcord relies on, and applying versioned migrations. |
|
Package plugins launches Patchcord plugin processes and performs the protocol handshake described in the vision document (section 8.3).
|
Package plugins launches Patchcord plugin processes and performs the protocol handshake described in the vision document (section 8.3). |
|
embedded
Package embedded holds Patchcord's bundled reference plugins — text, json, encoding, http and time (plugins/examples/*, chosen because none of them has a concrete external service behind it) — as prebuilt executables embedded straight into the patchcord binary for the platform it was built for.
|
Package embedded holds Patchcord's bundled reference plugins — text, json, encoding, http and time (plugins/examples/*, chosen because none of them has a concrete external service behind it) — as prebuilt executables embedded straight into the patchcord binary for the platform it was built for. |
|
Package registry resolves a package id (optionally pinned to a version) against a small set of user-configured registries, closing the vision document's aspirational install-by-identifier command (section 9.2: "patchcord plugin install io.patchcord.postgresql@1.0.0", "depuis un registre futur") and unblocking bundle updates (ADR-0044).
|
Package registry resolves a package id (optionally pinned to a version) against a small set of user-configured registries, closing the vision document's aspirational install-by-identifier command (section 9.2: "patchcord plugin install io.patchcord.postgresql@1.0.0", "depuis un registre futur") and unblocking bundle updates (ADR-0044). |
|
Package runs is the run manager: it persists workflow versions, runs and their steps, and orchestrates execution on top of internal/workflow's engine and an ActionExecutor (typically internal/plugins.Supervisor).
|
Package runs is the run manager: it persists workflow versions, runs and their steps, and orchestrates execution on top of internal/workflow's engine and an ActionExecutor (typically internal/plugins.Supervisor). |
|
Package runtime manages the Patchcord agent's lifecycle: opening its database, launching and supervising its installed plugins, binding its local HTTP API, and shutting everything down cleanly on cancellation.
|
Package runtime manages the Patchcord agent's lifecycle: opening its database, launching and supervising its installed plugins, binding its local HTTP API, and shutting everything down cleanly on cancellation. |
|
Package scheduler fires workflows whose trigger is "schedule" (internal/workflow.Trigger, ADR-0035) on their declared cron cadence, unattended — no HTTP request or CLI invocation supplies inputs or bindings the way a manual run does.
|
Package scheduler fires workflows whose trigger is "schedule" (internal/workflow.Trigger, ADR-0035) on their declared cron cadence, unattended — no HTTP request or CLI invocation supplies inputs or bindings the way a manual run does. |
|
Package secrets resolves logical references to secret values.
|
Package secrets resolves logical references to secret values. |
|
Package signing manages Ed25519 key pairs used to sign and verify packages (.patchcord-plugin, .patchcord-app, .patchcord-bundle).
|
Package signing manages Ed25519 key pairs used to sign and verify packages (.patchcord-plugin, .patchcord-app, .patchcord-bundle). |
|
Package trust is the trust store for package signing keys (ADR-0043): it answers "is this public key approved to sign this package id?" — nothing about whether a signature is cryptographically valid in the first place, that's internal/packaging.Verify's job.
|
Package trust is the trust store for package signing keys (ADR-0043): it answers "is this public key approved to sign this package id?" — nothing about whether a signature is cryptographically valid in the first place, that's internal/packaging.Verify's job. |
|
Package version holds the agent binary's build-time version metadata.
|
Package version holds the agent binary's build-time version metadata. |
|
Package workflow implements the workflow engine: parsing and validating declarative workflow definitions, resolving their expressions, and the explicit state machines Run and Step transitions follow.
|
Package workflow implements the workflow engine: parsing and validating declarative workflow definitions, resolving their expressions, and the explicit state machines Run and Step transitions follow. |
Click to show internal directories.
Click to hide internal directories.