@webring-kit/cli

Command-line tools for validating and maintaining Webring Kit ring manifests.

Install

pnpm add -D @webring-kit/cli

npm install --save-dev @webring-kit/cli

Commands

Validate a ring manifest

webring validate rings/example.json

Expected success output:

✓ rings/example.json: Indie Devs Webring (3 sites)

Check sites

webring check-sites rings/example.json

This command checks that the sites in the manifest are reachable. Depending on your configuration, it may also check reciprocal links or related site-health conditions.

Build an index

webring build-index rings/example.json --out public/webring-index.json

Use this when a project contains one or more ring manifests and you want to generate a static index for docs, examples, or a registry page.

Path behavior

The CLI resolves relative paths from the current working directory. Run it from your project root when using project-relative paths:

cd my-site
webring validate rings/example.json

CI example

- run: pnpm install --frozen-lockfile
- run: pnpm build
- run: pnpm exec webring validate rings/example.json

Related packages

• @webring-kit/core for the validation and navigation logic used by the CLI.
• @webring-kit/schemas for JSON Schema files.