@fettle/cli

@fettle/cli

Command-line interface for Fettle — grade the maintenance health of GitHub repositories.

export GITHUB_TOKEN=...
npx @fettle/cli --repos vitest-dev/vitest --format markdown

fettle --repos acme/api,acme/web --format json > report.json
fettle --repos acme/api --fail-below C            # exit 1 if it grades below C
fettle --repos acme/api --api-url https://ghe.acme.com/api/v3

Exit codes: 0 success, 1 graded below --fail-below, 2 invalid usage, 3 a repository or its configuration could not be read.

Programmatic use

The supported interface is the fettle command. The package also exports the pieces it is built from — run, parseCliOptions, render, and the exit codes — for wrapping the command in your own entry point:

import { run, EXIT_BELOW_FLOOR } from '@fettle/cli';

For scanning from code, use @fettle/core instead; it is the library, and this is a shell around it.

Run fettle --help for all flags. Full documentation: github.com/rumankazi/fettle.