Documentation

Reference

Information-oriented specifications: exact keys, routes, flags, and their defaults. Consult these while working; the explanation section covers why velodex shapes them this way.

  • Installation

    The install channels, the platforms each covers, and how each one updates.

  • Configuration

    Every TOML key, flag, and default. Precedence is defaults < TOML file < environment < flags.

  • HTTP endpoints

    The routes every index serves, plus health and metrics.

  • API explorer

    Per-endpoint request and response breakdown with copyable examples, generated from the code.

  • Command line

    The velodex binary's commands and flags.

  • Capability matrix

    Which roles and features velodex supports per ecosystem. PyPI ships today; OCI and npm are planned.

  • Glossary (FAQ)

    Plain-language answers to the terms velodex uses: index, cached/hosted/virtual, ecosystem, shadowing, upstream, publish, wheel, sdist, artifact.