Get APX running in your project in 5 minutes. Install the CLI, initialize a sample pack, run your first check, and explore the results.
APX provides both npm and Python package managers. Choose whichever fits your workflow.
Verify installation: Run apx --version to confirm the CLI is installed.
Run apx init to drop a sample PackSpec and constraints into your repository. This creates a baseline policy for your project.
apx.packspec.json — Your policy pack definition.apx/constraints/ — Sample constraints (e.g., encryption, access control).apx/config.json — Local configurationTip: Review the generated PackSpec to understand the baseline constraints. You can customize these for your project's needs.
Execute apx check --json to analyze your codebase against the PackSpec. APX will emit three JSON files with results.
Core evaluation results: PASS/WARN/BLOCK, constraint satisfaction, margins, and locations
Audit trail: complete evaluation history, timestamps, and lineage for compliance
Semantic health metrics: debt accumulation, trends, and quality indicators
Open the JSON files in Studio Lite or your IDE extension to visualize constraints, health metrics, and violations.
Visual interface for exploring Pack structure, constraints, and semantic violations
Open Studio LiteLaunch Studio Lite directly with your check results
Success! You've run your first APX check. Now integrate it into your CI/CD pipeline to catch semantic drift before it reaches production.
Use this one-liner in README files, documentation, or onboarding guides:
Try APX in 5 minutes: npm i -g @apx/cli && apx init && apx check --json, then open check.core.json in Studio Lite or your IDE to see PASS/WARN/BLOCK, health, and receipts.