|
2 | 2 |
|
3 | 3 | Command line interface for managing Nile databases. Easily create, manage, and monitor your Nile databases from the terminal. |
4 | 4 |
|
| 5 | +For detailed documentation, visit our [CLI Documentation](https://thenile.dev/docs/cli/introduction). |
| 6 | + |
5 | 7 | ## Installation |
6 | 8 |
|
7 | 9 | ### Using npm |
@@ -78,20 +80,76 @@ nile --version |
78 | 80 | ## Usage |
79 | 81 |
|
80 | 82 | ```bash |
81 | | -# Show help |
| 83 | +# Show help and version |
82 | 84 | nile --help |
| 85 | +nile --version |
| 86 | + |
| 87 | +# Authentication |
| 88 | +nile connect login # Login using browser-based authentication |
| 89 | +nile connect status # Check connection status |
| 90 | +nile connect logout # Clear stored credentials |
| 91 | + |
| 92 | +# Workspace Management |
| 93 | +nile workspace list # List all workspaces |
| 94 | +nile workspace show # Show current workspace details |
| 95 | +nile config --workspace <name> # Set default workspace |
| 96 | + |
| 97 | +# Database Management |
| 98 | +nile db list # List all databases |
| 99 | +nile db show <name> # Show database details |
| 100 | +nile db create --name <name> --region <region> # Create a new database |
| 101 | +nile db delete <name> # Delete a database |
| 102 | +nile db psql # Connect using PostgreSQL CLI |
| 103 | + |
| 104 | +# Tenant Management |
| 105 | +nile tenants list # List all tenants |
| 106 | +nile tenants create --name "Name" # Create a tenant |
| 107 | +nile tenants update --id <id> --new_name "Name" # Update tenant |
| 108 | +nile tenants delete --id <id> # Delete tenant |
| 109 | + |
| 110 | +# User Management |
| 111 | +nile users create # Create a new user |
| 112 | +nile users list # List users |
| 113 | +nile users delete # Delete a user |
| 114 | + |
| 115 | +# Local Development |
| 116 | +nile local start # Start local development environment |
| 117 | +nile local stop # Stop local environment |
| 118 | +nile local info # Show connection information |
| 119 | + |
| 120 | +# Configuration |
| 121 | +nile config # Show current configuration |
| 122 | +nile config --api-key <key> # Set API key |
| 123 | +nile config --workspace <name> # Set workspace |
| 124 | +nile config --db <name> # Set database |
| 125 | +nile config reset # Reset configuration |
| 126 | +``` |
| 127 | + |
| 128 | +### Global Options |
83 | 129 |
|
84 | | -# List available commands |
85 | | -nile help |
| 130 | +These options work with all commands: |
| 131 | + |
| 132 | +```bash |
| 133 | +--api-key <key> # API key for authentication |
| 134 | +--workspace <name> # Workspace to use |
| 135 | +--db <name> # Database to use |
| 136 | +--format <type> # Output format: human (default), json, or csv |
| 137 | +--color # Enable colored output (default: true) |
| 138 | +--no-color # Disable colored output |
| 139 | +--debug # Enable debug output |
| 140 | +``` |
86 | 141 |
|
87 | | -# Configure your workspace |
88 | | -nile config --workspace <workspace-name> |
| 142 | +### Output Formats |
89 | 143 |
|
90 | | -# List databases |
| 144 | +```bash |
| 145 | +# Human-readable (default) |
91 | 146 | nile db list |
92 | 147 |
|
93 | | -# Create a new database |
94 | | -nile db create --name <db-name> --region <region> |
| 148 | +# JSON format |
| 149 | +nile --format json db list |
| 150 | + |
| 151 | +# CSV format |
| 152 | +nile --format csv db list |
95 | 153 | ``` |
96 | 154 |
|
97 | 155 | ## Development Versions |
|
0 commit comments