dataspine

Root command for the Dataspine CLI.

Usage

dataspine [OPTIONS] <COMMAND>

Commands

• sts: Token exchange utilities. See dataspine sts
• artifacts: Configure access to Dataspine artifact registries. See dataspine artifacts
• compile: Compile .spine sources into a build artifact. See dataspine compile
• check: Validate .spine sources and report diagnostics. See dataspine check

Checking and compiling Spine

Spine is checked and compiled to JSON build artifacts by the Dataspine CLI (dataspine).

Command	Purpose
dataspine check	Parse and type-check; emit diagnostics
dataspine compile	Produce build artifact JSON at --out

Common flags:

• --source-dir — recursive .spine discovery
• --in-file — single file
• --root-namespace — required prefix; must match how your product’s root namespace is declared in .spine sources
• --lib — additional type libraries (JSON files or directories)
• -o/--output-type — text, json, yaml for CLI output
• Authentication — see the root options below

Pipeline:

1. Parse — Spine source is read into an internal program representation.
2. Check and build — types are resolved and a build artifact is produced when you run compile.
3. Artifact JSON — consumed by the runtime / control plane as configured by your deployment.

Diagnostics may be parse errors (unexpected character, unbalanced delimiters) or type and build diagnostics after parsing. Use --output-type json for machine-readable output.

Options

These options apply to all subcommands:

• -o, --output-type <OUTPUT_TYPE>: Output format
  • default: text
  • possible values: text, json, yaml
• -a, --auth <AUTH>: Authentication method
  • default: env
  • possible values:
    • env
    • token:<token>
    • token-exchange:<token>
    • aws-sigv4:<principal_id>

Authentication examples

Use a token from the environment:

export DATASPINE_TOKEN="…"
dataspine -a env check --source-dir ./spine-src --root-namespace my.company

Use a provided token directly:

dataspine -a "token:…" check --source-dir ./spine-src --root-namespace my.company

Exchange an input token:

dataspine -a "token-exchange:…" sts exchange-token "…"