vantage-check
The agent-facing CLI for Vantage: it emits the Markdown conventions Vantage's renderer expects, and checks that a document really renders.
$ vantage-check docs/ # check every Markdown file under docs/
$ vantage-check check docs/design/api.md --format json
$ vantage-check style-guide # print the conventions
Design: ../../docs/design/agent-cli.md.
User documentation: ../../userguide/vantage-check.md.
Why this package is shaped the way it is
- Never published to npm.
vantage-mdon npm stays a pure rendering library; this package is"private": trueand ships only as a compiled binary. That keeps a lint-time dependency tree out of the library. - It imports
vantage-md's TypeScript source by relative path rather than depending on the built package. Acheckthat answers "will this render in Vantage" has to run the code the viewer runs; a second implementation would drift invisibly and pass documents the viewer breaks on. - It never needs a server. Every command works offline against files on disk — no port, no socket, no "is Vantage running" check.
Layout
| Path | What lives there |
|---|---|
src/cli.ts |
Argument parsing and dispatch — no filesystem, no process |
src/commands/ |
One file per command |
src/core/ |
Config, file discovery, document parsing, heading slugs |
src/rules/ |
One file per rule family; each owns its failure classification |
src/report/ |
Text and JSON output |
scripts/ |
The single-file binary and the Python wheel |
Building the binary
$ npm run build # dist/vantage-check for this host, ~90 MB
$ bun ./scripts/build.ts --target bun-darwin-arm64 # or any other platform
npm run build is bun build --compile: the whole program and a bun runtime in
one file, with the version and commit inlined at compile time. The size is the
runtime; it is the price of a tool that runs in a sandbox with nothing
installed.
bun cross-compiles, so one host builds every platform — that is why the
release job is a single runner rather than one per OS. Release CI wraps each
binary in a platform wheel (../../scripts/build-wheel.py) so uvx vantage-check
works, and attaches the archives to a GitHub release for the curl path.
1 maintainer
Metadata
1 maintainer
Release files for vantage-check 0.5.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| vantage_check-0.5.7-py3-none-manylinux_2_28_x86_64.whl | Python 3 | none | Linux glibc 2.28+ x86-64 | Details |
| vantage_check-0.5.7-py3-none-manylinux_2_28_aarch64.whl | Python 3 | none | Linux glibc 2.28+ ARM64 | Details |
| vantage_check-0.5.7-py3-none-macosx_11_0_x86_64.whl | Python 3 | none | macOS 11.0+ x86-64 | Details |
| vantage_check-0.5.7-py3-none-macosx_11_0_arm64.whl | Python 3 | none | macOS 11.0+ ARM64 | Details |
Total release size: 135.5 MB
Release files / vantage_check-0.5.7-py3-none-manylinux_2_28_x86_64.whl
| Download URL | vantage_check-0.5.7-py3-none-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 38.6 MB |
| Tags | Linux glibc 2.28+ x86-64 Python 3 |
|
SHA-256 checksum How to use checksums |
77b4e481eceea9fe427f33f016fc106ce0b4223416482a07667909881d68ecb8
|
|
BLAKE2b-256 checksum How to use checksums |
19e8374ec9791e305273da527b78d219bd772d884b98640e3daab7c9cd70d169
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.9 {"installer":{"name":"uv","version":"0.12.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / vantage_check-0.5.7-py3-none-manylinux_2_28_aarch64.whl
| Download URL | vantage_check-0.5.7-py3-none-manylinux_2_28_aarch64.whl |
|---|---|
| Size | 38.5 MB |
| Tags | Linux glibc 2.28+ ARM64 Python 3 |
|
SHA-256 checksum How to use checksums |
8d7307f213dec2aa1e0541d267c7fa2bda1dd4602d242629246f9c7201005756
|
|
BLAKE2b-256 checksum How to use checksums |
aa4675fbb1caf4cd43ea3ceface43b3767502cc6c77816b2a24b5cc053a44a45
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.9 {"installer":{"name":"uv","version":"0.12.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / vantage_check-0.5.7-py3-none-macosx_11_0_x86_64.whl
| Download URL | vantage_check-0.5.7-py3-none-macosx_11_0_x86_64.whl |
|---|---|
| Size | 30.5 MB |
| Tags | Python 3 macOS 11.0+ x86-64 |
|
SHA-256 checksum How to use checksums |
befbb8f091ec6a1fdde7de1947dbf35b65e16dc0f77c2b6643f4163cc8b94700
|
|
BLAKE2b-256 checksum How to use checksums |
d1c5f020276d59948bde13731299cccd9f0a27ae80b83896e330958451f1c1bf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.9 {"installer":{"name":"uv","version":"0.12.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / vantage_check-0.5.7-py3-none-macosx_11_0_arm64.whl
| Download URL | vantage_check-0.5.7-py3-none-macosx_11_0_arm64.whl |
|---|---|
| Size | 27.9 MB |
| Tags | Python 3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
5cca27c2972708b582b16ef2123610f7d2343b35a216ec816d8c7b6feda37806
|
|
BLAKE2b-256 checksum How to use checksums |
2316f70321b03e82aa23097bd420444b4f64f1caf00794096b7399fbc2f4751a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.9 {"installer":{"name":"uv","version":"0.12.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
