CLI Reference

featuresmith review

CLI command reference for comprehensive reviews

bash

1featuresmith review <source> [options]

Runs a dataset review and prints a structured, severity-sorted findings tree alongside the ML Readiness Score.

Flags and Options

--target TEXT	Name of the target column in the dataset to validate and enable leakage reviewers.
--previous PATH	Path to a prior snapshot for diff-aware review. When provided, the DiffReviewer compares the current dataset against it and includes the diff in the review output.
--format [table\|json]	Output format to display (default: `table`).
--output PATH	Path to save the plain report or JSON structure.
--fail-on [info\|warning\|critical]	Severity threshold for CI-gating exit codes (default: `critical`).
--only TEXT	Comma-separated reviewer categories to run (schema, quality, leakage, diff, feature_quality, custom).
--no-score	Omit the ML Readiness Score scorecard from the report.
--quiet	Suppress all standard console report output.
--verbose	Show full Python tracebacks on error instead of generic messages.
--version	Show version info and exit.

Exit Codes

The command returns standardized exit codes matching the analyze conventions:

0: Clean — no findings meet or exceed the severity threshold specified in --fail-on.
1: Findings meeting or exceeding the threshold were detected (gating CI/CD pipelines).
2: Invalid usage, bad configuration, unknown target column, or unsupported format.
3: File not found or failed to parse.
4: Unexpected internal error.

CLI Syntax Examples

bash

1# 1. Standard review with leakage target
2featuresmith review train.csv --target churn
3
4# 2. Category filtering with CI gating
5featuresmith review train.csv --only schema,leakage --fail-on warning --no-score
6
7# 3. JSON format save
8featuresmith review train.csv --format json --output review_report.json

Notes and Limitations

Target column validation: When --target is specified, the CLI actively checks for column presence in the schema and fails early with code 2 if not found.

featuresmith review

CLI command reference for comprehensive reviews

bash

1featuresmith review <source> [options]

Runs a dataset review and prints a structured, severity-sorted findings tree alongside the ML Readiness Score.

Flags and Options

--target TEXT	Name of the target column in the dataset to validate and enable leakage reviewers.
--previous PATH	Path to a prior snapshot for diff-aware review. When provided, the DiffReviewer compares the current dataset against it and includes the diff in the review output.
--format [table\|json]	Output format to display (default: `table`).
--output PATH	Path to save the plain report or JSON structure.
--fail-on [info\|warning\|critical]	Severity threshold for CI-gating exit codes (default: `critical`).
--only TEXT	Comma-separated reviewer categories to run (schema, quality, leakage, diff, feature_quality, custom).
--no-score	Omit the ML Readiness Score scorecard from the report.
--quiet	Suppress all standard console report output.
--verbose	Show full Python tracebacks on error instead of generic messages.
--version	Show version info and exit.

Exit Codes

The command returns standardized exit codes matching the analyze conventions:

0: Clean — no findings meet or exceed the severity threshold specified in --fail-on.
1: Findings meeting or exceeding the threshold were detected (gating CI/CD pipelines).
2: Invalid usage, bad configuration, unknown target column, or unsupported format.
3: File not found or failed to parse.
4: Unexpected internal error.

CLI Syntax Examples

bash

1# 1. Standard review with leakage target
2featuresmith review train.csv --target churn
3
4# 2. Category filtering with CI gating
5featuresmith review train.csv --only schema,leakage --fail-on warning --no-score
6
7# 3. JSON format save
8featuresmith review train.csv --format json --output review_report.json

Notes and Limitations

Target column validation: When --target is specified, the CLI actively checks for column presence in the schema and fails early with code 2 if not found.

featuresmith review

Flags and Options

Exit Codes

CLI Syntax Examples

Notes and Limitations

Related Documentation

featuresmith review

Flags and Options

Exit Codes

CLI Syntax Examples

Notes and Limitations

Related Documentation