Ayni

Appearance

Generated reference. Change the CLI definition, then run cargo doc-cli > docs/cli.md; do not edit this file directly.

Command-Line Help for ayni ​

This document contains the help content for the ayni command-line program.

Command Overview:

ayni ​

Reproducible environments, focused feedback, explicit completion evidence

Usage: ayni <COMMAND>

Subcommands: ​
  • init — Preview or write a minimal policy from adapter-owned project discovery
  • env — Inspect and manage the repository code environment
  • tools — Preview signal-tool declarations, baseline drift, and blockers
  • contract — Inspect the repository quality contract
  • verify — Run focused signals or list exact commands from saved evidence
  • impact — Explain or run the checks affected by an explicit change
  • check — Run the complete repository quality contract
  • agents — Manage Ayni's agent instructions
  • results — Inspect and compare explicit local result files

ayni init ​

Preview or write a minimal policy from adapter-owned project discovery

Usage: ayni init [OPTIONS]

Options: ​

  • --repo-root <REPO_ROOT> — Repository root to inspect and where .ayni.toml will be written

    Default value: .

  • --dry-run — Print the proposed policy without writing it (the default behavior)

  • --write — Create .ayni.toml; refuses to overwrite an existing policy

ayni env ​

Inspect and manage the repository code environment

Usage: ayni env <COMMAND>

Subcommands: ​
  • show — Explain the resolved environment plan without modifying state
  • doctor — Diagnose missing, conflicting, unsupported, or stale environment state
  • lock — Resolve exact environment requirements into the committed lock
  • build — Build the repository code-environment image from a current lock
  • storage — Report Ayni-managed OCI images and repository-local environment state
  • prune — Preview or remove stale repository state and explicitly selected images

ayni env show ​

Explain the resolved environment plan without modifying state

Usage: ayni env show [OPTIONS]

Options: ​

  • --config <CONFIG> — Policy configuration file, resolved under the repository root

    Default value: ./.ayni.toml

  • --repo-root <REPO_ROOT> — Repository root that contains the policy and configured targets

    Default value: .

  • --output <OUTPUT> — Render a human-readable plan or one JSON document

    Default value: human

    Possible values:

    • human: Human-readable terminal output
    • json: One deterministic JSON document on stdout

ayni env doctor ​

Diagnose missing, conflicting, unsupported, or stale environment state

Usage: ayni env doctor [OPTIONS]

Options: ​

  • --repo-root <REPO_ROOT>

    Default value: .

ayni env lock ​

Resolve exact environment requirements into the committed lock

Usage: ayni env lock [OPTIONS]

Options: ​

  • --config <CONFIG> — Policy configuration file, resolved under the repository root

    Default value: ./.ayni.toml

  • --repo-root <REPO_ROOT> — Repository root where .ayni.lock will be written

    Default value: .

  • --base <BASE> — Exact provisioning base as <reference>@sha256:<digest>; defaults to pinned upstream Debian

ayni env build ​

Build the repository code-environment image from a current lock

Usage: ayni env build [OPTIONS]

Options: ​

  • --repo-root <REPO_ROOT> — Repository containing the committed environment lock

    Default value: .

  • --executor-image <REFERENCE@sha256:DIGEST> — Use this immutable builder image to supply Ayni without changing the environment lock

  • --tag <TAG> — Local tag applied to the built image. This does not publish it

  • --cache-from <CACHE> — Import an external Buildx cache; repeat for multiple sources. Does not change the lock

  • --cache-to <CACHE> — Export an external Buildx cache; repeat for multiple destinations. Does not change the lock

ayni env storage ​

Report Ayni-managed OCI images and repository-local environment state

Usage: ayni env storage [OPTIONS]

Options: ​

  • --repo-root <REPO_ROOT> — Repository root whose current lock and materialized state are inspected

    Default value: .

  • --output <OUTPUT> — Render a human-readable report or one JSON document

    Default value: human

    Possible values:

    • human: Human-readable terminal output
    • json: One deterministic JSON document on stdout

ayni env prune ​

Preview or remove stale repository state and explicitly selected images

Usage: ayni env prune [OPTIONS]

Options: ​

  • --repo-root <REPO_ROOT> — Repository root whose current environment is retained unless --current is set

    Default value: .

  • --output <OUTPUT> — Render a human-readable report or one JSON document

    Default value: human

    Possible values:

    • human: Human-readable terminal output
    • json: One deterministic JSON document on stdout

  • --apply — Remove selected candidates; without this flag the command is read-only

  • --images — Include non-current Ayni-owned images across the selected engine.

    Images can be shared by multiple repositories. This flag explicitly acknowledges the engine-wide scope; without it, only repository-local stale state is selected for removal.

  • --current — Include the current repository-local environment state.

    The next managed command recreates it from the locked image. Current images remain retained because they can be shared across repositories.

ayni tools ​

Preview signal-tool declarations, baseline drift, and blockers

Usage: ayni tools <COMMAND>

Subcommands: ​
  • reconcile — Inspect native tooling without changing files or executing package managers

ayni tools reconcile ​

Inspect native tooling without changing files or executing package managers

Usage: ayni tools reconcile [OPTIONS]

Options: ​

  • --config <CONFIG>

    Default value: ./.ayni.toml

  • --repo-root <REPO_ROOT>

    Default value: .

  • --output <OUTPUT>

    Default value: human

    Possible values:

    • human: Human-readable terminal output
    • json: One deterministic JSON document on stdout

  • --check — Fail when reconciliation is required or inspection is blocked

ayni contract ​

Inspect the repository quality contract

Usage: ayni contract <COMMAND>

Subcommands: ​
  • show — Render and validate the effective quality contract

ayni contract show ​

Render and validate the effective quality contract

Usage: ayni contract show [OPTIONS]

Options: ​

  • --config <CONFIG>

    Default value: ./.ayni.toml

  • --output <OUTPUT>

    Default value: human

    Possible values:

    • human: Human-readable terminal output
    • json: One deterministic JSON document on stdout

ayni verify ​

Run focused signals or list exact commands from saved evidence

Usage: ayni verify <COMMAND>

Subcommands: ​
  • list — List exact verification commands from a saved current-schema artifact
  • test — Run only the test signal
  • coverage — Run only the coverage signal
  • size — Run only the size signal
  • complexity — Run only the complexity signal
  • deps — Run only the dependency signal
  • mutation — Run only the mutation signal

ayni verify list ​

List exact verification commands from a saved current-schema artifact

Usage: ayni verify list [OPTIONS]

Options: ​

  • --artifact <ARTIFACT> — Saved schema-v4 result artifact to inspect

    Default value: ./.ayni/last/signals.json

ayni verify test ​

Run only the test signal

Usage: ayni verify test [OPTIONS]

Options: ​

  • --config <CONFIG>

    Default value: ./.ayni.toml

  • --language <LANGUAGE>

    Possible values: rust, go, node, python, kotlin

  • --root <ROOT> — Select exactly one normalized root configured for the selected language

  • --output <OUTPUT>

    Default value: human

    Possible values:

    • human: Human-readable terminal output
    • json: One deterministic JSON document on stdout
    • markdown: Deterministic Markdown output

  • --debug — Print raw command diagnostics

  • --file <FILE>

  • --package <PACKAGE>

  • --name <NAME>

ayni verify coverage ​

Run only the coverage signal

Usage: ayni verify coverage [OPTIONS]

Options: ​

  • --config <CONFIG>

    Default value: ./.ayni.toml

  • --language <LANGUAGE>

    Possible values: rust, go, node, python, kotlin

  • --root <ROOT> — Select exactly one normalized root configured for the selected language

  • --output <OUTPUT>

    Default value: human

    Possible values:

    • human: Human-readable terminal output
    • json: One deterministic JSON document on stdout
    • markdown: Deterministic Markdown output

  • --debug — Print raw command diagnostics

ayni verify size ​

Run only the size signal

Usage: ayni verify size [OPTIONS]

Options: ​

  • --config <CONFIG>

    Default value: ./.ayni.toml

  • --language <LANGUAGE>

    Possible values: rust, go, node, python, kotlin

  • --root <ROOT> — Select exactly one normalized root configured for the selected language

  • --output <OUTPUT>

    Default value: human

    Possible values:

    • human: Human-readable terminal output
    • json: One deterministic JSON document on stdout
    • markdown: Deterministic Markdown output

  • --debug — Print raw command diagnostics

  • --file <FILE>

ayni verify complexity ​

Run only the complexity signal

Usage: ayni verify complexity [OPTIONS]

Options: ​

  • --config <CONFIG>

    Default value: ./.ayni.toml

  • --language <LANGUAGE>

    Possible values: rust, go, node, python, kotlin

  • --root <ROOT> — Select exactly one normalized root configured for the selected language

  • --output <OUTPUT>

    Default value: human

    Possible values:

    • human: Human-readable terminal output
    • json: One deterministic JSON document on stdout
    • markdown: Deterministic Markdown output

  • --debug — Print raw command diagnostics

  • --file <FILE>

  • --package <PACKAGE>

ayni verify deps ​

Run only the dependency signal

Usage: ayni verify deps [OPTIONS]

Options: ​

  • --config <CONFIG>

    Default value: ./.ayni.toml

  • --language <LANGUAGE>

    Possible values: rust, go, node, python, kotlin

  • --root <ROOT> — Select exactly one normalized root configured for the selected language

  • --output <OUTPUT>

    Default value: human

    Possible values:

    • human: Human-readable terminal output
    • json: One deterministic JSON document on stdout
    • markdown: Deterministic Markdown output

  • --debug — Print raw command diagnostics

  • --file <FILE>

  • --package <PACKAGE>

ayni verify mutation ​

Run only the mutation signal

Usage: ayni verify mutation [OPTIONS]

Options: ​

  • --config <CONFIG>

    Default value: ./.ayni.toml

  • --language <LANGUAGE>

    Possible values: rust, go, node, python, kotlin

  • --root <ROOT> — Select exactly one normalized root configured for the selected language

  • --output <OUTPUT>

    Default value: human

    Possible values:

    • human: Human-readable terminal output
    • json: One deterministic JSON document on stdout
    • markdown: Deterministic Markdown output

  • --debug — Print raw command diagnostics

ayni impact ​

Explain or run the checks affected by an explicit change

Usage: ayni impact <COMMAND>

Subcommands: ​
  • show — Explain the quality work affected by a change without running it
  • run — Execute the quality work affected by a change

ayni impact show ​

Explain the quality work affected by a change without running it

Usage: ayni impact show [OPTIONS] --base <BASE>

Options: ​

  • --config <CONFIG>

    Default value: ./.ayni.toml

  • --base <BASE> — Explicit base revision used to calculate the change

  • --output <OUTPUT>

    Default value: human

    Possible values:

    • human: Human-readable terminal output
    • json: One deterministic JSON document on stdout
    • markdown: Deterministic Markdown output

ayni impact run ​

Execute the quality work affected by a change

Usage: ayni impact run [OPTIONS] --base <BASE>

Options: ​

  • --config <CONFIG>

    Default value: ./.ayni.toml

  • --base <BASE> — Explicit base revision used to calculate the change

  • --output <OUTPUT>

    Default value: human

    Possible values:

    • human: Human-readable terminal output
    • json: One deterministic JSON document on stdout
    • markdown: Deterministic Markdown output

  • --debug — Print raw command diagnostics

ayni check ​

Run the complete repository quality contract

Usage: ayni check [OPTIONS]

Options: ​

  • --config <CONFIG>

    Default value: ./.ayni.toml

  • --output <OUTPUT>

    Default value: human

    Possible values:

    • human: Human-readable terminal output
    • json: One deterministic JSON document on stdout
    • markdown: Deterministic Markdown output

  • --debug — Print raw command diagnostics

ayni agents ​

Manage Ayni's agent instructions

Usage: ayni agents <COMMAND>

Subcommands: ​
  • sync — Create or refresh only Ayni's managed AGENTS.md block

ayni agents sync ​

Create or refresh only Ayni's managed AGENTS.md block

Usage: ayni agents sync [OPTIONS]

Options: ​

  • --repo-root <REPO_ROOT>

    Default value: .

ayni results ​

Inspect and compare explicit local result files

Usage: ayni results <COMMAND>

Subcommands: ​
  • compare — Compare two explicit compatible result files

ayni results compare ​

Compare two explicit compatible result files

Usage: ayni results compare [OPTIONS] --baseline <BASELINE> --candidate <CANDIDATE>

Options: ​

  • --baseline <BASELINE> — Earlier result file

  • --candidate <CANDIDATE> — Later result file

  • --output <OUTPUT>

    Default value: human

    Possible values:

    • human: Human-readable terminal output
    • json: One deterministic JSON document on stdout

This document was generated automatically by clap-markdown.