CLI
This page documents the dsl command-line interface.
If you’re new here, start with Quickstart.
Common workflow
Section titled “Common workflow”Most teams use the CLI like this:
- Apply a spec to a local DataSheet folder
- Review the changes (
git diff) - Run whatever validations/tests your project uses
- Commit the spec + resulting XML changes
Commands
Section titled “Commands”dsl apply
Section titled “dsl apply”Apply a spec file to a DataSheet folder:
dsl apply <spec.yaml> --path <path>- Reads the YAML spec
- Validates it
- Applies the changes to the XML files under
--path
dsl validate
Section titled “dsl validate”Validate a spec without writing changes:
dsl validate <spec.yaml> [--path <path>]Use this in CI or pre-commit checks.
dsl explain
Section titled “dsl explain”Explain computed equipment values for an item in a spec:
dsl explain <spec.yaml> <item_id> --formulas <stat-formulas.yaml>This is primarily used to debug computation inputs and see “why” a stat was derived.
dsl regenerate equipment
Section titled “dsl regenerate equipment”Bulk-regenerate equipment stats from existing XML using tier mapping + formulas:
dsl regenerate equipment --path <data> --tiers <tiers.yaml> --formulas <formulas.yaml>Use this when:
- formulas change, and you need to retune many items
- tier rules change, and you need to recompute large sets consistently