Docs / Start / Overview

Overview

kedgeway is a command-line tool that tells you how outdated a Stellar or Soroban repo's toolchain is. It reads your manifests, asks the live ecosystem what is current, and reports the gap with its sources.

What it is

A CLI that scans Cargo.toml (soroban-sdk) and package.json (@stellar/stellar-sdk, @stellar/stellar-base, and the legacy soroban-client and stellar-sdk).
Grounded in live data from the Stellar Raven MCP server: the official Software Versions page and the Scout ecosystem toolchain index.
Evidence-first. Every finding cites its source and the time it was observed.
Honest about failure. If a source cannot be reached, the report says DATA_DEGRADED instead of guessing.

What it is not

Not a rewriter. diagnose never changes your repo. Migration prints a guide and bumps version strings. It never runs cargo or npm.
Not a full lockfile auditor. It uses the resolved version of the direct dependency when a supported lockfile has one verdict, and falls back to the manifest otherwise.
Not a security or contract audit. It only measures SDK version drift.
Not a service. Your repo contents never leave your machine. See Authentication.

How it thinks

Scan. Walk the repo and collect SDK dependencies from manifests.
Ask Raven. Fetch the current versions and the deprecated sample once per run.
Diagnose. Compare each dependency with the ecosystem and print findings by severity.

Where to read next

Getting started: Install from npm, log in, run your first diagnosis.
Authentication: How login works and what is stored.
Commands: Every command, flag and exit code.
Findings: Every finding code and what to do about it.
CI: Failing a build on drift.
Fixtures: Run offline with a saved snapshot.
TypeScript SDK: Call diagnose and migrate from your own code.
MCP server: Let AI assistants diagnose a repo.
GitHub Action: Gate pull requests on drift.
Migration mode: A guide from the snapshot, then version bumps.
What it scans: Manifest forms, skipped folders, version ranges.
Data sources: Where ground truth comes from.
Architecture: Core, ports, adapters, CLI.
Limitations: What kedgeway does not do.
FAQ: Short answers.