@@ -53,7 +53,7 @@ R2_BUCKET_NAME=your_bucket_name_here
5353CLOUDFLARE_API_TOKEN=your_api_token_here
5454```
5555
56- OR simply start ` r2sql ` for the first time to set it up
56+ OR simply start ` r2sql-shell ` for the first time to set it up
5757
5858### Getting Your Credentials
5959
@@ -67,13 +67,16 @@ OR simply start `r2sql` for the first time to set it up
6767
6868### Via Homebrew
6969
70+ ** Option 1 (Recommended - One command):**
7071``` bash
71- brew tap YOUR_USERNAME/r2sql
72- brew install r2sql
73- r2sql
72+ brew install marcinthecloud/r2sql-shell/r2sql-shell
7473```
7574
76- Replace ` YOUR_USERNAME ` with the GitHub username where the repository is published.
75+ ** Option 2 (Tap first):**
76+ ``` bash
77+ brew tap marcinthecloud/r2sql-shell
78+ brew install r2sql-shell
79+ ```
7780
7881For publishing instructions, see [ HOMEBREW_SETUP.md] ( HOMEBREW_SETUP.md ) .
7982
@@ -100,11 +103,11 @@ For publishing instructions, see [HOMEBREW_SETUP.md](HOMEBREW_SETUP.md).
100103 npm link
101104 ```
102105
103- Now you can run ` r2sql ` from anywhere!
106+ Now you can run ` r2sql-shell ` from anywhere!
104107
105108### Download Pre-built Binary (Coming Soon)
106109
107- Download the latest release for your platform from the [ releases page] ( https://github.com/YOUR_USERNAME /r2sql-shell/releases ) :
110+ Download the latest release for your platform from the [ releases page] ( https://github.com/marcinthecloud /r2sql-shell/releases ) :
108111- macOS (Intel/Apple Silicon)
109112- Linux (x64)
110113- Windows (x64)
@@ -116,15 +119,15 @@ Download the latest release for your platform from the [releases page](https://g
116119Just run the command and you'll be prompted for your credentials:
117120
118121``` bash
119- r2sql
122+ r2sql-shell
120123# or if running from source:
121124npm start
122125```
123126
124127### Option 2: Using Command-Line Arguments
125128
126129``` bash
127- r2sql --account-id YOUR_ACCOUNT_ID --bucket YOUR_BUCKET --token YOUR_API_TOKEN
130+ r2sql-shell --account-id YOUR_ACCOUNT_ID --bucket YOUR_BUCKET --token YOUR_API_TOKEN
128131```
129132
130133### Option 3: Using Environment Variables
@@ -146,15 +149,15 @@ CLOUDFLARE_API_TOKEN=your_api_token_here
146149Then run:
147150
148151``` bash
149- r2sql
152+ r2sql-shell
150153```
151154
152155## Usage
153156
154157### Command-Line Options
155158
156159``` bash
157- r2sql [options]
160+ r2sql-shell [options]
158161
159162Options:
160163 --account-id < id> Cloudflare Account ID
@@ -173,22 +176,22 @@ Options:
173176
174177``` bash
175178# Start with interactive prompt for credentials
176- r2sql
179+ r2sql-shell
177180
178181# Start in TUI mode with credentials
179- r2sql --account-id YOUR_ID --bucket YOUR_BUCKET --token YOUR_TOKEN
182+ r2sql-shell --account-id YOUR_ID --bucket YOUR_BUCKET --token YOUR_TOKEN
180183
181184# Execute a query on startup
182- r2sql -e " SELECT * FROM my_namespace.my_table LIMIT 10"
185+ r2sql-shell -e " SELECT * FROM my_namespace.my_table LIMIT 10"
183186
184187# Enable query history logging
185- r2sql --history
188+ r2sql-shell --history
186189
187190# Start in simple REPL mode
188- r2sql --simple
191+ r2sql-shell --simple
189192
190193# Combine options
191- r2sql --account-id YOUR_ID --bucket YOUR_BUCKET --token YOUR_TOKEN \
194+ r2sql-shell --account-id YOUR_ID --bucket YOUR_BUCKET --token YOUR_TOKEN \
192195 -e " SELECT * FROM default.logs LIMIT 5" --history
193196```
194197
@@ -337,7 +340,7 @@ npm start
337340
338341### Creating Executables
339342
340- To package r2sql as a standalone executable:
343+ To package r2sql-shell as a standalone executable:
341344
342345``` bash
343346# Package for your current platform
0 commit comments