Merge pull request #222 from posit-dev/docs-update-readme

docs: update README

Author: rich-iannone

README.md

@@ -149,6 +149,49 @@ validation.get_step_report(i=3).show("browser")  # Get failing records from step
 
 <br>
 
+## Command Line Interface (CLI)
+
+Pointblank includes a powerful CLI utility called `pb` that lets you run data validation workflows directly from the command line. Perfect for CI/CD pipelines, scheduled data quality checks, or quick validation tasks.
+
+<div align="center">
+<img src="https://posit-dev.github.io/pointblank/assets/vhs/cli-complete-workflow.gif" width="800px">
+</div>
+
+**Explore Your Data**
+
+```bash
+# Get a quick preview of your data
+pb preview small_table
+
+# Check for missing values
+pb missing small_table
+
+# Generate column summaries
+pb scan small_table
+```
+
+**Run Essential Validations**
+
+```bash
+# Check for duplicate rows
+pb validate-simple small_table --check rows-distinct
+
+# Verify no null values
+pb validate-simple small_table --check col-vals-not-null --column a
+
+# Extract failing data for debugging
+pb validate-simple small_table --check col-vals-gt --column a --value 5 --show-extract
+```
+
+**Integrate with CI/CD**
+
+```bash
+# Use exit codes for automation (0 = pass, 1 = fail)
+pb validate-simple small_table --check rows-distinct && echo "✅ Quality checks passed"
+```
+
+Learn more in our [CLI documentation](https://posit-dev.github.io/pointblank/user-guide/cli.html).
+
 ## Features That Set Pointblank Apart
 
 - **Complete validation workflow** - From data access to validation to reporting in a single pipeline

docs/index.qmd

@@ -116,6 +116,51 @@ validation.get_step_report(i=3).show("browser")  # Get failing records from step
 
 </div>
 
+## Command Line Interface (CLI)
+
+Pointblank includes a powerful CLI utility called `pb` that lets you run data validation workflows directly from the command line. Perfect for CI/CD pipelines, scheduled data quality checks, or quick validation tasks.
+
+<div style="text-align: center;">
+
+![](/assets/vhs/cli-complete-workflow.gif){width=100%}
+
+</div>
+
+**Explore Your Data**
+
+```bash
+# Get a quick preview of your data
+pb preview small_table
+
+# Check for missing values
+pb missing small_table
+
+# Generate column summaries
+pb scan small_table
+```
+
+**Run Essential Validations**
+
+```bash
+# Check for duplicate rows
+pb validate-simple small_table --check rows-distinct
+
+# Verify no null values
+pb validate-simple small_table --check col-vals-not-null --column a
+
+# Extract failing data for debugging
+pb validate-simple small_table --check col-vals-gt --column a --value 5 --show-extract
+```
+
+**Integrate with CI/CD**
+
+```bash
+# Use exit codes for automation (0 = pass, 1 = fail)
+pb validate-simple small_table --check rows-distinct && echo "✅ Quality checks passed"
+```
+
+Learn more in our [CLI documentation](https://posit-dev.github.io/pointblank/user-guide/cli.html).
+
 ## Join the Community
 
 We'd love to hear from you! Connect with us:

docs/user-guide/cli.qmd

@@ -1,6 +1,6 @@
 ---
-title: "Command Line Interface"
 jupyter: python3
+toc-expand: 2
 ---
 
 # Command Line Interface

translations/README.ar.md

@@ -157,6 +157,49 @@ validation.get_step_report(i=3).show("browser")  # الحصول على السج
 - **قابل للتخصيص** - تخصيص خطوات التحقق وإعداد التقارير وفقًا لاحتياجاتك المحددة
 - **تدويل** - يمكن إنشاء التقارير بأكثر من 20 لغة، بما في ذلك الإنجليزية والإسبانية والفرنسية والألمانية
 
+## واجهة سطر الأوامر (CLI)
+
+يتضمن Pointblank أداة CLI قوية تسمى `pb` تتيح لك تشغيل سير عمل التحقق من البيانات مباشرة من سطر الأوامر. مثالية لخطوط أنابيب CI/CD، وفحوصات جودة البيانات المجدولة، أو مهام التحقق السريعة.
+
+<div align="center">
+<img src="https://posit-dev.github.io/pointblank/assets/vhs/cli-complete-workflow.gif" width="800px">
+</div>
+
+**استكشف بياناتك**
+
+```bash
+# احصل على معاينة سريعة لبياناتك
+pb preview small_table
+
+# تحقق من القيم المفقودة
+pb missing small_table
+
+# إنشاء ملخصات الأعمدة
+pb scan small_table
+```
+
+**تشغيل التحققات الأساسية**
+
+```bash
+# تحقق من الصفوف المكررة
+pb validate-simple small_table --check rows-distinct
+
+# تحقق من عدم وجود قيم فارغة
+pb validate-simple small_table --check col-vals-not-null --column a
+
+# استخراج البيانات الفاشلة للتصحيح
+pb validate-simple small_table --check col-vals-gt --column a --value 5 --show-extract
+```
+
+**التكامل مع CI/CD**
+
+```bash
+# استخدم أكواد الخروج للأتمتة (0 = نجح، 1 = فشل)
+pb validate-simple small_table --check rows-distinct && echo "✅ فحوصات الجودة نجحت"
+```
+
+تعلم المزيد في [وثائق CLI](https://posit-dev.github.io/pointblank/user-guide/cli.html).
+
 ## التوثيق والأمثلة
 
 قم بزيارة [موقع التوثيق](https://posit-dev.github.io/pointblank) للحصول على:

translations/README.de.md

@@ -149,6 +149,49 @@ validation.get_step_report(i=3).show("browser")  # Fehlgeschlagene Datensätze a
 
 <br>
 
+## Kommandozeilenschnittstelle (CLI)
+
+Pointblank enthält ein leistungsstarkes CLI-Dienstprogramm namens `pb`, mit dem Sie Datenvalidierungsworkflows direkt von der Kommandozeile aus ausführen können. Perfekt für CI/CD-Pipelines, geplante Datenqualitätsprüfungen oder schnelle Validierungsaufgaben.
+
+<div align="center">
+<img src="https://posit-dev.github.io/pointblank/assets/vhs/cli-complete-workflow.gif" width="800px">
+</div>
+
+**Erkunden Sie Ihre Daten**
+
+```bash
+# Schnelle Vorschau Ihrer Daten
+pb preview small_table
+
+# Auf fehlende Werte prüfen
+pb missing small_table
+
+# Spaltenzusammenfassungen generieren
+pb scan small_table
+```
+
+**Führen Sie grundlegende Validierungen durch**
+
+```bash
+# Auf doppelte Zeilen prüfen
+pb validate-simple small_table --check rows-distinct
+
+# Keine Null-Werte verifizieren
+pb validate-simple small_table --check col-vals-not-null --column a
+
+# Fehlerhafte Daten für Debugging extrahieren
+pb validate-simple small_table --check col-vals-gt --column a --value 5 --show-extract
+```
+
+**Integration mit CI/CD**
+
+```bash
+# Exit-Codes für Automatisierung verwenden (0 = Erfolg, 1 = Fehler)
+pb validate-simple small_table --check rows-distinct && echo "✅ Qualitätsprüfungen bestanden"
+```
+
+Erfahren Sie mehr in unserer [CLI-Dokumentation](https://posit-dev.github.io/pointblank/user-guide/cli.html).
+
 ## Funktionen, die Pointblank auszeichnen
 
 - **Vollständiger Validierungs-Workflow** - Von Datenzugriff über Validierung bis hin zur Berichterstattung in einer einzigen Pipeline

translations/README.es.md

@@ -149,6 +149,49 @@ validation.get_step_report(i=3).show("browser")  # Obtén los registros fallidos
 
 <br>
 
+## Interfaz de Línea de Comandos (CLI)
+
+Pointblank incluye una potente herramienta CLI llamada `pb` que te permite ejecutar flujos de trabajo de validación de datos directamente desde la línea de comandos. Perfecto para pipelines CI/CD, verificaciones programadas de calidad de datos, o tareas de validación rápidas.
+
+<div align="center">
+<img src="https://posit-dev.github.io/pointblank/assets/vhs/cli-complete-workflow.gif" width="800px">
+</div>
+
+**Explora tus datos**
+
+```bash
+# Obtén una vista previa rápida de tus datos
+pb preview small_table
+
+# Verifica valores faltantes
+pb missing small_table
+
+# Genera resúmenes de columnas
+pb scan small_table
+```
+
+**Ejecuta validaciones esenciales**
+
+```bash
+# Verifica filas duplicadas
+pb validate-simple small_table --check rows-distinct
+
+# Verifica que no haya valores nulos
+pb validate-simple small_table --check col-vals-not-null --column a
+
+# Extrae datos fallidos para depuración
+pb validate-simple small_table --check col-vals-gt --column a --value 5 --show-extract
+```
+
+**Integra con CI/CD**
+
+```bash
+# Usa códigos de salida para automatización (0 = éxito, 1 = fallo)
+pb validate-simple small_table --check rows-distinct && echo "✅ Verificaciones de calidad pasaron"
+```
+
+Aprende más en nuestra [documentación del CLI](https://posit-dev.github.io/pointblank/user-guide/cli.html).
+
 ## Características que diferencian a Pointblank
 
 - **Flujo de trabajo de validación completo** - Desde el acceso a los datos hasta la validación y los informes en un solo pipeline

translations/README.fr.md

@@ -149,6 +149,49 @@ validation.get_step_report(i=3).show("browser")  # Obtenir les enregistrements d
 
 <br>
 
+## Interface en Ligne de Commande (CLI)
+
+Pointblank inclut un utilitaire CLI puissant appelé `pb` qui vous permet d'exécuter des workflows de validation de données directement depuis la ligne de commande. Parfait pour les pipelines CI/CD, les vérifications de qualité des données programmées, ou les tâches de validation rapides.
+
+<div align="center">
+<img src="https://posit-dev.github.io/pointblank/assets/vhs/cli-complete-workflow.gif" width="800px">
+</div>
+
+**Explorez vos données**
+
+```bash
+# Obtenez un aperçu rapide de vos données
+pb preview small_table
+
+# Vérifiez les valeurs manquantes
+pb missing small_table
+
+# Générez des résumés de colonnes
+pb scan small_table
+```
+
+**Exécutez des validations essentielles**
+
+```bash
+# Vérifiez les lignes dupliquées
+pb validate-simple small_table --check rows-distinct
+
+# Vérifiez l'absence de valeurs nulles
+pb validate-simple small_table --check col-vals-not-null --column a
+
+# Extrayez les données défaillantes pour le débogage
+pb validate-simple small_table --check col-vals-gt --column a --value 5 --show-extract
+```
+
+**Intégrez avec CI/CD**
+
+```bash
+# Utilisez les codes de sortie pour l'automatisation (0 = réussite, 1 = échec)
+pb validate-simple small_table --check rows-distinct && echo "✅ Vérifications de qualité réussies"
+```
+
+En savoir plus dans notre [documentation CLI](https://posit-dev.github.io/pointblank/user-guide/cli.html).
+
 ## Caractéristiques qui distinguent Pointblank
 
 - **Flux de travail de validation complet** - De l'accès aux données à la validation jusqu'au reporting dans un seul pipeline

translations/README.hi.md

@@ -148,6 +148,49 @@ validation.get_step_report(i=3).show("browser")  # स्टेप 3 से अ
 
 <br>
 
+## कमांड लाइन इंटरफेस (CLI)
+
+पॉइन्टब्लैंक में `pb` नामक एक शक्तिशाली CLI उपयोगिता शामिल है जो आपको कमांड लाइन से सीधे डेटा वैलिडेशन वर्कफ़लो चलाने की अनुमति देता है। CI/CD पाइपलाइनों, निर्धारित डेटा गुणवत्ता जांच, या त्वरित वैलिडेशन कार्यों के लिए परफेक्ट है।
+
+<div align="center">
+<img src="https://posit-dev.github.io/pointblank/assets/vhs/cli-complete-workflow.gif" width="800px">
+</div>
+
+**अपने डेटा की खोज करें**
+
+```bash
+# अपने डेटा का त्वरित पूर्वावलोकन प्राप्त करें
+pb preview small_table
+
+# गुम मानों की जांच करें
+pb missing small_table
+
+# स्तंभ सारांश जेनरेट करें
+pb scan small_table
+```
+
+**आवश्यक वैलिडेशन चलाएं**
+
+```bash
+# डुप्लिकेट पंक्तियों की जांच करें
+pb validate-simple small_table --check rows-distinct
+
+# null मान न होने की पुष्टि करें
+pb validate-simple small_table --check col-vals-not-null --column a
+
+# डिबगिंग के लिए असफल डेटा निकालें
+pb validate-simple small_table --check col-vals-gt --column a --value 5 --show-extract
+```
+
+**CI/CD के साथ एकीकृत करें**
+
+```bash
+# स्वचालन के लिए एक्जिट कोड का उपयोग करें (0 = पास, 1 = फेल)
+pb validate-simple small_table --check rows-distinct && echo "✅ गुणवत्ता जांच सफल"
+```
+
+हमारे [CLI डॉक्यूमेंटेशन](https://posit-dev.github.io/pointblank/user-guide/cli.html) में और जानें।
+
 ## विशेषताएं जो पॉइन्टब्लैंक को अलग बनाती हैं
 
 - **पूर्ण वैलिडेशन वर्कफ्लो** - डेटा एक्सेस से वैलिडेशन से रिपोर्टिंग तक एक ही पाइपलाइन में