pomelo-dbtalk 0.23.1__tar.gz

pomelo_dbtalk-0.23.1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pomelo_dbtalk-0.23.1/PKG-INFO

@@ -0,0 +1,349 @@
+Metadata-Version: 2.3
+Name: pomelo-dbtalk
+Version: 0.23.1
+Summary: MySQL and PostgreSQL backup/restore plus JSONL database transfer CLI.
+License: 
+                                          Apache License
+                                    Version 2.0, January 2004
+                                 http://www.apache.org/licenses/
+         
+            TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+         
+            1. Definitions.
+         
+               "License" shall mean the terms and conditions for use, reproduction,
+               and distribution as defined by Sections 1 through 9 of this document.
+         
+               "Licensor" shall mean the copyright owner or entity authorized by
+               the copyright owner that is granting the License.
+         
+               "Legal Entity" shall mean the union of the acting entity and all
+               other entities that control, are controlled by, or are under common
+               control with that entity. For the purposes of this definition,
+               "control" means (i) the power, direct or indirect, to cause the
+               direction or management of such entity, whether by contract or
+               otherwise, or (ii) ownership of fifty percent (50%) or more of the
+               outstanding shares, or (iii) beneficial ownership of such entity.
+         
+               "You" (or "Your") shall mean an individual or Legal Entity
+               exercising permissions granted by this License.
+         
+               "Source" form shall mean the preferred form for making modifications,
+               including but not limited to software source code, documentation
+               source, and configuration files.
+         
+               "Object" form shall mean any form resulting from mechanical
+               transformation or translation of a Source form, including but
+               not limited to compiled object code, generated documentation,
+               and conversions to other media types.
+         
+               "Work" shall mean the work of authorship, whether in Source or
+               Object form, made available under the License, as indicated by a
+               copyright notice that is included in or attached to the work
+               (an example is provided in the Appendix below).
+         
+               "Derivative Works" shall mean any work, whether in Source or Object
+               form, that is based on (or derived from) the Work and for which the
+               editorial revisions, annotations, elaborations, or other modifications
+               represent, as a whole, an original work of authorship. For the purposes
+               of this License, Derivative Works shall not include works that remain
+               separable from, or merely link (or bind by name) to the interfaces of,
+               the Work and Derivative Works thereof.
+         
+               "Contribution" shall mean any work of authorship, including
+               the original version of the Work and any modifications or additions
+               to that Work or Derivative Works thereof, that is intentionally
+               submitted to Licensor for inclusion in the Work by the copyright owner
+               or by an individual or Legal Entity authorized to submit on behalf of
+               the copyright owner. For the purposes of this definition, "submitted"
+               means any form of electronic, verbal, or written communication sent
+               to the Licensor or its representatives, including but not limited to
+               communication on electronic mailing lists, source code control systems,
+               and issue tracking systems that are managed by, or on behalf of, the
+               Licensor for the purpose of discussing and improving the Work, but
+               excluding communication that is conspicuously marked or otherwise
+               designated in writing by the copyright owner as "Not a Contribution."
+         
+               "Contributor" shall mean Licensor and any individual or Legal Entity
+               on behalf of whom a Contribution has been received by Licensor and
+               subsequently incorporated within the Work.
+         
+            2. Grant of Copyright License. Subject to the terms and conditions of
+               this License, each Contributor hereby grants to You a perpetual,
+               worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+               copyright license to reproduce, prepare Derivative Works of,
+               publicly display, publicly perform, sublicense, and distribute the
+               Work and such Derivative Works in Source or Object form.
+         
+            3. Grant of Patent License. Subject to the terms and conditions of
+               this License, each Contributor hereby grants to You a perpetual,
+               worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+               (except as stated in this section) patent license to make, have made,
+               use, offer to sell, sell, import, and otherwise transfer the Work,
+               where such license applies only to those patent claims licensable
+               by such Contributor that are necessarily infringed by their
+               Contribution(s) alone or by combination of their Contribution(s)
+               with the Work to which such Contribution(s) was submitted. If You
+               institute patent litigation against any entity (including a
+               cross-claim or counterclaim in a lawsuit) alleging that the Work
+               or a Contribution incorporated within the Work constitutes direct
+               or contributory patent infringement, then any patent licenses
+               granted to You under this License for that Work shall terminate
+               as of the date such litigation is filed.
+         
+            4. Redistribution. You may reproduce and distribute copies of the
+               Work or Derivative Works thereof in any medium, with or without
+               modifications, and in Source or Object form, provided that You
+               meet the following conditions:
+         
+               (a) You must give any other recipients of the Work or
+                   Derivative Works a copy of this License; and
+         
+               (b) You must cause any modified files to carry prominent notices
+                   stating that You changed the files; and
+         
+               (c) You must retain, in the Source form of any Derivative Works
+                   that You distribute, all copyright, patent, trademark, and
+                   attribution notices from the Source form of the Work,
+                   excluding those notices that do not pertain to any part of
+                   the Derivative Works; and
+         
+               (d) If the Work includes a "NOTICE" text file as part of its
+                   distribution, then any Derivative Works that You distribute must
+                   include a readable copy of the attribution notices contained
+                   within such NOTICE file, excluding those notices that do not
+                   pertain to any part of the Derivative Works, in at least one
+                   of the following places: within a NOTICE text file distributed
+                   as part of the Derivative Works; within the Source form or
+                   documentation, if provided along with the Derivative Works; or,
+                   within a display generated by the Derivative Works, if and
+                   wherever such third-party notices normally appear. The contents
+                   of the NOTICE file are for informational purposes only and
+                   do not modify the License. You may add Your own attribution
+                   notices within Derivative Works that You distribute, alongside
+                   or as an addendum to the NOTICE text from the Work, provided
+                   that such additional attribution notices cannot be construed
+                   as modifying the License.
+         
+               You may add Your own copyright statement to Your modifications and
+               may provide additional or different license terms and conditions
+               for use, reproduction, or distribution of Your modifications, or
+               for any such Derivative Works as a whole, provided Your use,
+               reproduction, and distribution of the Work otherwise complies with
+               the conditions stated in this License.
+         
+            5. Submission of Contributions. Unless You explicitly state otherwise,
+               any Contribution intentionally submitted for inclusion in the Work
+               by You to the Licensor shall be under the terms and conditions of
+               this License, without any additional terms or conditions.
+               Notwithstanding the above, nothing herein shall supersede or modify
+               the terms of any separate license agreement you may have executed
+               with Licensor regarding such Contributions.
+         
+            6. Trademarks. This License does not grant permission to use the trade
+               names, trademarks, service marks, or product names of the Licensor,
+               except as required for reasonable and customary use in describing the
+               origin of the Work and reproducing the content of the NOTICE file.
+         
+            7. Disclaimer of Warranty. Unless required by applicable law or
+               agreed to in writing, Licensor provides the Work (and each
+               Contributor provides its Contributions) on an "AS IS" BASIS,
+               WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+               implied, including, without limitation, any warranties or conditions
+               of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+               PARTICULAR PURPOSE. You are solely responsible for determining the
+               appropriateness of using or redistributing the Work and assume any
+               risks associated with Your exercise of permissions under this License.
+         
+            8. Limitation of Liability. In no event and under no legal theory,
+               whether in tort (including negligence), contract, or otherwise,
+               unless required by applicable law (such as deliberate and grossly
+               negligent acts) or agreed to in writing, shall any Contributor be
+               liable to You for damages, including any direct, indirect, special,
+               incidental, or consequential damages of any character arising as a
+               result of this License or out of the use or inability to use the
+               Work (including but not limited to damages for loss of goodwill,
+               work stoppage, computer failure or malfunction, or any and all
+               other commercial damages or losses), even if such Contributor
+               has been advised of the possibility of such damages.
+         
+            9. Accepting Warranty or Additional Liability. While redistributing
+               the Work or Derivative Works thereof, You may choose to offer,
+               and charge a fee for, acceptance of support, warranty, indemnity,
+               or other liability obligations and/or rights consistent with this
+               License. However, in accepting such obligations, You may act only
+               on Your own behalf and on Your sole responsibility, not on behalf
+               of any other Contributor, and only if You agree to indemnify,
+               defend, and hold each Contributor harmless for any liability
+               incurred by, or claims asserted against, such Contributor by reason
+               of your accepting any such warranty or additional liability.
+         
+            END OF TERMS AND CONDITIONS
+         
+            APPENDIX: How to apply the Apache License to your work.
+         
+               To apply the Apache License to your work, attach the following
+               boilerplate notice, with the fields enclosed by brackets "[]"
+               replaced with your own identifying information. (Don't include
+               the brackets!)  The text should be enclosed in the appropriate
+               comment syntax for the file format. We also recommend that a
+               file or class name and description of purpose be included on the
+               same "printed page" as the copyright notice for easier
+               identification within third-party archives.
+         
+            Copyright [yyyy] [name of copyright owner]
+         
+            Licensed under the Apache License, Version 2.0 (the "License");
+            you may not use this file except in compliance with the License.
+            You may obtain a copy of the License at
+         
+                http://www.apache.org/licenses/LICENSE-2.0
+         
+            Unless required by applicable law or agreed to in writing, software
+            distributed under the License is distributed on an "AS IS" BASIS,
+            WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+            See the License for the specific language governing permissions and
+            limitations under the License.
+Requires-Dist: sqlalchemy>=2.0,<3
+Requires-Dist: aiosqlite>=0.20,<1
+Requires-Dist: asyncmy>=0.2,<1
+Requires-Dist: click>=8.1,<9
+Requires-Dist: dynaconf>=3.3,<4
+Requires-Dist: psycopg[binary]>=3.2,<4
+Requires-Dist: pymysql>=1.1,<2
+Requires-Dist: python-dotenv>=1.1,<2
+Requires-Dist: pyyaml>=6.0,<7
+Requires-Dist: tabulate>=0.9,<1
+Requires-Dist: tzdata>=2025.2
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# dbtalk
+
+[![CI](https://github.com/leoninew/pomelo-dbtalk/actions/workflows/ci.yml/badge.svg)](https://github.com/leoninew/pomelo-dbtalk/actions/workflows/ci.yml)
+
+`dbtalk` is an LLM-ready database CLI for SQL operations, JSONL data transfer, permissions, and logical backups across SQLite, MySQL, and PostgreSQL.
+
+[中文文档](README.zh-CN.md)
+
+## Features
+
+- Run SQL with `query` and `exec`, including bound parameters and timeouts
+- Transfer JSONL data between SQLite, MySQL, and PostgreSQL
+- Manage MySQL schemas and users, and PostgreSQL schemas and roles
+- Grant and revoke permission profiles; inspect native permissions with `permissions list/show`
+- Create and restore MySQL SQL dumps and PostgreSQL custom archives
+- Provide database-focused skills for Codex, Claude, and Grok agents
+
+## Installation
+
+Requires Python 3.12+. Install the published CLI with:
+
+```bash
+uv tool install pomelo-dbtalk
+dbtalk --help
+```
+
+From a checkout, use [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv sync --all-groups
+uv run dbtalk --help
+```
+
+## Quick start
+
+Keep the connection string in the current directory's `.env`, then refer to it only by name:
+
+```dotenv
+DBTALK_DSN_APP=sqlite:///./data/app.db
+```
+
+```bash
+uv run dbtalk query \
+  --dsn-env DBTALK_DSN_APP \
+  --sql 'SELECT 1 AS ok'
+
+uv run dbtalk exec \
+  --dsn-env DBTALK_DSN_APP \
+  --sql 'CREATE TABLE IF NOT EXISTS notes (id INTEGER PRIMARY KEY, body TEXT NOT NULL)'
+```
+
+`query` is read-only; `exec` runs a write-capable session. Add `-v` on a leaf command to see sanitized exception details.
+
+Agents write the DSN to `.env` before the first database command. `--dsn-env DBTALK_DSN_*` reads the process environment first and only falls back to the current `.env` when that variable is absent.
+
+## Commands
+
+| Command | Purpose |
+| --- | --- |
+| `dbtalk mysql schema` | Manage MySQL schemas/databases |
+| `dbtalk mysql user` | Manage MySQL users |
+| `dbtalk mysql grant` / `dbtalk mysql revoke` | Grant or revoke MySQL permissions |
+| `dbtalk postgres schema` | Manage PostgreSQL schemas/databases |
+| `dbtalk postgres role` | Manage PostgreSQL roles |
+| `dbtalk postgres grant` / `dbtalk postgres revoke` | Grant or revoke PostgreSQL permissions |
+| `dbtalk mysql permissions list/show` | Inspect native MySQL permissions |
+| `dbtalk postgres permissions list/show` | Inspect native PostgreSQL permissions |
+| `dbtalk mysql dump/restore` | Create or restore MySQL SQL dumps |
+| `dbtalk postgres dump/restore` | Create or restore PostgreSQL custom archives |
+| `dbtalk query/exec` | Query or execute one SQL statement |
+| `dbtalk export/import` | Transfer JSONL data |
+
+Run `uv run dbtalk --help` or a subcommand's `--help` for full options.
+
+## DSNs and configuration
+
+Supported DSN examples:
+
+```text
+sqlite:///./data/app.db
+mysql+pymysql://user:password@host:3306/app
+postgresql+psycopg://user:password@host:5432/app
+```
+
+Every command accepts exactly one of `--dsn DSN` or `--dsn-env NAME`; `--dsn` remains available for direct integrations. Agent workflows must plan a `DBTALK_DSN_*` name, write the value to the current `.env`, and use only `--dsn-env`. `.env.local` and other dotenv variants are not loaded. Defaults are in [dbtalk.yaml](dbtalk.yaml) and can be overridden with `DBTALK_` process environment variables.
+
+## Documentation
+
+- [Database operations](docs/database.md): SQL, JSONL transfer, and DSN conventions
+- [MySQL guide](docs/mysql.md): schemas, users, permissions, dump, and restore
+- [PostgreSQL guide](docs/postgres.md): schemas, roles, permissions, dump, and restore
+
+## Agent integration
+
+The repository ships a `dbtalk` plugin for Codex, Claude, and Grok with three skills:
+
+- `dbtalk`: SQL and JSONL data transfer
+- `dbtalk-mysql`: MySQL schemas, users, permissions, and dump/restore
+- `dbtalk-postgres`: PostgreSQL schemas, roles, permissions, and dump/restore
+
+Install or synchronize the local plugin with:
+
+```bash
+make install
+```
+
+See [Agent plugin and skills](docs/codex.md) for installation details, parameter constraints, and safety boundaries.
+
+## Development
+
+```bash
+make deps
+make check
+make test
+make release
+```
+
+`make check` runs Ruff and Mypy. `make test` runs the test suite; integration tests requiring a real database are skipped by default.
+
+## License
+
+Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE).
+
+## Docker
+
+```bash
+docker build -t dbtalk .
+docker run --rm dbtalk --help
+```

pomelo_dbtalk-0.23.1/README.md

@@ -0,0 +1,129 @@
+# dbtalk
+
+[![CI](https://github.com/leoninew/pomelo-dbtalk/actions/workflows/ci.yml/badge.svg)](https://github.com/leoninew/pomelo-dbtalk/actions/workflows/ci.yml)
+
+`dbtalk` is an LLM-ready database CLI for SQL operations, JSONL data transfer, permissions, and logical backups across SQLite, MySQL, and PostgreSQL.
+
+[中文文档](README.zh-CN.md)
+
+## Features
+
+- Run SQL with `query` and `exec`, including bound parameters and timeouts
+- Transfer JSONL data between SQLite, MySQL, and PostgreSQL
+- Manage MySQL schemas and users, and PostgreSQL schemas and roles
+- Grant and revoke permission profiles; inspect native permissions with `permissions list/show`
+- Create and restore MySQL SQL dumps and PostgreSQL custom archives
+- Provide database-focused skills for Codex, Claude, and Grok agents
+
+## Installation
+
+Requires Python 3.12+. Install the published CLI with:
+
+```bash
+uv tool install pomelo-dbtalk
+dbtalk --help
+```
+
+From a checkout, use [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv sync --all-groups
+uv run dbtalk --help
+```
+
+## Quick start
+
+Keep the connection string in the current directory's `.env`, then refer to it only by name:
+
+```dotenv
+DBTALK_DSN_APP=sqlite:///./data/app.db
+```
+
+```bash
+uv run dbtalk query \
+  --dsn-env DBTALK_DSN_APP \
+  --sql 'SELECT 1 AS ok'
+
+uv run dbtalk exec \
+  --dsn-env DBTALK_DSN_APP \
+  --sql 'CREATE TABLE IF NOT EXISTS notes (id INTEGER PRIMARY KEY, body TEXT NOT NULL)'
+```
+
+`query` is read-only; `exec` runs a write-capable session. Add `-v` on a leaf command to see sanitized exception details.
+
+Agents write the DSN to `.env` before the first database command. `--dsn-env DBTALK_DSN_*` reads the process environment first and only falls back to the current `.env` when that variable is absent.
+
+## Commands
+
+| Command | Purpose |
+| --- | --- |
+| `dbtalk mysql schema` | Manage MySQL schemas/databases |
+| `dbtalk mysql user` | Manage MySQL users |
+| `dbtalk mysql grant` / `dbtalk mysql revoke` | Grant or revoke MySQL permissions |
+| `dbtalk postgres schema` | Manage PostgreSQL schemas/databases |
+| `dbtalk postgres role` | Manage PostgreSQL roles |
+| `dbtalk postgres grant` / `dbtalk postgres revoke` | Grant or revoke PostgreSQL permissions |
+| `dbtalk mysql permissions list/show` | Inspect native MySQL permissions |
+| `dbtalk postgres permissions list/show` | Inspect native PostgreSQL permissions |
+| `dbtalk mysql dump/restore` | Create or restore MySQL SQL dumps |
+| `dbtalk postgres dump/restore` | Create or restore PostgreSQL custom archives |
+| `dbtalk query/exec` | Query or execute one SQL statement |
+| `dbtalk export/import` | Transfer JSONL data |
+
+Run `uv run dbtalk --help` or a subcommand's `--help` for full options.
+
+## DSNs and configuration
+
+Supported DSN examples:
+
+```text
+sqlite:///./data/app.db
+mysql+pymysql://user:password@host:3306/app
+postgresql+psycopg://user:password@host:5432/app
+```
+
+Every command accepts exactly one of `--dsn DSN` or `--dsn-env NAME`; `--dsn` remains available for direct integrations. Agent workflows must plan a `DBTALK_DSN_*` name, write the value to the current `.env`, and use only `--dsn-env`. `.env.local` and other dotenv variants are not loaded. Defaults are in [dbtalk.yaml](dbtalk.yaml) and can be overridden with `DBTALK_` process environment variables.
+
+## Documentation
+
+- [Database operations](docs/database.md): SQL, JSONL transfer, and DSN conventions
+- [MySQL guide](docs/mysql.md): schemas, users, permissions, dump, and restore
+- [PostgreSQL guide](docs/postgres.md): schemas, roles, permissions, dump, and restore
+
+## Agent integration
+
+The repository ships a `dbtalk` plugin for Codex, Claude, and Grok with three skills:
+
+- `dbtalk`: SQL and JSONL data transfer
+- `dbtalk-mysql`: MySQL schemas, users, permissions, and dump/restore
+- `dbtalk-postgres`: PostgreSQL schemas, roles, permissions, and dump/restore
+
+Install or synchronize the local plugin with:
+
+```bash
+make install
+```
+
+See [Agent plugin and skills](docs/codex.md) for installation details, parameter constraints, and safety boundaries.
+
+## Development
+
+```bash
+make deps
+make check
+make test
+make release
+```
+
+`make check` runs Ruff and Mypy. `make test` runs the test suite; integration tests requiring a real database are skipped by default.
+
+## License
+
+Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE).
+
+## Docker
+
+```bash
+docker build -t dbtalk .
+docker run --rm dbtalk --help
+```