mycli
Rich MySQL 終端客戶端,具備自動完成、語法高亮及資料框架功能。
mycli 是什麼?
Rich MySQL 終端客戶端,具備自動完成、語法高亮及資料框架功能。
mycli 概覽
這是什麼
mycli 是一款功能豐富的 MySQL 終端機客戶端,具備自動完成、語法高亮以及資料框架(dataframe)功能。它相容於 MySQL、MariaDB、Percona、TiDB 與 Apache Doris。本專案為開放原始碼,採用 BSD 3-Clause 授權條款。
主要功能
- 輸入時自動完成 SQL 關鍵字、資料表、檢視表、欄位、列舉等。
- 智慧完成功能,能根據上下文提供相關建議(例如在
FROM後只顯示資料表名稱)。 - 使用 fzf 進行模糊歷史搜尋。
- 使用 Pygments 進行語法高亮。
- 支援多行查詢。
- 使用 Jinja 模板儲存常用查詢,並支援位置參數或命名參數。
- 支援 Polars 資料框架轉換、繪圖,以及 Parquet 格式儲存。
- 透過
/llm指令查詢 LLM,並利用資料庫綱要提供上下文。 - 將密碼儲存在系統金鑰環中。
- 現代化預設值,例如 UTF-8 連線類型與 SSL。
- 整合 SSH、Kubernetes、Vault 與 Boundary。
使用情境
- 編寫與執行 SQL 查詢,享受即時自動完成與語法高亮。
- 透過智慧完成功能探索資料庫綱要與資料表。
- 使用 Polars 資料框架分析查詢結果,進行轉換、繪圖或匯出為 Parquet。
- 儲存並重複使用常用查詢,並支援參數替換。
- 利用模糊比對搜尋指令歷史記錄。
- 查詢 LLM 並結合資料庫綱要上下文,協助撰寫查詢。
- 透過 SSH、Kubernetes、Vault 與 Boundary 管理資料庫連線。
快速開始
使用 pip 安裝(建議方式):
pip install --upgrade 'mycli[all]'
在 macOS 上:
brew update && brew install mycli pygments
在 Debian 或 Ubuntu 上:
apt-get install mycli fzf python3-pygments
不安裝直接試用(使用 uv):
uv tool run 'mycli[all]' --help
或使用 Docker:
docker run --pull=always -it ghcr.io/dbcli/mycli:latest
首次執行時會自動建立設定檔 ~/.myclirc。
授權與價格
mycli 為開放原始碼軟體,採用 BSD 3-Clause 授權條款,可免費使用。
內容整理自該專案公開的 README 與儲存庫資訊。