Skip to main content

Crate skeg_cli

Crate skeg_cli 

Source
Expand description

skeg-cli - operator tools for skeg.

Three subcommands ship in v0.1:

  • build - offline Vamana index builder. Reads a vector dataset (.npy or .fbin) and writes a ready-to-serve skeg data directory. See build_index.
  • inspect - offline introspection of a data directory: VINDEX names, dims, vector counts, file sizes per shard. See inspect.
  • stats - RESP3 client that fetches SKEG.STATS, SKEG.SHARDS, and SKEG.VINDEX.LIST from a running server. See stats.

The build output layout mirrors a single-shard data directory:

<output>/shard-0/vindexes.registry
<output>/shard-0/vindex-<name>/graph.vmn
<output>/shard-0/vindex-<name>/vectors.bin

Modules§

inspect
Offline inspection of a skeg data directory.
stats
Minimal RESP3 client for the skeg-cli stats subcommand.

Structs§

BuildStats
Summary of a completed offline build.

Functions§

build_index
Read a dataset from input and build a ready-to-serve index under output.
build_index_from
Build a Vamana index over an already-loaded dataset and write it under output as a ready-to-serve data directory.
read_header
Parse only the format header of path, returning (byte_offset, n, dim): where the f32 payload begins and its shape. The payload itself is not read, so a large dataset is not pulled into the heap.
read_vectors
Read a row-major f32 dataset, returning (data, n, dim).