Docs / Start / Getting started

Getting started

Five minutes from install to your first report. You need Node.js 22.12 or newer.

Install

Install the CLI. It needs Node.js 22.12 or newer.

npm install -g kedgeway

To hack on it, clone Klorenn/kedgeway, then npm ci, npm run build and npm link.

Check it worked:

kedgeway --help

Log in

kedgeway login

This opens your browser to authorize kedgeway with Stellar Raven. The authorization URL is also printed to the terminal, in case the browser does not open. You only do this once; the token is stored locally. Details are in Authentication.

Run your first diagnosis

kedgeway diagnose ./my-contract

The path is optional and defaults to the current directory. kedgeway walks the repo, fetches live ecosystem data, and prints a report.

Read the output

kedgeway: ./my-contract
Ecosystem: soroban-sdk current major 28, observed 2026-11-11T22:00:57Z

[CRITICAL] SDK_DEPRECATED  contracts/hello/Cargo.toml
  soroban-sdk 21.0.0 is on a major listed as deprecated (current: 28). Upgrade.
  evidence: major 21 < current major 28 and appears in the Scout deprecated sample (source: <source>, observed <time>).
[CRITICAL] JS_LEGACY_PACKAGE  package.json
  soroban-client 1.0.0 is a legacy package; replace it with @stellar/stellar-sdk.
  evidence: Legacy package name detected in manifest; reference: <source>, observed <time>.

Summary: 2 critical, 0 warning, 0 info

Header

The root that was scanned, and the current soroban-sdk major with the time it was observed.

Each finding

Severity, code and file on the first line, then what it means, then the evidence and its source.

Summary

Counts by severity.

Every code is explained in Findings. In the example, <source> and <time> stand in for the real source string and timestamp.

Use --json for machine-readable output and --fail-on to turn findings into an exit code. See Commands.