Command-line utility

At its core, proselint is a command-line utility.

❯ proselint

Running this command prints a list of suggestions to stdout, one per line. Each suggestion will have the form:<line>:<column>: <check_name> <message>

For example, wallace.uncomparables Comparison of an uncomparable: 'unique' cannot be compared.

The command line utility can also print the list of suggestions in JSON using the --json flag. In this case, the output is considerably richer and matches the output of the web API.

    // Type of check that output this suggestion.
    check: "wallace.uncomparables",

    // Message to describe the suggestion.
    message: "Comparison of an uncomparable: 'unique' cannot be compared.",

    // The person or organization giving the suggestion.
    source: "David Foster Wallace"

    // URL pointing to the source material.
    source_url: ""

    // Line where the error starts.
    line: 0,

    // Column where the error starts.
    column: 10,

    // Index in the text where the error starts.
    start: 10,

    // Index in the text where the error ends.
    end: 21,

    // start - end
    extent: 11,

    // How important is this? Can be "suggestion", "warning", or "error".
    severity: "warning",

    // Possible replacements.
    replacements: [
            value: "unique"

For questions and feature requests, write to us at