Skip to content

Commit a201462

Browse files
chore(release): v0.4.3
1 parent cacb011 commit a201462

File tree

1 file changed

+45
-22
lines changed

1 file changed

+45
-22
lines changed

docs/commands.md

Lines changed: 45 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Cloud SQL Proxy CLI Reference
22

3-
**Version:** 0.4.2
3+
**Version:** 0.4.3
44
**Generated:** 2025-12-21
55

66
## Overview
77

8-
```text
8+
```
99
Usage: cloudsqlctl [options] [command]
1010
1111
CLI for managing Google Cloud SQL Auth Proxy
@@ -39,14 +39,15 @@ Commands:
3939
setup Interactive setup wizard
4040
paths Show resolved system paths and configuration
4141
locations
42+
upgrade [options] Upgrade cloudsqlctl to the latest version
4243
help [command] display help for command
4344
```
4445

4546
## Commands
4647

4748
### install
4849

49-
```text
50+
```
5051
Usage: cloudsqlctl install [options]
5152
5253
Download and install Cloud SQL Proxy
@@ -58,7 +59,7 @@ Options:
5859

5960
### update
6061

61-
```text
62+
```
6263
Usage: cloudsqlctl update [options]
6364
6465
Update Cloud SQL Proxy to the latest version
@@ -69,7 +70,7 @@ Options:
6970

7071
### select
7172

72-
```text
73+
```
7374
Usage: cloudsqlctl select [options]
7475
7576
Select a Cloud SQL instance
@@ -80,7 +81,7 @@ Options:
8081

8182
### list
8283

83-
```text
84+
```
8485
Usage: cloudsqlctl list [options]
8586
8687
List available Cloud SQL instances
@@ -92,7 +93,7 @@ Options:
9293

9394
### connect
9495

95-
```text
96+
```
9697
Usage: cloudsqlctl connect [options] <instance>
9798
9899
Connect to a specific Cloud SQL instance
@@ -107,7 +108,7 @@ Options:
107108

108109
### start
109110

110-
```text
111+
```
111112
Usage: cloudsqlctl start [options]
112113
113114
Start the Cloud SQL Proxy
@@ -119,7 +120,7 @@ Options:
119120

120121
### stop
121122

122-
```text
123+
```
123124
Usage: cloudsqlctl stop [options]
124125
125126
Stop the Cloud SQL Proxy or Service
@@ -130,7 +131,7 @@ Options:
130131

131132
### status
132133

133-
```text
134+
```
134135
Usage: cloudsqlctl status [options]
135136
136137
Check the status of the Cloud SQL Proxy and Service
@@ -141,7 +142,7 @@ Options:
141142

142143
### logs
143144

144-
```text
145+
```
145146
Usage: cloudsqlctl logs [options]
146147
147148
View the tail of the proxy logs
@@ -153,7 +154,7 @@ Options:
153154

154155
### doctor
155156

156-
```text
157+
```
157158
Usage: cloudsqlctl doctor [options]
158159
159160
Run diagnostics to verify environment setup
@@ -164,7 +165,7 @@ Options:
164165

165166
### reset
166167

167-
```text
168+
```
168169
Usage: cloudsqlctl reset [options]
169170
170171
Reset configuration and remove local files
@@ -176,7 +177,7 @@ Options:
176177

177178
### env
178179

179-
```text
180+
```
180181
Usage: cloudsqlctl env [options] [command]
181182
182183
Manage environment variables
@@ -191,7 +192,7 @@ Commands:
191192

192193
### service
193194

194-
```text
195+
```
195196
Usage: cloudsqlctl service [options] [command]
196197
197198
Manage the Cloud SQL Proxy Windows Service (Requires Admin)
@@ -211,7 +212,7 @@ Commands:
211212

212213
### ps1
213214

214-
```text
215+
```
215216
Usage: cloudsqlctl ps1 [options] [command]
216217
217218
Manage PowerShell scripts
@@ -226,7 +227,7 @@ Commands:
226227

227228
### repair
228229

229-
```text
230+
```
230231
Usage: cloudsqlctl repair [options]
231232
232233
Self-heal missing or corrupted files and configurations
@@ -237,7 +238,7 @@ Options:
237238

238239
### check
239240

240-
```text
241+
```
241242
Usage: cloudsqlctl check [options]
242243
243244
Verify full system configuration
@@ -249,7 +250,7 @@ Options:
249250

250251
### gcloud
251252

252-
```text
253+
```
253254
Usage: cloudsqlctl gcloud [options] [command]
254255
255256
Manage Google Cloud CLI
@@ -265,7 +266,7 @@ Commands:
265266

266267
### auth
267268

268-
```text
269+
```
269270
Usage: cloudsqlctl auth [options] [command]
270271
271272
Manage authentication and credentials
@@ -284,7 +285,7 @@ Commands:
284285

285286
### setup
286287

287-
```text
288+
```
288289
Usage: cloudsqlctl setup [options]
289290
290291
Interactive setup wizard
@@ -295,11 +296,33 @@ Options:
295296

296297
### paths
297298

298-
```text
299+
```
299300
Usage: cloudsqlctl paths [options]
300301
301302
Show resolved system paths and configuration locations
302303
303304
Options:
304305
-h, --help display help for command
305306
```
307+
308+
### upgrade
309+
310+
```
311+
Usage: cloudsqlctl upgrade [options]
312+
313+
Upgrade cloudsqlctl to the latest version
314+
315+
Options:
316+
--check-only Only check for updates, do not download or install
317+
--no-install Download only, do not install
318+
--asset <mode> Asset type to download (auto, installer, exe) (default:
319+
"auto")
320+
--dir <path> Download directory (default:
321+
"C:\\Users\\ymc\\AppData\\Local\\CloudSQLCTL\\downloads\\updates")
322+
--force Force update even if version is same or older
323+
--no-silent Run installer in interactive mode (installer only)
324+
--no-elevate Do not attempt to elevate privileges (installer only)
325+
--json Output status in JSON format
326+
-h, --help display help for command
327+
```
328+

0 commit comments

Comments
 (0)