Aegis SDK Overview

What This Page Controls

This overview is the shared contract page for SDK docs. It defines package names, endpoint assumptions, and command-block classification expectations for every SDK lane.

• Production control-plane endpoint: https://axis.velikey.com.
• Tenant/auth context is operator-specific and remains manual-only.
• Language pages must preserve package/import names from this contract.

Prerequisites

Before running SDK examples, verify local tooling and endpoint reachability. This command block is manual-only because operators may run it in environment-specific contexts.

# manual-only example
export AXIS_BASE_URL="${AXIS_BASE_URL:-https://axis.velikey.com}"
command -v python3
command -v node
command -v go
curl -fsS "$AXIS_BASE_URL/auth/signin" -o /dev/null

Expected output: each command -v line returns a local binary path, and the signin endpoint request completes without transport errors.

SDK Package and Import Contract

Use only these package/module identifiers in docs and examples:

• Python package/import: velikey
• JavaScript/TypeScript package: @velikey/sdk
• Go module/import: github.com/sgreysond/velikey-go-sdk

# illustrative example
python -m pip install "git+https://github.com/sgreysond/velikey-python-sdk.git@v0.1.0#egg=velikey"
npm install github:sgreysond/velikey-js-sdk#v0.2.1
go get github.com/sgreysond/velikey-go-sdk

Command Classification Contract

Every SDK docs command block must use one of the classification markers below so automation can distinguish CI-safe checks from operator-context workflows.

# illustrative example
# executable example: local, read-only checks suitable for CI smoke.
# manual-only example: tenant credentials, deployment context, or mutating workflows.
# illustrative example: reference snippets intentionally not executed in CI.

Language Guide Integration

Python, JavaScript, and Go SDK implementation pages are maintained in language-specific lanes and must align with this shared contract at merge time.

Python SDK Guide • JavaScript SDK Guide • Go SDK Guide

If a language guide conflicts with package names or endpoint assumptions above, record the issue in the SDK mismatch register before release.

Cycle 3 Closeout Requirement

Shared docs contracts must remain green while lane-level audits and live-proof evidence are consolidated for final SDK cycle closeout.

Do not merge SDK reporting updates if command validation, route-depth, or snippet contract checks regress.

Navigate Docs

Docs Index • Engineers Portal • Aegis Overview • Axis Overview • Troubleshooting