Repolode
dbcli

dbcli/pgcli

自動補完とシンタックスハイライトを備えたPostgres用コマンドラインクライアント。標準のpsqlシェルに代わる選択肢です。

代替できる製品:psql

スター
13,422
フォーク
613
未解決の Issue
53
最終コミット
9 日前

これは何?

pgcliは、PostgreSQL用の対話型コマンドラインクライアントです。入力中にSQLキーワード、テーブル名、カラム名を候補として提示し、クエリプロンプトの構文をハイライトします。これにより、素のpsqlシェルよりもターミナルで素早くクエリを作成・確認できます。

補完はデフォルトで文脈に応じて行われます。FROMの後にはテーブル名だけを、WHEREの後にはカラム名を候補として提示します。クエリ結果は見やすい表形式で表示され、一般的なpsqlのバックスラッシュコマンドに加えて、独自のオプションも利用できます。データベース名または完全なpostgresql:// URLを指定して接続でき、標準のPG*環境変数やSSL設定にも対応しています。

このプロジェクトはprompt_toolkitとPygmentsをベースにしており、Pythonパッケージとしてpip、pipx、uvxからインストールできます。HomebrewおよびDebian/Ubuntu向けのパッケージも用意されています。また、Dockerで実行したり、ipython-sql magicを使ってIPythonセッション内から起動したりすることもできます。

主な機能

  • 01入力中にSQLキーワード、テーブル名、カラム名を自動補完します。
  • 02FROMの後にはテーブル名だけを提示するなど、文脈に応じた補完に対応しています。
  • 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

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト