MarginCI documentation

Start with one declared operation and a meaningful success check. Review the V0 support boundary before running a comparison.

• Getting Started

  Set up a declared operation, fixed cases and a success check for your first MarginCI unit-cost comparison.

• First Adoption

  Prepare an existing Node or TypeScript repository for MarginCI, including supported dependencies, revision isolation and operation wrappers.

• Configuration

  Configure MarginCI operations, revisions, provider rates and regression thresholds. Reference the local CLI commands and exit statuses.

• Providers

  Review the bounded OpenAI-compatible, Firecrawl and Exa endpoints, usage requirements and valuation modes supported by MarginCI V0.

• Measurement

  Understand cost per successful operation, comparison identity, failed-attempt spend and the limits of the MarginCI spend guard.

• GitHub Actions

  Add a MarginCI CI cost regression check with explicit handling of trusted code, fork pull requests, provider credentials and retained reports.

• JSON Output

  Integrate MarginCI machine-readable reports and exit statuses, including PASS, FAIL and INCONCLUSIVE measurement outcomes.

• Security

  Review MarginCI runner trust, credential handling, local artifacts, redaction limits and retained data before running a comparison.

• Support Boundary

  Check the validated Node 25.3.0 and macOS arm64 boundary, supported repository shapes and excluded execution modes before using MarginCI.