adacovex usage guide

This section holds the user guide for adacovex. Each page stands on its own. You can read one page without the others, and every page links to the API reference for the exact subprogram or flag.

All pages use British English and ASD-STE100 Simplified Technical English. Paragraphs hold at most four sentences. The controlled Technical Names dictionary lives in STE100 Technical Names, and the web-site terms used on the site transparency page live in web site terms.

Install and run

• Installing adacovex – the Alire crate, the release bundle, and the source build, with the version source for each route.

• Target project requirements – what a target project must contain before adacovex can assess it.

• Web dashboard and JSON API – --serve, the HTML report at /, the JSON API at /api/metrics, and the served badges.

Assess a project

• CLI reference – every command, flag, and exit code. The detailed flag pages are assessment flags and subcommands, serving, CI, and tool options, and emitted reports and differential modes.

• Compliance standards – DO-178C, ISO 26262, and IEC 62304. The per-standard detail is on DO-178C and the DAL levels, ISO 26262 and the ASIL levels, IEC 62304 and the safety classes, and selecting a standard.

• VCS support and differential assessment – the differential modes across git, hg, svn, fossil, and jj.

Read the results

• Dashboard document and dependency views – the layout of the report and every dependency view it draws.

• Dashboard metric charts and robustness tier – the charts, the sparklines, and the robustness tier.

• Dashboard JSON API, playground, and themes – the API schema, the theme resolution order, and the localStorage theme key.

• Bundled offline manual – the manual that --serve exposes at /docs, and how it is embedded in the binary.

• SBOM – the proof-aware CycloneDX and SPDX bill of materials. SBOM dependency resolution holds the licence and dependency lookup.

• HLR index and LLR mapping – the requirement traceability, and verification results for a full run.

Publish in CI

• CI/CD – the GitHub Action and the workflow summary. The internals are on CI/CD workflows, summaries, and release bundling and the composite action, and the release path is on release bundling, tags, and consumer manifests.

Manage the toolchain

• Global configuration and state – the optional the global configuration file file, the environment variables, and the cache and toolchain directories.

• Platform support – supported platforms and the toolchain state of each.

Where to look next

• The API reference lists every package, type, and subprogram with its contracts.

• The site transparency page states what the online manual records when you read it.

• The contributor guide covers setup, gates, and the release workflow for people who change adacovex itself.

• The changelogs hold the release history.