Skip to content

cli.md

Latest commit

 

History

History
93 lines (66 loc) · 2.11 KB

cli.md

File metadata and controls

93 lines (66 loc) · 2.11 KB

CLI Reference

Limier exposes four top-level commands:

  • limier run
  • limier inspect
  • limier render
  • limier version

limier run

Use this to compare one dependency upgrade in an isolated fixture.

limier run \
  --ecosystem npm \
  --package left-pad \
  --current 1.0.0 \
  --candidate 1.1.0 \
  --fixture fixtures/npm-app \
  --scenario scenarios/npm.yml \
  --rules rules/default.yml \
  --report out/limier/report.json \
  --summary out/limier/summary.md \
  --evidence out/limier/evidence

Flags:

  • --ecosystem: ecosystem adapter to use
  • --package: dependency name to compare
  • --current: baseline version
  • --candidate: candidate version
  • --fixture: path to the sample application directory
  • --scenario: path to the scenario manifest
  • --rules: path to the rules file
  • --report: path for the JSON report, default report.json
  • --summary: path for the Markdown summary, default summary.md
  • --evidence: directory for evidence files, default evidence

Supported ecosystems today:

  • cargo
  • npm
  • pip

limier inspect

Use this when you already have a report.json file and want a concise explanation without rerunning the fixture.

limier inspect --input out/limier/report.json

Flags:

  • --input: existing report.json
  • --output: optional output file for the inspection text

limier render

Use this to turn an existing report into a downstream surface such as a CI summary or PR comment.

limier render --format build-summary --input out/limier/report.json

Flags:

  • --format: one of github-comment, gitlab-note, or build-summary
  • --input: existing report.json
  • --output: optional output file

limier version

Print the current Limier version:

limier version

Logging

Limier also supports simple logging controls through environment variables:

  • LIMIER_LOG_LEVEL: debug, info, warn, or error
  • LIMIER_LOG_FORMAT: set to json for structured output; any other value, or leaving it unset, uses the default text format

Example:

LIMIER_LOG_LEVEL=debug LIMIER_LOG_FORMAT=json limier run ...