Installation and commands

Install the package and use its CLI for validation, YAML output, and reverse generation.

When to use

Use these commands in local development and CI before requesting target-language code.

Behavior

inspect reads .service-architect/project.yaml without executing Python.
validate executes the declared trusted Python entrypoint in a bounded child process and returns diagnostics.
export validates and atomically writes canonical YAML to the manifest output path.
generate validates, submits an API-key-authorized asynchronous job, polls it, and writes the generated ZIP.
import converts existing Service Architect YAML into a modular Python project and creates its manifest.

CLI commands properties

Commands installed by the sa-python-dsl package.

PropertyTypeDescription

sa-dsl inspect --project <dir>discovery

Read manifest metadata without executing authoring code.

sa-dsl validate --project <dir>validation

Execute and validate the manifest entrypoint.

sa-dsl export --project <dir>interchange

Write canonical YAML to the manifest output path.

sa-dsl generate --project <dir>generation

Download a generated runtime project ZIP.

sa-dsl import <yaml> -o <dir>migration

Create a manifest-based modular Python project from YAML.

--format human | jsonoutput

Use stable JSON operation envelopes for Codex, MCP, and CI.

Shell

python -m venv .venv
. .venv/bin/activate
pip install -e .

sa-dsl inspect --project examples/processorder --format json
sa-dsl validate --project examples/processorder --format json
sa-dsl export --project examples/processorder --format json
sa-dsl generate --project examples/processorder --format json