# Command API

Ashiba command contracts are exposed by the CLI itself.

Use this page as a stable navigation index, then use command help for exact options and ashiba describe command --format json for machine-readable command descriptors.

npx ashiba --help
npx ashiba <command> --help
npx ashiba describe command --format json

ashiba init

Create a SQL-first starter after choosing a DBMS and driver.

npx ashiba init --db postgres --driver pg --with-demo-ddl

ashiba feature scaffold

Create a reviewable feature boundary from DDL metadata.

npx ashiba feature scaffold --feature-name users-list --table users --action list

ashiba feature query scaffold

Add another query boundary under an existing feature.

npx ashiba feature query scaffold --feature users-list --query-name get-by-id --action get-by-id --table users

ashiba feature query refresh

Refresh generated query model metadata after SQL-only edits. The command needs a feature or boundary directory selector.

npx ashiba feature query refresh --feature users-list --query list

ashiba feature tests scaffold

Add generated mapper-test cases and human-owned test placeholders to an existing query boundary.

npx ashiba feature tests scaffold --feature users-list

ashiba feature tests check

Detect missing or stale generated mapping-test assets.

npx ashiba feature tests check

ashiba feature generated-mapper check

Check SQL parameters, DDL-backed parameter types, result columns, and editable query contracts.

npx ashiba feature generated-mapper check

ashiba project check

Run the project-level passive check gate for DDL diagnostics, contract drift, generated feature assets, SQL lint, and INSERT ownership.

npx ashiba project check

ashiba check-contract

Check visible SQL contracts before commit or release.

npx ashiba check-contract

ashiba ddl migration generate

Generate reviewable migration SQL from DDL file snapshots or DDL source directories.

npx ashiba ddl migration generate --from-dir old-ddl --to-dir db/ddl --out tmp/ddl/migration.sql

ashiba lint

Run SQL lint and DDL-aware checks over a SQL file or directory.

npx ashiba lint src/features

ashiba query

Inspect, visualize, or debug complex SQL.

npx ashiba query outline path/to/query.sql
npx ashiba query graph path/to/query.sql
npx ashiba query slice path/to/query.sql

ashiba query uses

Find SQL assets that reference a table or column.

npx ashiba query uses table users
npx ashiba query uses column users.email

ashiba query sssql

Maintain SQL-first optional-condition metadata.

npx ashiba query sssql add path/to/query.sql --filter status
npx ashiba query sssql refresh path/to/query.sql
npx ashiba query sssql remove path/to/query.sql --parameter status

ashiba model-gen

Generate editable query contracts and generated metadata from a SQL file.

npx ashiba model-gen path/to/query.sql --out path/to/query.ts

ashiba perf scenario

Capture DB-backed performance evidence while keeping DB execution and tuning decisions application-owned.

npx ashiba perf scenario init --scenario users-list --query src/features/users-list/queries/list/list.sql
npx ashiba perf scenario measure --scenario users-list --duration-ms 42

ashiba rfba inspect

Inspect review-first feature and query boundaries.

npx ashiba rfba inspect