Skip to content

Reference

Reference pages describe the Octoform 0.3 contract. Guides explain how to operate it; this section records the contract, patch availability, and evidence.

Product contract

Configuration

Every accepted field, precedence rule, observation boundary, plan result, endpoint mapping, recovery path, and unsupported case.

Browse configuration

Command line

Read/write boundaries, options, selection, confirmation, output, partial failure, authentication, and exit codes.

Browse CLI commands

Audited evidence

Published package contents, confirmed implementation behavior, permissions, limitations, and the reviewed GitHub API disposition register.

Open the 0.3.1 baseline

The GitHub API surface register records relevant REST and GraphQL operations. Its machine-readable source contains the complete generated operation data.

Programmatic API

The package root exports the same building blocks used by the CLI:

Area Exports
Configuration loadConfig, resolvePolicy, repoType, isExcluded, isManaged, ConfigError
GitHub observation createClient, listRepos, getRepoDetail, readRepoFile, capability helpers
Planning planRepo, plan
Classification classifyRepo, pathsUsedBy, classify
Apply applyRepoChanges, apply, propertiesSync
Reporting formatChange, groupByRepo, audit
Types Configuration, policy, repository state, change, resource, and owner-kind types

Prefer the CLI unless an integration already owns authentication, complete repository observation, output, and error handling. The latest verified 0.3 patch publishes the deterministic TypeDoc JSON reference and checksummed configuration, CLI, capability, permission, and API manifests.

Compatibility notes

  • Runtime: Node.js 20 or newer.
  • Package format: ESM.
  • Machine-readable CLI output: not available in 0.3.
  • REST API version header: not explicitly set by 0.3.
  • GraphQL transport: not used by 0.3.
  • Documentation line: 0.3; latest verified application patch: 0.3.2.

0.3.2 is a maintenance-only patch and preserves the configuration, command, capability, permission, public-export, and plan/apply contracts audited for 0.3.1. The 0.3.1 behavior baseline therefore remains the historical implementation evidence for this release line. Consult the changelog for patch-level availability.