> ## Documentation Index
> Fetch the complete documentation index at: https://docs.istravex.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Run the full kit locally, then point it at your own code.

You can be useful with Istravex in three ways, depending on how much you want to install. Pick the one that fits.

> [tab] Just look
>
> No install. The hosted API serves the corpus and every result.
>
> ```bash theme={null}
> # The headline numbers
> curl https://api.istravex.com/v1/stats
>
> # Every fixture, then one manifest
> curl https://api.istravex.com/v1/fixtures
> curl https://api.istravex.com/v1/fixtures/cap27-muxed-payment-pubnet-0001
>
> # The raw XDR, exactly as stored
> curl https://api.istravex.com/v1/fixtures/cap27-muxed-payment-pubnet-0001/files/envelope
> ```
>
> See the [API reference](https://docs.istravex.com/api-reference/introduction.md) for everything else.

> [tab] Replay into your indexer
>
> If your indexer reads ledgers from Stellar RPC, point it at the public mock RPC instead. It speaks `getLedgers` and serves the corpus's canonical ledgers.
>
> ```bash theme={null}
> curl -X POST https://rpc.istravex.com/pubnet \
>   -H 'content-type: application/json' \
>   -d '{"jsonrpc":"2.0","id":1,"method":"getHealth"}'
> ```
>
> Use `https://rpc.istravex.com/pubnet`, `/testnet` or `/local` as your RPC URL, ingest the ledgers it reports, and compare what you stored against each fixture's `expected_indexed`. [Replaying into your indexer](https://docs.istravex.com/pilots/your-indexer.md) walks through it.

> [tab] Run everything
>
> Clone the repository and run the whole pipeline. You'll need Node 24, Go 1.25 and a stable Rust toolchain.
>
> **1. Install**
>
> ```bash theme={null}
> git clone https://github.com/hackcat29/istravex
> cd istravex
> npm ci
> ```
>
> **2. Run the kit**
>
> ```bash theme={null}
> node kit/goldens/fetch.mjs   # once: stellar-core's golden ledgers (~80 MB)
> npm run corpus:run
> ```
>
> This verifies every fixture against its canonical ledger, runs the JavaScript, Go and Rust SDK checks, round-trips stellar-core's golden ledgers, replays the corpus through the reference indexers, and regenerates `src/data/corpus.json`.
>
> **3. Confirm it's green**
>
> ```bash theme={null}
> node kit/check-results.mjs
> # all green: 6 fixtures
> ```
>
> **4. Optional: the upstream pilot and the audit**
>
> ```bash theme={null}
> npm run pilot:wallet-backend   # runs wallet-backend's ingestion over the corpus
> npm run corpus:audit           # re-audits CAP coverage from stellar-protocol
> ```

## Lint your Go indexer

`istravex-lint` runs anywhere Go does. No clone required:

```bash theme={null}
go run github.com/hackcat29/istravex/kit/go/cmd/istravex-lint@latest ./...
```

Each finding names its rule (`IX001` to `IX003`) and links to an explanation. Read [istravex-lint](https://docs.istravex.com/tools/lint.md) before adding it to CI. It's tuned to stay quiet on correct code, and you'll want to know how to suppress a finding you've reviewed.

## Serve the corpus yourself

```bash theme={null}
npm run rpc -- --network pubnet --port 8000   # mock Stellar RPC only
npm run api                                    # the full API on :8080
```

## Where to go next

> [card] [Concepts](https://docs.istravex.com/concepts.md)
>
> How fixtures, canonical ledgers and verdicts fit together.

> [card] [Hardening guide](https://docs.istravex.com/guide/overview.md)
>
> The rules the corpus exists to enforce.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.