CLI Tool

pyright [options] files...

--createstub <IMPORT>
# Create type stub file(s) for the specified import

--level <LEVEL>  
# Set minimum diagnostic level: "error" or "warning"

--skipunannotated
# Skip analysis of functions with no type annotations

--verifytypes <PACKAGE>
# Verify type completeness of a py.typed package

--ignoreexternal
# Ignore external imports for --verifytypes (only valid with --verifytypes)

# Create type stubs for a package
pyright --createstub requests

# Only show errors, hide warnings
pyright --level error src/

# Skip unannotated functions
pyright --skipunannotated

# Verify package type completeness
pyright --verifytypes mypackage

--pythonplatform <PLATFORM>
# Analyze for specific platform: "Darwin", "Linux", or "Windows"

--pythonpath <FILE>
# Path to the Python interpreter executable

--pythonversion <VERSION>
# Analyze for specific Python version: "3.3", "3.4", "3.7", "3.8", "3.9", "3.10", "3.11", etc.

-v, --venvpath <DIRECTORY>
# Directory that contains virtual environments

-t, --typeshedpath <DIRECTORY>
# Use typeshed type stubs at this location

# Check for Linux compatibility
pyright --pythonplatform Linux

# Use specific Python version
pyright --pythonversion 3.9

# Set virtual environment path
pyright --venvpath ./venvs

# Use custom typeshed location
pyright --typeshedpath ./custom-typeshed

-p, --project <FILE OR DIRECTORY>
# Use configuration file at this location

files...
# Python files to analyze (default positional argument)

-
# Read file list from stdin

# Use specific config file
pyright --project ./myconfig.json

# Analyze specific files
pyright src/main.py tests/test_main.py

# Read file list from stdin
echo "src/main.py src/utils.py" | pyright -

--outputjson
# Output results in JSON format instead of text

--verbose
# Emit verbose diagnostics and additional information

--stats
# Print detailed performance statistics

--dependencies
# Emit import dependency information

--warnings
# Use exit code of 1 if warnings are reported (in addition to errors)

# Get machine-readable JSON output
pyright --outputjson > results.json

# Show detailed performance information
pyright --stats --verbose

# Show import dependencies
pyright --dependencies

# Treat warnings as errors for CI
pyright --warnings

--threads <optional COUNT>
# Use separate threads to parallelize type checking
# If COUNT is omitted or "auto", uses CPU core count (minimum 4)

-w, --watch
# Continue to run and watch for file changes

--help, -h
# Show help message and exit

--version
# Print Pyright version and exit

# Use automatic thread count
pyright --threads

# Use specific thread count
pyright --threads 8

# Watch mode for continuous checking
pyright --watch

# Show version information
pyright --version

--lib
# DEPRECATED: Pyright now defaults to using library code to infer types

--venv-path <DIRECTORY>
# DEPRECATED: Use --venvpath instead

--typeshed-path <DIRECTORY>  
# DEPRECATED: Use --typeshedpath instead

enum ExitStatus {
  NoErrors = 0,              // Successful execution with no errors
  ErrorsReported = 1,        // Type errors were found
  FatalError = 2,            // Fatal error occurred during execution  
  ConfigFileParseError = 3,  // Configuration file parsing failed
  ParameterError = 4,        // Invalid command-line parameters
}

# Direct file arguments
pyright file1.py file2.py

# Glob patterns (shell expansion)
pyright src/**/*.py

# Configuration-based discovery
pyright --project pyrightconfig.json

# Stdin file list
echo "file1.py file2.py" | pyright -