Skip to content

Commit 6bbb878

Browse files
committed
Update cli.qmd
1 parent 50f6af9 commit 6bbb878

File tree

1 file changed

+9
-13
lines changed

1 file changed

+9
-13
lines changed

docs/user-guide/cli.qmd

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,10 @@ The CLI is automatically available when you install Pointblank:
2020
pip install pointblank
2121
```
2222

23-
## Quick Demo
24-
25-
Here's a quick demonstration of the new validation features in action:
26-
27-
::: {style="text-align: center; margin: 20px 0;"}
28-
![CLI Features Demo](../assets/vhs/cli-features.gif)
29-
:::
30-
3123
## Terminal Demos
3224

33-
For more detailed examples, check out our [CLI terminal demos](../demos/cli-interactive/index.qmd) to see the CLI in action with comprehensive command examples and real output.
25+
Check out our [CLI terminal demos](../demos/cli-interactive/index.qmd) to see the CLI in action with
26+
comprehensive command examples and real output.
3427

3528
## Basic Usage
3629

@@ -44,22 +37,25 @@ pb validate-simple [DATA_SOURCE] --check [CHECK_TYPE] [OPTIONS]
4437

4538
You can validate various types of data sources:
4639

47-
- **CSV files**: `pb validate-simple data.csv --check rows-distinct`
48-
- **Parquet files**: `pb validate-simple data.parquet --check col-vals-not-null --column age`
49-
- **Database tables**: `pb validate-simple "duckdb:///path/to/db.ddb::table_name" --check rows-complete`
50-
- **Built-in datasets**: `pb validate-simple small_table --check col-exists --column a`
40+
- CSV files: `pb validate-simple data.csv --check rows-distinct`
41+
- Parquet files: `pb validate-simple data.parquet --check col-vals-not-null --column age`
42+
- database tables: `pb validate-simple "duckdb:///path/to/db.ddb::table_name" --check rows-complete`
43+
- built-in datasets: `pb validate-simple small_table --check col-exists --column a`
5144

5245
## Available Validation Checks
5346

5447
### Data Completeness
48+
5549
- `rows-distinct`: Check if all rows are unique (no duplicates)
5650
- `rows-complete`: Check if all rows are complete (no missing values)
5751
- `col-vals-not-null`: Check if a column has no null/missing values
5852

5953
### Column Existence
54+
6055
- `col-exists`: Verify that a specific column exists in the dataset
6156

6257
### Value Range Checks
58+
6359
- `col-vals-gt`: Values greater than a threshold
6460
- `col-vals-ge`: Values greater than or equal to a threshold
6561
- `col-vals-lt`: Values less than a threshold

0 commit comments

Comments
 (0)