pev2-cli

Run the PostgreSQL Explain Visualizer 2 (pev2) from the command line.

Usage no npm install needed!

<script type="module">
  import pev2Cli from 'https://cdn.skypack.dev/pev2-cli';
</script>

README

pev2-cli

Run the PostgreSQL Explain Visualizer 2 (pev2) from the command line.

npm version build status ISC-licensed minimum Node.js version support me via GitHub Sponsors chat with me on Twitter

Installation

npm install -g pev2-cli

Usage

Usage:
    pev2 <path-to-query-file>
Notes:
    This tool will run the query using the `psql` command-line tool.
Options:
    --open     -o  Open the URL in the browser.
    --quiet    -q  Don't report what's going on.
    --once     -1  Stop serving after pev2 has received the data.
Examples:
    pev2 --open -q path/to/some-explain-query.sql

Because pev2-cli just uses the psql CLI tool provided by PostgreSQL, you can use all environment variables that it supports to configure access to your PostgreSQL database.

Contributing

If you have a question or need support using pev2-cli, please double-check your code and setup first. If you think you have found a bug or want to propose a feature, use the issues page.