You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+30-30Lines changed: 30 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# sql-agent
1
+
# sql-agent-cli
2
2
3
-
`sql-agent` is a read-only SQL CLI for agentic workflows.
3
+
`sql-agent-cli` is a read-only SQL CLI for agentic workflows.
4
4
5
5
It is designed to run safe, single-statement queries against configured database targets and return deterministic output that tools like Codex CLI and Claude Code can consume reliably.
6
6
@@ -13,7 +13,7 @@ V1 targets:
13
13
14
14
## Status
15
15
16
-
This repo is currently spec-first and under active development.
16
+
This repo is currently under active development.
17
17
18
18
The current behavior target is defined in [`spec.md`](./spec.md).
19
19
@@ -22,58 +22,58 @@ The current behavior target is defined in [`spec.md`](./spec.md).
22
22
Local development:
23
23
24
24
```text
25
-
uv run ./sql_agent.py --help
26
-
uv run ./sql_agent.py "SELECT 1"
25
+
uv run ./sql_agent_cli.py --help
26
+
uv run ./sql_agent_cli.py "SELECT 1"
27
27
```
28
28
29
29
Packaged command target:
30
30
31
31
```text
32
-
uvx sql-agent --help
33
-
sql-agent "SELECT 1"
32
+
uvx sql-agent-cli --help
33
+
sql-agent-cli "SELECT 1"
34
34
```
35
35
36
36
## Primary usage
37
37
38
38
Default target:
39
39
40
40
```text
41
-
sql-agent "SELECT id, name FROM users LIMIT 10"
41
+
sql-agent-cli "SELECT id, name FROM users LIMIT 10"
42
42
```
43
43
44
44
Named target:
45
45
46
46
```text
47
-
sql-agent --target reporting "SELECT COUNT(*) AS total FROM users"
47
+
sql-agent-cli --target reporting "SELECT COUNT(*) AS total FROM users"
sql-agent config init-native-auth --engine mysql --target dev
99
+
sql-agent-cli config init-native-auth --engine mysql
100
+
sql-agent-cli config init-native-auth --engine mysql --target dev
101
101
```
102
102
103
-
When `--target NAME` is provided, the tool should prefill non-secret fields such as host, port, database, and user where possible, while leaving the password blank.
103
+
When `--target NAME` is provided, the tool pre-fills non-secret fields such as host, port, database, and user where possible, while leaving the password blank.
0 commit comments