CLI Getting Started Guide

Install and Configure Your API

The published package is @aelira/cli. Its runtime requires Node.js 22 or later. The CLI is MIT licensed; the engine it calls is AGPL-3.0. Server-backed document workflows require an Aelira API deployment and its supporting services.

bun add --global @aelira/cli
aelira --version
aelira config set api-url https://api.example.edu
aelira config validate
aelira auth login

Replace the example API URL with your approved deployment. The login command prompts for an available authentication method. Configure automation credentials through your institution's approved secret handling process. Review providers, fallbacks, egress, logs, caches, and backups before processing sensitive files. See the deployment guide for server setup.

Scan a Representative Sample

Start with synthetic or authorized representative files. These commands produce findings or review artifacts; they do not certify accessibility conformance.

aelira scan pdf lecture-notes.pdf --format json --output pdf-findings.json
aelira scan docx syllabus.docx --format json --output word-findings.json
aelira scan ppt slides.pptx --format csv --output slide-findings.csv
aelira scan xlsx workbook.xlsx --format json --output spreadsheet-findings.json
aelira scan latex equations.tex --format json --output math-findings.json

PowerPoint uses scan ppt. Supported issue scans export console, JSON, or CSV results. Image and video commands have different outputs; consult the CLI reference for the selected command.

Apply Supported Fixes and Inspect the Saved File

Where the scan supports remediation, use the returned scan identifier. File type, dependencies, and findings determine the available fixes. Some files leave unresolved issues or produce no usable artifact.

# Replace SCAN_ID with the identifier returned by your scan
aelira remediate SCAN_ID --download --output reviewed-document.pdf

Inspect the downloaded file, reading order, tables, image meaning, equations, and rendering. Test it with appropriate assistive technology, record manual repairs, and approve publication only after review. A better scan score does not establish WCAG or PDF/UA conformance.

Evaluate Batch Processing and Monitoring

Document scan commands accept a file or directory. Test a small directory before automating a larger inventory. Record processing time, failures, human review, and remaining manual work within your agreed allowance.

aelira scan pdf ./course-materials/ --format json --output directory-findings.json
aelira scan watch ./incoming/ --extensions .pdf,.docx,.pptx --concurrency 3

Watching a directory scans changed files; it does not authorize publication or replacement of originals. Throughput and time savings must be measured in your deployment.

Keep Findings and Review Records

aelira report evidence DEPARTMENT_ID --output evidence-report.pdf
aelira report compliance DEPARTMENT_ID --format json --output scan-statistics.json

Replace the department identifier with your configured department. The evidence report describes scanned-content findings, methods, and limitations. The deprecated report compliance command provides scan statistics; neither command makes an accessibility or legal determination. Keep human review and unresolved issues alongside these records.

Validate Connectors Before Rollout

Canvas: The maintainer reports production integration testing. Validate your own institution's permissions, policy, and full user journey before rollout. Brightspace is beta; Blackboard and Moodle are experimental. Validate permissions, discovery, scan scope, saved output, and the approved publication path in your own environment.

aelira canvas status --department DEPARTMENT_ID
aelira canvas courses --department DEPARTMENT_ID
aelira canvas files COURSE_ID --department DEPARTMENT_ID
aelira canvas scan COURSE_ID --wait --department DEPARTMENT_ID

Canvas remediation is a separate command. Its --upload-back option replaces a live course file; agree authorization and review before using it. See connector readiness and the current command reference.