Skip to content

Commit 41b8881

Browse files
Kinin-Code-OfficalKinin-Code-Offical
committed
chore(release): v0.3.1
1 parent 74432ed commit 41b8881

File tree

17 files changed

+597
-115
lines changed

17 files changed

+597
-115
lines changed

‎.github/workflows/ci.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,9 @@ jobs:
4040

4141
- name: Package
4242
run: npm run package
43+
44+
- name: Smoke Test EXE
45+
run: npm run smoke:exe
46+
47+
- name: Check Docs
48+
run: npm run docs:check

‎.github/workflows/release.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,9 @@ jobs:
4444
- name: Build Installer
4545
run: npm run installer
4646

47+
- name: Generate Docs
48+
run: npm run docs:generate
49+
4750
- name: Stage Artifacts
4851
run: npm run stage
4952

‎CHANGELOG.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
## [0.3.1] - 2025-12-21
2+
3+
### Added
4+
- Release 0.3.1
5+
16
# Changelog
27

38
## [0.3.0] - 2025-12-21
@@ -22,3 +27,4 @@
2227
- **Build**: Resolved duplicate exports in service module.
2328
- **Types**: Fixed TypeScript errors in self-heal and service commands.
2429
- **Linting**: Corrected Markdown formatting issues.
30+

‎CHANGELOG_DRAFT.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
- **Proxy**: `startProxy` now respects `GOOGLE_APPLICATION_CREDENTIALS` from environment or config.
1919
- **Logging**: Credential paths are now masked in logs.
20-
- **CLI**: Version is now dynamically read from `package.json`.
20+
- **CLI**: Version is now injected at build time for SEA compatibility.
2121
- **Release**: Added SHA256 checksum generation to release workflow.
2222

2323
## [0.2.0] - 2025-12-21

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ cloudsqlctl setup
3131
cloudsqlctl [command] [options]
3232
```
3333

34+
For a complete reference of all commands and options, see the [Command Reference](docs/commands.md).
35+
3436
### Commands
3537

3638
| Command | Description |

‎artifacts/SHA256SUMS.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
fba808877110583ee067cfa9d19144c42ce8d8d8675a654b17a98c5b204b5567 cloudsqlctl-setup.exe
2-
d2427408dcbed72aa00a28fdfb55325ecb5ab847d1d7e23cdb8abef900308d12 cloudsqlctl.exe
1+
e31dbc09d73da85854c937e0c82a31d280b3acc84be77fc380f14ae44aaa5d23 cloudsqlctl-setup.exe
2+
8a7b8ecc1458317f7cf304b0920594c50b5167592a3a2bb8a149f9a8e753382e cloudsqlctl.exe

‎bin/cloudsqlctl.exe‎

1 KB
Binary file not shown.

‎docs/commands.md‎

Lines changed: 306 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,306 @@
1+
# Cloud SQL Proxy CLI Reference
2+
3+
**Version:** 0.3.1
4+
**Generated:** 2025-12-21
5+
6+
## Overview
7+
8+
```
9+
Usage: cloudsqlctl [options] [command]
10+
11+
CLI for managing Google Cloud SQL Auth Proxy
12+
13+
Options:
14+
-V, --version output the version number
15+
-h, --help display help for command
16+
17+
Commands:
18+
install [options] Download and install Cloud SQL Proxy
19+
update Update Cloud SQL Proxy to the latest version
20+
select Select a Cloud SQL instance
21+
list [options] List available Cloud SQL instances
22+
connect [options] <instance> Connect to a specific Cloud SQL instance
23+
start [options] Start the Cloud SQL Proxy
24+
stop Stop the Cloud SQL Proxy or Service
25+
status Check the status of the Cloud SQL Proxy and
26+
Service
27+
logs [options] View the tail of the proxy logs
28+
doctor Run diagnostics to verify environment setup
29+
reset [options] Reset configuration and remove local files
30+
env Manage environment variables
31+
service Manage the Cloud SQL Proxy Windows Service
32+
(Requires Admin)
33+
ps1 Manage PowerShell scripts
34+
repair Self-heal missing or corrupted files and
35+
configurations
36+
check [options] Verify full system configuration
37+
gcloud Manage Google Cloud CLI
38+
auth Manage authentication and credentials
39+
setup Interactive setup wizard
40+
paths Show resolved system paths and configuration
41+
locations
42+
help [command] display help for command
43+
```
44+
45+
## Commands
46+
47+
### install
48+
49+
```
50+
Usage: cloudsqlctl install [options]
51+
52+
Download and install Cloud SQL Proxy
53+
54+
Options:
55+
-v, --version <version> Specific version to install
56+
-h, --help display help for command
57+
```
58+
59+
### update
60+
61+
```
62+
Usage: cloudsqlctl update [options]
63+
64+
Update Cloud SQL Proxy to the latest version
65+
66+
Options:
67+
-h, --help display help for command
68+
```
69+
70+
### select
71+
72+
```
73+
Usage: cloudsqlctl select [options]
74+
75+
Select a Cloud SQL instance
76+
77+
Options:
78+
-h, --help display help for command
79+
```
80+
81+
### list
82+
83+
```
84+
Usage: cloudsqlctl list [options]
85+
86+
List available Cloud SQL instances
87+
88+
Options:
89+
--json Output as JSON
90+
-h, --help display help for command
91+
```
92+
93+
### connect
94+
95+
```
96+
Usage: cloudsqlctl connect [options] <instance>
97+
98+
Connect to a specific Cloud SQL instance
99+
100+
Arguments:
101+
instance Instance connection name (e.g., project:region:instance)
102+
103+
Options:
104+
-p, --port <port> Port to listen on (default: 5432)
105+
-h, --help display help for command
106+
```
107+
108+
### start
109+
110+
```
111+
Usage: cloudsqlctl start [options]
112+
113+
Start the Cloud SQL Proxy
114+
115+
Options:
116+
-p, --port <port> Port to listen on
117+
-h, --help display help for command
118+
```
119+
120+
### stop
121+
122+
```
123+
Usage: cloudsqlctl stop [options]
124+
125+
Stop the Cloud SQL Proxy or Service
126+
127+
Options:
128+
-h, --help display help for command
129+
```
130+
131+
### status
132+
133+
```
134+
Usage: cloudsqlctl status [options]
135+
136+
Check the status of the Cloud SQL Proxy and Service
137+
138+
Options:
139+
-h, --help display help for command
140+
```
141+
142+
### logs
143+
144+
```
145+
Usage: cloudsqlctl logs [options]
146+
147+
View the tail of the proxy logs
148+
149+
Options:
150+
-n, --lines <lines> Number of lines to show (default: 20)
151+
-h, --help display help for command
152+
```
153+
154+
### doctor
155+
156+
```
157+
Usage: cloudsqlctl doctor [options]
158+
159+
Run diagnostics to verify environment setup
160+
161+
Options:
162+
-h, --help display help for command
163+
```
164+
165+
### reset
166+
167+
```
168+
Usage: cloudsqlctl reset [options]
169+
170+
Reset configuration and remove local files
171+
172+
Options:
173+
--yes Confirm reset without prompting
174+
-h, --help display help for command
175+
```
176+
177+
### env
178+
179+
```
180+
Usage: cloudsqlctl env [options] [command]
181+
182+
Manage environment variables
183+
184+
Options:
185+
-h, --help display help for command
186+
187+
Commands:
188+
set [options] Set environment variables
189+
help [command] display help for command
190+
```
191+
192+
### service
193+
194+
```
195+
Usage: cloudsqlctl service [options] [command]
196+
197+
Manage the Cloud SQL Proxy Windows Service (Requires Admin)
198+
199+
Options:
200+
-h, --help display help for command
201+
202+
Commands:
203+
install [options] Install the Windows Service
204+
configure [options] Update Service Configuration
205+
remove Remove the Windows Service
206+
start Start the Windows Service
207+
stop Stop the Windows Service
208+
status Check Service Status
209+
help [command] display help for command
210+
```
211+
212+
### ps1
213+
214+
```
215+
Usage: cloudsqlctl ps1 [options] [command]
216+
217+
Manage PowerShell scripts
218+
219+
Options:
220+
-h, --help display help for command
221+
222+
Commands:
223+
generate Generate management PowerShell scripts
224+
help [command] display help for command
225+
```
226+
227+
### repair
228+
229+
```
230+
Usage: cloudsqlctl repair [options]
231+
232+
Self-heal missing or corrupted files and configurations
233+
234+
Options:
235+
-h, --help display help for command
236+
```
237+
238+
### check
239+
240+
```
241+
Usage: cloudsqlctl check [options]
242+
243+
Verify full system configuration
244+
245+
Options:
246+
--scope <scope> Environment scope (User, Machine, or auto) (default: "auto")
247+
-h, --help display help for command
248+
```
249+
250+
### gcloud
251+
252+
```
253+
Usage: cloudsqlctl gcloud [options] [command]
254+
255+
Manage Google Cloud CLI
256+
257+
Options:
258+
-h, --help display help for command
259+
260+
Commands:
261+
status Check gcloud CLI status
262+
install Install portable Google Cloud CLI
263+
help [command] display help for command
264+
```
265+
266+
### auth
267+
268+
```
269+
Usage: cloudsqlctl auth [options] [command]
270+
271+
Manage authentication and credentials
272+
273+
Options:
274+
-h, --help display help for command
275+
276+
Commands:
277+
status Check authentication status
278+
login Login via gcloud
279+
adc Setup Application Default Credentials
280+
project <projectId> Set active project
281+
set-service-account [options] Configure service account credentials
282+
help [command] display help for command
283+
```
284+
285+
### setup
286+
287+
```
288+
Usage: cloudsqlctl setup [options]
289+
290+
Interactive setup wizard
291+
292+
Options:
293+
-h, --help display help for command
294+
```
295+
296+
### paths
297+
298+
```
299+
Usage: cloudsqlctl paths [options]
300+
301+
Show resolved system paths and configuration locations
302+
303+
Options:
304+
-h, --help display help for command
305+
```
306+

0 commit comments

Comments
 (0)