Skip to main content

Scapius CLI Tool Reference

The Scapius CLI is distributed as an official Docker container image for cross-platform execution with zero host dependencies.

Running with Docker​

Basic Usage​

docker run --rm -v $(pwd):/workspace scapiusea/scapius <command> [options]

Creating a Permanent Alias​

Add the following alias to your ~/.bashrc, ~/.zshrc, or PowerShell profile:

alias scapius='docker run --rm -v $(pwd):/workspace scapiusea/scapius'

Commands​

validate​

Parses .ea files and executes the complete static semantic analysis suite.

# Validate a single file
scapius validate ./architecture/main.ea

# Validate an entire directory of .ea files
scapius validate ./architecture

Common Options​

FlagDescription
--verboseOutput detailed AST generation steps and resolution logs
--strictTreat warnings as fatal errors
--jsonOutput validation diagnostics in machine-readable JSON format

compile​

Compiles an architecture workspace into an intermediate representation or static JSON AST model.

scapius compile /workspace/architecture --output /workspace/dist/model.json

CI / GitHub Actions Pipeline Integration​

name: Validate Scapius Architecture
on: [push, pull_request]

jobs:
  validate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - name: Validate .ea files with Scapius Docker
        run: |
          docker run --rm -v ${{ github.workspace }}:/workspace scapiusea/scapius validate /workspace --strict