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.5
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.5-py3-none-manylinux_2_28_x86_64.whl | Python 3 | none | Linux glibc 2.28+ x86-64 | Details |
| vantage_check-0.5.5-py3-none-manylinux_2_28_aarch64.whl | Python 3 | none | Linux glibc 2.28+ ARM64 | Details |
| vantage_check-0.5.5-py3-none-macosx_11_0_x86_64.whl | Python 3 | none | macOS 11.0+ x86-64 | Details |
| vantage_check-0.5.5-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.5-py3-none-manylinux_2_28_x86_64.whl
| Download URL | vantage_check-0.5.5-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 |
8467978cf4ab55e765e0509c745376bcb7c391319955672a034b6617235c7bcf
|
|
BLAKE2b-256 checksum How to use checksums |
d6b4d08792804b68d986a8e8e59d35447f4718fb338c3bb44ab42bd48a69eb38
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.8 {"installer":{"name":"uv","version":"0.12.8","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.5-py3-none-manylinux_2_28_aarch64.whl
| Download URL | vantage_check-0.5.5-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 |
2d3d58cef3a940e1774345317a411609650797b381d23f551ea284abca75c41e
|
|
BLAKE2b-256 checksum How to use checksums |
a5b0de960eaba5a74ef4919cdb2ddbabbc3d9b26f3bec6b09b682c617a7936aa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.8 {"installer":{"name":"uv","version":"0.12.8","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.5-py3-none-macosx_11_0_x86_64.whl
| Download URL | vantage_check-0.5.5-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 |
19ac5feeed031aedfd1a53892517af05a64bee801c20a785215cbb962f7119eb
|
|
BLAKE2b-256 checksum How to use checksums |
ebff822ec3df2d2148505312cc6aa3af2141a375f8cf0dad89c4d96ce0f22980
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.8 {"installer":{"name":"uv","version":"0.12.8","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.5-py3-none-macosx_11_0_arm64.whl
| Download URL | vantage_check-0.5.5-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 |
7a964bb67a52bb995ca77ddcd7f0d3af62aafd26e0a188acdf182da172ab8f92
|
|
BLAKE2b-256 checksum How to use checksums |
9a0ecd44423d06ea28f63946fe7bb59a9235c4ad45917f3572b75f43f337b4d5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.8 {"installer":{"name":"uv","version":"0.12.8","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}
|
