Documentation
¶
Overview ¶
Syntropy — bulk-refactor sweep CLI. See README.md, DESIGN.md, and the decisions/ log for the project's purpose and design.
This file is the CLI surface; business logic lives under internal/.
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
config
Package config reads and writes syntropy's per-user config file, ~/.syntropy/config.yaml.
|
Package config reads and writes syntropy's per-user config file, ~/.syntropy/config.yaml. |
|
eventstream
Package eventstream is a single-process workflow.EventStreamer backed by the sqlite event_log / event_cursors tables (see internal/store), so an in-flight event survives a daemon restart.
|
Package eventstream is a single-process workflow.EventStreamer backed by the sqlite event_log / event_cursors tables (see internal/store), so an in-flight event survives a daemon restart. |
|
filter
Package filter evaluates the agent-authored Starlark filter on every event.
|
Package filter evaluates the agent-authored Starlark filter on every event. |
|
git
Package git wraps the git CLI for everflow's worktree + commit + push operations.
|
Package git wraps the git CLI for everflow's worktree + commit + push operations. |
|
poller
Package poller drives event ingress by polling the provider's API instead of receiving webhooks.
|
Package poller drives event ingress by polling the provider's API instead of receiving webhooks. |
|
provider
Package provider defines the abstraction between everflow and an MR-hosting platform (GitLab, GitHub).
|
Package provider defines the abstraction between everflow and an MR-hosting platform (GitLab, GitHub). |
|
provider/github
Package github implements provider.Provider for github.com and GitHub Enterprise Server.
|
Package github implements provider.Provider for github.com and GitHub Enterprise Server. |
|
provider/gitlab
Package gitlab implements provider.Provider for GitLab.com and self-hosted GitLab instances.
|
Package gitlab implements provider.Provider for GitLab.com and self-hosted GitLab instances. |
|
reconciler
Package reconciler detects Runs stuck on a lost in-memory event: the sync.Cond EventStreamer (ADR-0033) has no durable queue, so an event dropped between a daemon restart and its delivery leaves the Run's AgentState in StatusWorking or StatusDiscovering forever, with nothing to wake it back up.
|
Package reconciler detects Runs stuck on a lost in-memory event: the sync.Cond EventStreamer (ADR-0033) has no durable queue, so an event dropped between a daemon restart and its delivery leaves the Run's AgentState in StatusWorking or StatusDiscovering forever, with nothing to wake it back up. |
|
refactorsweep
Package refactorsweep defines the v1 state machine: AgentState held in the workflow's Run.Object, the AgentStatus enum that drives transitions, and the Decision/Turn/Budget types shared with the runner.
|
Package refactorsweep defines the v1 state machine: AgentState held in the workflow's Run.Object, the AgentStatus enum that drives transitions, and the Decision/Turn/Budget types shared with the runner. |
|
retention
Package retention periodically deletes terminal Runs (Completed or Cancelled — see internal/store.ListTerminalRuns) that have sat untouched past a configurable retention period, removing both their store rows and their on-disk run directory.
|
Package retention periodically deletes terminal Runs (Completed or Cancelled — see internal/store.ListTerminalRuns) that have sat untouched past a configurable retention period, removing both their store rows and their on-disk run directory. |
|
runner
Package runner is the abstraction between the workflow loop and a coding agent (Claude Code, Qwen Code, OpenHands).
|
Package runner is the abstraction between the workflow loop and a coding agent (Claude Code, Qwen Code, OpenHands). |
|
runner/claude
Package claude implements runner.Runner by shelling out to the `claude` CLI.
|
Package claude implements runner.Runner by shelling out to the `claude` CLI. |
|
setup
Package setup installs the Claude Code Skill bundle that ADR-0002 decided on, so that Claude Code knows when and how to invoke the syntropy binary.
|
Package setup installs the Claude Code Skill bundle that ADR-0002 decided on, so that Claude Code knows when and how to invoke the syntropy binary. |
|
spec
Package spec parses everflow spec documents — markdown files with YAML frontmatter.
|
Package spec parses everflow spec documents — markdown files with YAML frontmatter. |
|
store
Sqlite-backed implementations of workflow.RecordStore and workflow.TimeoutStore.
|
Sqlite-backed implementations of workflow.RecordStore and workflow.TimeoutStore. |
|
webhook
Package webhook hosts the HTTP server that ingests provider webhooks and dispatches them to the workflow runtime via workflow.Callback.
|
Package webhook hosts the HTTP server that ingests provider webhooks and dispatches them to the workflow runtime via workflow.Callback. |
Click to show internal directories.
Click to hide internal directories.