Documentation
¶
Overview ¶
Command rtksync imports rtk's entire TOML filter catalog into specs/rtk.json.
It is the canonical, Go-native generator for specs/rtk.json: rather than hand-editing that file, run rtksync to (optionally) clone upstream rtk and convert every TOML filter deterministically via the rtkcompat package. The runtime stays JSON-only and zero-dependency; this tool — and its TOML dependency — lives in the rtkcompat module.
Usage:
# clone rtk and regenerate ../specs/rtk.json (run from the rtkcompat dir): go run ./cmd/rtksync # use an existing checkout, pin a release, or just check for drift: go run ./cmd/rtksync -dir /path/to/rtk go run ./cmd/rtksync -ref v0.42.4 go run ./cmd/rtksync -check # exit non-zero if specs/rtk.json is stale
Flags:
-out output path (default ../specs/rtk.json) -repo rtk git URL (default https://github.com/codefly-dev/rtk) -ref git ref/tag to clone (default: repo default branch) -dir existing rtk checkout (skips cloning) -glob filter glob in rtk (default src/filters/*.toml) -exclude comma-separated filter names to skip -check diff instead of write; non-zero exit on drift
Click to show internal directories.
Click to hide internal directories.