Documentation

Start with the decision you need to make.

Install the CLI, review an OpenAPI 3.0 or 3.1 contract locally, and use the versioned output in your engineering workflow.

OPENAPI SECURITY

Run a local scan

pipx install speculynx
speculynx scan --file openapi.yaml

Free scans run locally without a license or backend connection.

Understand scanner scope →
AGENT SECURITY

MAP → REVIEW → GATE

speculynx agent capabilities --file openapi.yaml
speculynx agent readiness --file openapi.yaml
speculynx agent gate --baseline main.yaml --candidate pr.yaml

Each command requires its matching Agent Security entitlement.

Understand Agent Security →

After purchase

From checkout to your first Agent Security result.

Agent Security uses an account-scoped CLI credential that is separate from the historical Speculynx Pro licence key.

1 / ACTIVATE

Confirm access in the dashboard

After Stripe Checkout, wait for backend-confirmed activation. The signed webhook—not the browser return page—creates billing records and entitlements.

2 / CONNECT

Create the CLI credential

Open Agent Security → CLI access, create the credential, and copy it immediately. The raw value is shown only once.

pipx install speculynx
speculynx access login
speculynx access info
3 / RUN

Run the products you own

speculynx agent capabilities --file openapi.yaml
speculynx agent readiness --file openapi.yaml
speculynx agent gate --baseline openapi-main.yaml --candidate openapi.yaml

Each command still requires its matching Agent Security entitlement.

Agent Security troubleshooting →

Additional workflow

Network Policy remains a separate CLI domain.

Speculynx also provides a declarative, fail-closed, export-only Network Policy workflow with a bounded nftables renderer. It does not apply firewall rules or authorize deployment.

View current package documentation on PyPI →

Inspect the contract before the agent acts.

Start with a local OpenAPI review, then choose the Agent Security workflow that matches your decision.

Analyze your API