Skip to content

CLI Overview

The sqlstream command-line interface provides an easy way to query data files with SQL.

Available Commands

query - Execute SQL Queries

Execute SQL queries on data files and display results.

sqlstream query [FILE] <SQL> [OPTIONS]

Examples: 

# Query a file
sqlstream query data.csv "SELECT * FROM data WHERE age > 25"

# Inline file path
sqlstream query "SELECT * FROM 'data.csv' WHERE age > 25"

# JSON output
sqlstream query data.csv "SELECT * FROM data" --format json

# S3 files
sqlstream query "SELECT * FROM 's3://bucket/data.parquet' LIMIT 100"

See Query Command for full documentation.

shell - Interactive SQL Shell

Launch the interactive shell with full TUI (Terminal User Interface).

sqlstream shell [FILE] [OPTIONS]

Options: - -i, --incognito - Start fresh without loading previous session or saving on exit

Features: - Modal dialogs for filtering, export, file selection - File browser (Ctrl+O) to select files - Query execution plan visualization (F4) - Multi-format export (Ctrl+X) - Live filtering (Ctrl+F) - Schema browser (F2) - Query history with multiline support - Session state persistence (tabs and queries saved on exit, unless in incognito mode)

Examples: 

# Launch with a file
sqlstream shell employees.csv

# Launch in incognito mode (fresh start, no state saving)
sqlstream shell -i
sqlstream shell --incognito employees.csv

See Interactive Mode for full documentation.

Global Options

  • --version - Show SQLStream version
  • --help - Show help message

Quick Start

# Simple query
sqlstream query employees.csv "SELECT * FROM employees WHERE salary > 80000"

# With pandas backend for performance
sqlstream query large.csv "SELECT * FROM large" --backend pandas

# Launch interactive shell
sqlstream shell employees.csv

Next Steps