diff --git a/readme.md b/readme.md index 5763d23..e86bf64 100644 --- a/readme.md +++ b/readme.md @@ -2,6 +2,8 @@ Command line interface for managing Nile databases. Easily create, manage, and monitor your Nile databases from the terminal. +For detailed documentation, visit our [CLI Documentation](https://thenile.dev/docs/cli/introduction). + ## Installation ### Using npm @@ -78,20 +80,76 @@ nile --version ## Usage ```bash -# Show help +# Show help and version nile --help +nile --version + +# Authentication +nile connect login # Login using browser-based authentication +nile connect status # Check connection status +nile connect logout # Clear stored credentials + +# Workspace Management +nile workspace list # List all workspaces +nile workspace show # Show current workspace details +nile config --workspace # Set default workspace + +# Database Management +nile db list # List all databases +nile db show # Show database details +nile db create --name --region # Create a new database +nile db delete # Delete a database +nile db psql # Connect using PostgreSQL CLI + +# Tenant Management +nile tenants list # List all tenants +nile tenants create --name "Name" # Create a tenant +nile tenants update --id --new_name "Name" # Update tenant +nile tenants delete --id # Delete tenant + +# User Management +nile users create # Create a new user +nile users list # List users +nile users delete # Delete a user + +# Local Development +nile local start # Start local development environment +nile local stop # Stop local environment +nile local info # Show connection information + +# Configuration +nile config # Show current configuration +nile config --api-key # Set API key +nile config --workspace # Set workspace +nile config --db # Set database +nile config reset # Reset configuration +``` + +### Global Options -# List available commands -nile help +These options work with all commands: + +```bash +--api-key # API key for authentication +--workspace # Workspace to use +--db # Database to use +--format # Output format: human (default), json, or csv +--color # Enable colored output (default: true) +--no-color # Disable colored output +--debug # Enable debug output +``` -# Configure your workspace -nile config --workspace +### Output Formats -# List databases +```bash +# Human-readable (default) nile db list -# Create a new database -nile db create --name --region +# JSON format +nile --format json db list + +# CSV format +nile --format csv db list ``` ## Development Versions