CLI Reference
featuresmith plan
CLI Reference: compile a deterministic Plan from accepted recommendations
Overview
The featuresmith plan command runs a full review of a dataset and then compiles a deterministic Plan from the recommendation IDs you accept via --accept. Run featuresmith review first to see the available recommendations and their IDs, then pass the ones you want in the plan.
Usage
bash
featuresmith plan <source> [--target COLUMN] [--previous SNAPSHOT] [--accept ID1,ID2] [--format table|json] [--output PATH] [--fail-on info|warning|critical] [--quiet] [--verbose]| Flag | Description |
|---|---|
| <source> | Path to the local tabular dataset (CSV, Excel, or Parquet). |
| --target | Name of the target column in the dataset for leakage evaluation. |
| --previous | Path to a prior snapshot for diff-aware review. |
| --accept | Comma-separated recommendation IDs to accept into the plan. |
| --format | Output format: table (default) or json. |
| --output | Path to save the output report (txt or JSON depending on format). |
| --fail-on | Severity threshold for CI-gating exit codes, mirrors review (default: critical). |
| --quiet | Suppress all standard console report output. |
| --verbose | Show full Python tracebacks on error instead of generic messages. |
Examples
bash
# Review first to see recommendation IDsfeaturesmith review train.csv --target survived# Compile a plan from accepted recommendationsfeaturesmith plan train.csv --target survived --accept rec.quality.missingness.cabin# Output JSON plan reportfeaturesmith plan train.csv --accept rec.quality.missingness.cabin --format json --output plan.jsonExit Codes
- 0: Success — no plan item meets or exceeds the
--fail-onthreshold. - 1: At least one plan item meets or exceeds the
--fail-onthreshold (CI gate). - 2: Validation or configuration error (for example, an unknown recommendation ID or a missing target column).
- 3: Source file not found or failed to parse.
- 4: Unexpected internal error.
Related Documentation
See the SDK equivalent fs.plan() and the review CLI reference featuresmith review.