Repolode
dbcli

dbcli/pgcli

一款带自动补全和语法高亮的 Postgres 命令行客户端,可替代原生 psql。

可替代:psql

Star
13,422
Fork
613
未关闭 Issue
53
最近提交
9天前

这是什么?

pgcli 是一款面向 PostgreSQL 的交互式命令行客户端。输入时它会提示 SQL 关键字、表名和列名,并对查询语句进行语法高亮,相比原生 psql 更便于在终端中编写和探索查询。

补全默认是上下文相关的:在 FROM 之后只提示表名,在 WHERE 之后只提示列名。查询结果以表格形式美化输出,同时支持常用的 psql 反斜杠命令。连接时可以直接指定数据库名或完整的 postgresql:// 连接串,并支持标准的 PG* 环境变量和 SSL 相关配置。

项目基于 prompt_toolkit 和 Pygments 构建,可通过 pip、pipx 或 uvx 安装,也提供 Homebrew 和 Debian/Ubuntu 软件包。此外还可以用 Docker 运行,或通过 ipython-sql 在 IPython 会话中调用。

核心功能

  • 01输入时自动补全 SQL 关键字、表名和列名。
  • 02补全结果随上下文变化,例如 FROM 之后只提示表名。
  • 03终端中的查询语句支持语法高亮。
  • 04查询结果以美化的表格形式输出。
  • 05支持常用 psql 反斜杠命令和标准 PG* 环境变量。
  • 06首次启动后自动生成配置文件 ~/.config/pgcli/config,可自定义选项。

适用场景

  • 在终端中编写和调试针对 Postgres 数据库的 SQL 查询。
  • 借助补全功能快速熟悉陌生数据库的表结构和列名。
  • 日常通过 SSL 或 DSN 别名连接 Postgres 数据库。
  • 在 IPython 中调用 pgcli,将查询结果保留在 Python 会话里。

快速上手

  1. 1

    使用 pip 安装 pgcli

    pip install -U pgcli
  2. 2

    通过数据库名称连接

    pgcli [database_name]

使用前须知

  • 通过 pip 安装时需要本地已安装 Postgres。
  • 部分 Linux 和 macOS 安装方式依赖发行版或 Homebrew 软件包。

收录于专题

标签

常见问题

pgcli 是什么?
一款带自动补全和语法高亮的 Postgres 命令行客户端,可替代原生 psql。 pgcli 是一款面向 PostgreSQL 的交互式命令行客户端。输入时它会提示 SQL 关键字、表名和列名,并对查询语句进行语法高亮,相比原生 psql 更便于在终端中编写和探索查询。
pgcli 可以免费使用吗?用的什么许可证?
pgcli 以 BSD-3-Clause 许可证开源。用于商业产品前,请先确认许可证条款。
pgcli 还在维护吗?
活跃维护中。pgcli 最近一次提交是在 2026年10月15日。
pgcli 适合用来做什么?
在终端中编写和调试针对 Postgres 数据库的 SQL 查询。 借助补全功能快速熟悉陌生数据库的表结构和列名。 日常通过 SSL 或 DSN 别名连接 Postgres 数据库。 在 IPython 中调用 pgcli,将查询结果保留在 Python 会话里。
pgcli 怎么安装和运行?
使用 pip 安装 pgcli: pip install -U pgcli 通过数据库名称连接: pgcli [database_name]
在哪里获取 pgcli?
源代码和安装说明在 GitHub 上:https://github.com/dbcli/pgcli

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目