Skip to content

Commit 03d5895

Browse files
committed
Rename to sql-agent-cli for v0.9.1
1 parent 87e293e commit 03d5895

9 files changed

Lines changed: 90 additions & 89 deletions

File tree

.github/workflows/publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ jobs:
3939
id-token: write
4040
environment:
4141
name: pypi
42-
url: https://pypi.org/p/sql-agent
42+
url: https://pypi.org/p/sql-agent-cli
4343
steps:
4444
- name: Download dist artifacts
4545
uses: actions/download-artifact@v4

README.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# sql-agent
1+
# sql-agent-cli
22

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.
44

55
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.
66

@@ -13,7 +13,7 @@ V1 targets:
1313

1414
## Status
1515

16-
This repo is currently spec-first and under active development.
16+
This repo is currently under active development.
1717

1818
The current behavior target is defined in [`spec.md`](./spec.md).
1919

@@ -22,58 +22,58 @@ The current behavior target is defined in [`spec.md`](./spec.md).
2222
Local development:
2323

2424
```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"
2727
```
2828

2929
Packaged command target:
3030

3131
```text
32-
uvx sql-agent --help
33-
sql-agent "SELECT 1"
32+
uvx sql-agent-cli --help
33+
sql-agent-cli "SELECT 1"
3434
```
3535

3636
## Primary usage
3737

3838
Default target:
3939

4040
```text
41-
sql-agent "SELECT id, name FROM users LIMIT 10"
41+
sql-agent-cli "SELECT id, name FROM users LIMIT 10"
4242
```
4343

4444
Named target:
4545

4646
```text
47-
sql-agent --target reporting "SELECT COUNT(*) AS total FROM users"
47+
sql-agent-cli --target reporting "SELECT COUNT(*) AS total FROM users"
4848
```
4949

5050
Explicit query flag:
5151

5252
```text
53-
sql-agent --target reporting --query "SELECT NOW()"
53+
sql-agent-cli --target reporting --query "SELECT NOW()"
5454
```
5555

5656
SQL file:
5757

5858
```text
59-
sql-agent --target reporting --sql-file query.sql
59+
sql-agent-cli --target reporting --sql-file query.sql
6060
```
6161

6262
Stdin:
6363

6464
```text
65-
Get-Content query.sql | sql-agent --target reporting
65+
Get-Content query.sql | sql-agent-cli --target reporting
6666
```
6767

6868
One-off SQLite query without config:
6969

7070
```text
71-
sql-agent --engine sqlite --path C:\data\app.db "SELECT * FROM customers LIMIT 5"
71+
sql-agent-cli --engine sqlite --path C:\data\app.db "SELECT * FROM customers LIMIT 5"
7272
```
7373

7474
## Auth
7575

76-
`sql-agent` is designed to prefer native client credential mechanisms over password arguments.
76+
`sql-agent-cli` is designed to prefer native client credential mechanisms over password arguments.
7777

7878
Supported v1 auth patterns:
7979

@@ -82,32 +82,32 @@ Supported v1 auth patterns:
8282
- Generic fallback: `--password-stdin`
8383
- Optional human fallback: `--prompt-password`
8484

85-
`sql-agent` does not document or guarantee `MYSQL_PWD` as a public credential source.
85+
`sql-agent-cli` does not document or guarantee `MYSQL_PWD` as a public credential source.
8686

8787
### Bootstrap native auth files
8888

8989
Seed a PostgreSQL template:
9090

9191
```text
92-
sql-agent config init-native-auth --engine postgres
93-
sql-agent config init-native-auth --engine postgres --target reporting
92+
sql-agent-cli config init-native-auth --engine postgres
93+
sql-agent-cli config init-native-auth --engine postgres --target reporting
9494
```
9595

9696
Seed a MySQL template:
9797

9898
```text
99-
sql-agent config init-native-auth --engine mysql
100-
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
101101
```
102102

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.
104104

105105
## Config
106106

107107
User config path:
108108

109109
```text
110-
~/.sql-agent/config.toml
110+
~/.sql-agent-cli/config.toml
111111
```
112112

113113
Example:
@@ -144,16 +144,16 @@ path = "C:/data/app.db"
144144
Config commands:
145145

146146
```text
147-
sql-agent config show
148-
sql-agent config set-default-target NAME
149-
sql-agent config add-target NAME [options]
150-
sql-agent config remove-target NAME
151-
sql-agent config init-native-auth --engine postgres [--target NAME]
152-
sql-agent config init-native-auth --engine mysql [--target NAME]
153-
sql-agent targets
147+
sql-agent-cli config show
148+
sql-agent-cli config set-default-target NAME
149+
sql-agent-cli config add-target NAME [options]
150+
sql-agent-cli config remove-target NAME
151+
sql-agent-cli config init-native-auth --engine postgres [--target NAME]
152+
sql-agent-cli config init-native-auth --engine mysql [--target NAME]
153+
sql-agent-cli targets
154154
```
155155

156-
`config show` should display effective target settings and credential-source hints without revealing secrets.
156+
`config show` displays effective target settings and credential-source hints without revealing secrets.
157157

158158
## Output
159159

@@ -182,7 +182,7 @@ Intended allowed statement classes include:
182182
- `DESCRIBE` / `DESC`
183183
- `EXPLAIN`
184184

185-
The tool is intended to reject mutating or administrative statements before execution and to execute exactly one statement per invocation.
185+
The tool rejects mutating or administrative statements before execution and executes exactly one statement per invocation.
186186

187187
## SSL
188188

pyproject.toml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ requires = ["hatchling"]
33
build-backend = "hatchling.build"
44

55
[project]
6-
name = "sql-agent"
7-
version = "0.9.0"
6+
name = "sql-agent-cli"
7+
version = "0.9.1"
88
description = "Read-only SQL CLI for agentic workflows"
99
readme = "README.md"
1010
license = "MIT"
@@ -34,12 +34,12 @@ dependencies = [
3434
]
3535

3636
[project.urls]
37-
Homepage = "https://github.com/pseudosavant/sql-agent"
38-
Repository = "https://github.com/pseudosavant/sql-agent"
39-
Issues = "https://github.com/pseudosavant/sql-agent/issues"
37+
Homepage = "https://github.com/pseudosavant/sql-agent-cli"
38+
Repository = "https://github.com/pseudosavant/sql-agent-cli"
39+
Issues = "https://github.com/pseudosavant/sql-agent-cli/issues"
4040

4141
[project.scripts]
42-
sql-agent = "sql_agent.cli:main"
42+
sql-agent-cli = "sql_agent.cli:main"
4343

4444
[tool.hatch.build.targets.wheel]
4545
packages = ["src/sql_agent"]

0 commit comments

Comments
 (0)