Metadata-Version: 2.4
Name: featuresmith-cli
Version: 0.4.0
Summary: Command-line interface for Featuresmith, a toolkit to make data quality as routine as code quality.
Author: Featuresmith contributors
Maintainer: Featuresmith contributors
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/adityagangwani30/FeatureSmith
Project-URL: Documentation, https://featuresmith.adityagangwani.me
Project-URL: Repository, https://github.com/adityagangwani30/FeatureSmith
Project-URL: Issues, https://github.com/adityagangwani30/FeatureSmith/issues
Project-URL: Changelog, https://github.com/adityagangwani30/FeatureSmith/blob/main/CHANGELOG.md
Keywords: cli,data-quality,data-validation,developer-tools,feature-engineering,profiling
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Typing :: Typed
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: featuresmith-core>=0.4.0
Requires-Dist: typer~=0.12
Requires-Dist: rich>=13.7
Dynamic: license-file

# featuresmith-cli

[![PyPI Version](https://img.shields.io/pypi/v/featuresmith-cli.svg)](https://pypi.org/project/featuresmith-cli/)
[![Python Version](https://img.shields.io/pypi/pyversions/featuresmith-cli.svg)](https://pypi.org/project/featuresmith-cli/)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)

`featuresmith-cli` is the command-line interface for **Featuresmith** — the open-source Dataset Review Platform for structured data.

It exposes terminal commands for automated dataset code reviews, snapshot diffing, remediation plan compilation, and CI/CD quality gating, delegating all engine work to `featuresmith-core`.

## Installation

```bash
pip install featuresmith-cli
```

*(This automatically installs `featuresmith-core` as a dependency).*

## CLI Workflows

```bash
# Run automated dataset review report with ML Readiness Scorecard
featuresmith review train.csv --target survived

# Diff two dataset snapshots to catch schema drift and quality regressions
featuresmith diff train_v1.csv train_v2.csv --target survived

# Compile an inspectable Plan from accepted recommendations
featuresmith plan train.csv --target survived --accept rec.quality.missingness.cabin

# Run quality & leakage rule analysis
featuresmith analyze train.csv --target survived

# Output machine-readable JSON for CI/CD gating (exit code 0 = clean, 1 = findings)
featuresmith review train.csv --target survived --format json --output report.json
```

For comprehensive guides and CLI reference, visit the official website:
<https://featuresmith.adityagangwani.me>
