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.6.1
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.6.1-py3-none-manylinux_2_28_x86_64.whl | Python 3 | none | Linux glibc 2.28+ x86-64 | Details |
| vantage_check-0.6.1-py3-none-manylinux_2_28_aarch64.whl | Python 3 | none | Linux glibc 2.28+ ARM64 | Details |
| vantage_check-0.6.1-py3-none-macosx_11_0_x86_64.whl | Python 3 | none | macOS 11.0+ x86-64 | Details |
| vantage_check-0.6.1-py3-none-macosx_11_0_arm64.whl | Python 3 | none | macOS 11.0+ ARM64 | Details |
Total release size: 138.5 MB
Release files / vantage_check-0.6.1-py3-none-manylinux_2_28_x86_64.whl
| Download URL | vantage_check-0.6.1-py3-none-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 39.3 MB |
| Tags | Linux glibc 2.28+ x86-64 Python 3 |
|
SHA-256 checksum How to use checksums |
efa597f3116924940390a8de06d40f242600599b53f6c54b37fe7d5f03113858
|
|
BLAKE2b-256 checksum How to use checksums |
24a3fb8e50800729b1e5cf36638179bf41e43f33c0e04256f9f080c2300e8a1d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.17 {"installer":{"name":"uv","version":"0.12.17","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.6.1-py3-none-manylinux_2_28_aarch64.whl
| Download URL | vantage_check-0.6.1-py3-none-manylinux_2_28_aarch64.whl |
|---|---|
| Size | 39.3 MB |
| Tags | Linux glibc 2.28+ ARM64 Python 3 |
|
SHA-256 checksum How to use checksums |
4c95cfc57050a42ca4e746cee9d8ea5d1f3d2f795ab31c0c53604cb6be7010cf
|
|
BLAKE2b-256 checksum How to use checksums |
40732a27807688142765a6be17a9ef83a0955508e7a0aacf4ebfcb3ec77a320f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.17 {"installer":{"name":"uv","version":"0.12.17","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.6.1-py3-none-macosx_11_0_x86_64.whl
| Download URL | vantage_check-0.6.1-py3-none-macosx_11_0_x86_64.whl |
|---|---|
| Size | 31.2 MB |
| Tags | Python 3 macOS 11.0+ x86-64 |
|
SHA-256 checksum How to use checksums |
8bf761f5d639fe7e9074396cf31f4eba8b40f87c5fbf53fcb26a8fac52c56b6b
|
|
BLAKE2b-256 checksum How to use checksums |
fe797f0a61b840ec5a79f569f6e62561236a3103185a0e200126998fdc88e254
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.17 {"installer":{"name":"uv","version":"0.12.17","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.6.1-py3-none-macosx_11_0_arm64.whl
| Download URL | vantage_check-0.6.1-py3-none-macosx_11_0_arm64.whl |
|---|---|
| Size | 28.7 MB |
| Tags | Python 3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
a4c3d5c745766318c0c8fc551a64c033285a6c5834d6af1e8ae9708e53755b8f
|
|
BLAKE2b-256 checksum How to use checksums |
cabd8327192d4ed71e998bf36f231c00d3630c2276d50852c8e4ad08742b30f7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.17 {"installer":{"name":"uv","version":"0.12.17","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}
|
