Directories
¶
| Path | Synopsis |
|---|---|
|
Package approval decides whether a publish may go ahead.
|
Package approval decides whether a publish may go ahead. |
|
Package auth finds the GitHub token, runs the GitHub App device flow, and keeps the login in the OS keychain.
|
Package auth finds the GitHub token, runs the GitHub App device flow, and keeps the login in the OS keychain. |
|
authtest
Package authtest is a fake GitHub OAuth server for device-flow and refresh tests.
|
Package authtest is a fake GitHub OAuth server for device-flow and refresh tests. |
|
Package cli is the ghostbranch command line: it parses flags, builds an engine, and renders results as text or as one JSON envelope.
|
Package cli is the ghostbranch command line: it parses flags, builds an engine, and renders results as text or as one JSON envelope. |
|
style
Package style adds ANSI colour to human terminal output.
|
Package style adds ANSI colour to human terminal output. |
|
Package config parses .ghostbranch.yml, which lives only on the shadow repo's overlay branch.
|
Package config parses .ghostbranch.yml, which lives only on the shadow repo's overlay branch. |
|
Package console asks a person to confirm on the console device, never on stdin or stdout, so piping `yes` or capturing output cannot answer it.
|
Package console asks a person to confirm on the console device, never on stdin or stdout, so piping `yes` or capturing output cannot answer it. |
|
Package contract defines the machine-readable surface of every command: exit codes, stable error and warning codes, and the JSON envelope.
|
Package contract defines the machine-readable surface of every command: exit codes, stable error and warning codes, and the JSON envelope. |
|
Package engine implements every Ghostbranch operation.
|
Package engine implements every Ghostbranch operation. |
|
Package feature defines a feature's metadata (feature.json, stored on refs/ghostbranch/features/<name> in the shadow repo) and computes its state.
|
Package feature defines a feature's metadata (feature.json, stored on refs/ghostbranch/features/<name> in the shadow repo) and computes its state. |
|
Package forge is the boundary between the engine and a code host.
|
Package forge is the boundary between the engine and a code host. |
|
fake
Package fake is an in-memory Forge whose repos are local bare git repos.
|
Package fake is an in-memory Forge whose repos are local bare git repos. |
|
github
Package github is the GitHub adapter: the only code in Ghostbranch that imports a GitHub API client.
|
Package github is the GitHub adapter: the only code in Ghostbranch that imports a GitHub API client. |
|
Package gitx runs the git CLI.
|
Package gitx runs the git CLI. |
|
Package grant stores agent grants: a person's permission, made at a console, for agents to publish to one repo pair from this machine.
|
Package grant stores agent grants: a person's permission, made at a console, for agents to publish to one repo pair from this machine. |
|
Package guard installs and runs a git pre-push hook that refuses to push Ghostbranch feature work to the public repo (spec §11).
|
Package guard installs and runs a git pre-push hook that refuses to push Ghostbranch feature work to the public repo (spec §11). |
|
Package guide is the agent guide: embedded in the binary so it always matches it, with its code tables rendered from the contract registry, plus the small user-level skill that points agents at it.
|
Package guide is the agent guide: embedded in the binary so it always matches it, with its code tables rendered from the contract registry, plus the small user-level skill that points agents at it. |
|
Package keychain stores secrets in the operating system's credential store: the macOS Keychain, Windows Credential Manager or the Linux Secret Service, through go-keyring.
|
Package keychain stores secrets in the operating system's credential store: the macOS Keychain, Windows Credential Manager or the Linux Secret Service, through go-keyring. |
|
Package leak scans exactly what will be published: the tree, its paths, commit metadata, branch name and PR text.
|
Package leak scans exactly what will be published: the tree, its paths, commit metadata, branch name and PR text. |
|
Package ledger is the local, append-only record of every mutating action and who triggered it.
|
Package ledger is the local, append-only record of every mutating action and who triggered it. |
|
Package managed holds the overlay files Ghostbranch writes and keeps up to date (today only the opt-in sync workflow), and decides whether the copy on an overlay branch is current.
|
Package managed holds the overlay files Ghostbranch writes and keeps up to date (today only the opt-in sync workflow), and decides whether the copy on an overlay branch is current. |
|
Package overlay defines which repo paths belong to the shadow-only overlay.
|
Package overlay defines which repo paths belong to the shadow-only overlay. |
|
Package plan defines a promote plan: exactly what will be published, and the repo state it was made against.
|
Package plan defines a promote plan: exactly what will be published, and the repo state it was made against. |
|
Package preview is the typed "what would change" list that --plan and --dry-run return instead of acting (spec §9.2).
|
Package preview is the typed "what would change" list that --plan and --dry-run return instead of acting (spec §9.2). |
|
Package progress is how the engine says what a slow command is doing: named steps, one running at a time, and one-off notes.
|
Package progress is how the engine says what a slow command is doing: named steps, one running at a time, and one-off notes. |
|
Package prompt asks a person questions on the console device (/dev/tty, or CONIN$ and CONOUT$ on Windows), never on stdin or stdout.
|
Package prompt asks a person questions on the console device (/dev/tty, or CONIN$ and CONOUT$ on Windows), never on stdin or stdout. |
|
Package strip builds the tree promote publishes: the feature without overlay paths, and without the internal sections marked inside files.
|
Package strip builds the tree promote publishes: the feature without overlay paths, and without the internal sections marked inside files. |
|
Package testutil holds helpers for tests only.
|
Package testutil holds helpers for tests only. |
|
Package updatecheck tells people and agents about newer Ghostbranch releases (spec 6.4a § 3).
|
Package updatecheck tells people and agents about newer Ghostbranch releases (spec 6.4a § 3). |
|
Package waiver stores leak-finding waivers: a person's decision, made at a console, that one finding's exact content may be published.
|
Package waiver stores leak-finding waivers: a person's decision, made at a console, that one finding's exact content may be published. |
|
Package workflow reads GitHub Actions workflow files: the repo guards, secrets and push triggers the CI audit reports, and the guard rewrite the gate applies to its CI candidate.
|
Package workflow reads GitHub Actions workflow files: the repo guards, secrets and push triggers the CI audit reports, and the guard rewrite the gate applies to its CI candidate. |
|
Package workspace manages local state: the state dir, workspaces and their repo pairs, per-pair mirror paths, the pair lock, and working out which pair a command targets.
|
Package workspace manages local state: the state dir, workspaces and their repo pairs, per-pair mirror paths, the pair lock, and working out which pair a command targets. |
Click to show internal directories.
Click to hide internal directories.