AUDIENCE.md

CLI

Create and validate AUDIENCE.md locally.

AudienceMD includes a minimal npm-published command-line app for local workflows. Use it to start from the canonical template and validate real files without leaving Markdown.

Publication status: the CLI is available on npm as @audiencemd/cli. The package exposes both audience and audiencemd binaries.
Package usage
# run without installing globally
pnpm --package=@audiencemd/cli dlx audience init ./my-project
pnpm --package=@audiencemd/cli dlx audience validate ./my-project

# npm/npx equivalent
npx @audiencemd/cli init ./my-project
npx @audiencemd/cli validate ./my-project
Repository checkout usage
# from the AudienceMD repository checkout
pnpm install
pnpm exec audience --help
pnpm exec audience init ./my-project
pnpm exec audience validate ./my-project

Commands

audience init [path] [--force]

Create an AUDIENCE.md from the packaged canonical template. Defaults to the current directory and will not overwrite an existing file unless --force is supplied.

audience validate [path]

Validate an AUDIENCE.md file, or a directory containing AUDIENCE.md, against the advisory v0.1 rules.

audiencemd

Alias binary for the same CLI commands.

Install style

For one-off use, prefer pnpm --package=@audiencemd/cli dlx audience or npx @audiencemd/cli. In this monorepo, pnpm exec audience remains the development path for testing local changes before release.