Skip to content

    Type a page, a command such as keryn scan, or a rule id.

    Workbench commands

    Describes Keryn 0.5.2 and keryn-rules 0.8.0. Changelog

    View as Markdown

    These commands run in keryn-native, the Rust binary that the CLI archives ship beside keryn. Their flags and exit codes are its own.

    Throughline graph pipeline over an evidence project: attack paths, defensive breakpoints, report (local only).

    Usage: keryn graph [options]
    Throughline graph pipeline over an evidence project: attack paths, defensive breakpoints, report (local only)
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn graph --help
    Code Meaning
    0 success
    2 usage error
    4 internal error

    Attack paths introduced or resolved between two git refs of a repository.

    Usage: keryn diff-scan [options]
    attack paths introduced or resolved between two git refs of a repository
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn diff-scan --help
    Code Meaning
    0 success
    2 usage error
    4 internal error

    Final report artifacts (report.md, manifest, split reports) from an existing scan output directory.

    Usage: keryn report [options]
    final report artifacts (report.md, manifest, split reports) from an existing scan output directory
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn report --help
    Code Meaning
    0 success
    2 usage error
    4 internal error

    Build or inspect the evidence bundle of a finding.

    Usage: keryn evidence [options]
    build or inspect the evidence bundle of a finding
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn evidence --help
    Code Meaning
    0 success
    2 usage error
    4 internal error

    Generate or check a local-only validation plan for a finding candidate.

    Usage: keryn validate [options]
    generate or check a local-only validation plan for a finding candidate
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn validate --help
    Code Meaning
    0 success
    2 usage error
    4 internal error

    Apply the false-positive downgrade rules to a candidate finding.

    Usage: keryn triage [options]
    apply the false-positive downgrade rules to a candidate finding
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn triage --help
    Code Meaning
    0 success
    2 usage error
    4 internal error

    Reproduce a finding in a hardened sandbox container: Confirmed, Refuted or Indeterminate.

    Usage: keryn verify [options]
    reproduce a finding in a hardened sandbox container: Confirmed, Refuted or Indeterminate
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn verify --help
    Code Meaning
    0 success
    2 usage error
    4 internal error

    Run a reviewer over ledger findings, see the queue, inspect one finding per reviewer (claims, never decisions).

    Usage: keryn adjudicate [options]
    run a reviewer over ledger findings, see the queue, inspect one finding per reviewer (claims, never decisions)
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn adjudicate --help
    Code Meaning
    0 success
    2 usage error
    4 internal error

    Propose fixes for ledger findings and check the code each one names is there (never writes a repository).

    Usage: keryn remediate [options]
    propose fixes for ledger findings and check the code each one names is there (never writes a repository)
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn remediate --help
    Code Meaning
    0 success
    2 usage error
    4 internal error

    Read the ledger: findings, scans, targets, judgements, fixes, retests, rulings, disclosures (JSON).

    Usage: keryn explore [options]
    read the ledger: findings, scans, targets, judgements, fixes, retests, rulings, disclosures (JSON)
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn explore --help
    Code Meaning
    0 success
    2 usage error
    4 internal error

    Measure the estate: coverage, observation-to-disclosure funnel, reviewer spend, source value.

    Usage: keryn measure [options]
    measure the estate: coverage, observation-to-disclosure funnel, reviewer spend, source value
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn measure --help
    Code Meaning
    0 success
    2 usage error
    4 internal error

    Enforce a retention window on the local profile, or erase it.

    Usage: keryn retention [options]
    enforce a retention window on the local profile, or erase it
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn retention --help
    Code Meaning
    0 success
    2 usage error
    4 internal error

    Enrich one partner finding from a JSON file (the POST /v1/analysis engine).

    Usage: keryn analyze [options]
    enrich one partner finding from a JSON file (the POST /v1/analysis engine)
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn analyze --help
    Code Meaning
    0 success
    2 usage error
    4 internal error

    Captured DOM -> AI overread, PII exposure and prompt injection report.

    Usage: keryn dom-analysis [options]
    captured DOM -> AI overread, PII exposure and prompt injection report
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn dom-analysis --help
    Code Meaning
    0 success
    2 usage error
    4 internal error

    Check (and safely fix) the local Keryn environment.

    Usage: keryn doctor [options]
    check (and safely fix) the local Keryn environment
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn doctor --help
    Code Meaning
    0 success
    2 usage error
    4 internal error

    Sign evidence, a Verify packet or an AI-BOM as an in-toto statement in a DSSE envelope; attest keygen.

    Usage: keryn attest [options]
    sign evidence, a Verify packet or an AI-BOM as an in-toto statement in a DSSE envelope; attest keygen
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn attest --help
    Code Meaning
    0 success
    2 usage error
    4 internal error

    Verify an attestation signature and that the evidence in hand is what was signed.

    Usage: keryn verify-attestation [options]
    verify an attestation signature and that the evidence in hand is what was signed
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn verify-attestation --help
    Code Meaning
    0 success
    2 usage error
    4 internal error

    OSCAL 1.2 assessment results for a scan result (observations only, not a compliance determination).

    Usage: keryn oscal [options]
    OSCAL 1.2 assessment results for a scan result (observations only, not a compliance determination)
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn oscal --help
    Code Meaning
    0 success
    2 usage error
    4 internal error

    Update the known-fix (n-day) signature database from a signed release.

    Usage: keryn nday-db [options]
    update the known-fix (n-day) signature database from a signed release
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn nday-db --help
    Code Meaning
    0 success
    2 usage error
    4 internal error

    Assess OSV records and package queries from one bounded JSON batch on stdin.

    Usage: keryn sca-assess [options]
    assess OSV records and package queries from one bounded JSON batch on stdin
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn sca-assess --help
    Code Meaning
    0 success
    2 usage error
    4 internal error

    Inventory lockfile/metadata text from stdin (no files, network or state; 1 MiB cap).

    Usage: keryn sca-inventory [options]
    inventory lockfile/metadata text from stdin (no files, network or state; 1 MiB cap)
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn sca-inventory --help
    Code Meaning
    0 success
    2 usage error
    4 internal error

    Match lockfile/metadata text from stdin against supplied OSV records.

    Usage: keryn sca-match [options]
    match lockfile/metadata text from stdin against supplied OSV records
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn sca-match --help
    Code Meaning
    0 success
    2 usage error
    4 internal error

    Check installed npm declarations in a package-lock v2/v3 on stdin.

    Usage: keryn sca-requirements [options]
    check installed npm declarations in a package-lock v2/v3 on stdin
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn sca-requirements --help
    Code Meaning
    0 success
    2 usage error
    4 internal error

    Observe one recorded NuGet graph from a bounded project.assets.json on stdin.

    Usage: keryn sca-project-assets [options]
    observe one recorded NuGet graph from a bounded project.assets.json on stdin
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn sca-project-assets --help
    Code Meaning
    0 success
    2 usage error
    4 internal error

    Observe fixed package-firewall predicates from bounded raw job JSON on stdin.

    Usage: keryn fw-policy-observe [options]
    observe fixed package-firewall predicates from bounded raw job JSON on stdin
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn fw-policy-observe --help
    Code Meaning
    0 success
    2 usage error
    4 internal error

    Physical-cell liveness of one method in JVM class or JAR bytes on stdin.

    Usage: keryn jvm-liveness [options]
    physical-cell liveness of one method in JVM class or JAR bytes on stdin
    Runs in keryn-native, which was not found on PATH or next to keryn (it ships beside keryn in the keryn-<version>-<platform> archives; or build it: cargo build --release -p keryn-cli --bin keryn-native; or set KERYN_NATIVE=<path>).
    Terminal window
    # Arguments and flags, from the keryn-native binary that runs this command.
    keryn jvm-liveness --help
    Code Meaning
    0 success
    2 usage error
    4 internal error