Skip to content

API Reference

Guidance for spanforge-secrets, aligned with the same reading rhythm, navigation model, and contrast system used across the rest of the site.

API Reference

The API reference focuses on the stable interfaces you can call from automation or internal tooling.

Current status

This page is currently served from a generated fallback so the published documentation route remains usable. It provides the core context teams need while source markdown is being finalized.

Recommended workflow

  1. Install the tool in the same environment where your build or validation steps run.
  2. Execute it locally against representative inputs before wiring it into CI.
  3. Promote the exact same command shape into automation so local and pipeline behavior stay aligned.

Example

from spanforge_secrets import run

Where this fits

spanforge-secrets belongs to the build phase of the SpanForge system. It should feel consistent with the rest of the platform: clear purpose, deterministic outputs, and documentation that helps teams move from experiment to governed production.