{"id":15592041,"url":"https://github.com/derhuerst/pev2-cli","last_synced_at":"2025-04-15T04:57:22.282Z","repository":{"id":55158411,"uuid":"305151196","full_name":"derhuerst/pev2-cli","owner":"derhuerst","description":"Run the PostgreSQL Explain Visualizer 2 (pev2) from the command line.","archived":false,"fork":false,"pushed_at":"2025-03-13T14:56:03.000Z","size":98,"stargazers_count":25,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-15T04:57:16.904Z","etag":null,"topics":["pev2","postgres","postgresql","query-optimization","query-optimizer","query-plan","query-planner","query-planning"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/derhuerst.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"liberapay":"derhuerst","patreon":"derhuerst","github":"derhuerst"}},"created_at":"2020-10-18T16:54:39.000Z","updated_at":"2025-03-13T14:56:04.000Z","dependencies_parsed_at":"2024-08-23T11:48:26.470Z","dependency_job_id":"6450a133-c43e-4959-ae84-c3b65b4c7eb5","html_url":"https://github.com/derhuerst/pev2-cli","commit_stats":{"total_commits":33,"total_committers":1,"mean_commits":33.0,"dds":0.0,"last_synced_commit":"7efb9d73fcee60c056baf32820b6310e33b082d1"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derhuerst%2Fpev2-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derhuerst%2Fpev2-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derhuerst%2Fpev2-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derhuerst%2Fpev2-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/derhuerst","download_url":"https://codeload.github.com/derhuerst/pev2-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249010210,"owners_count":21197797,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["pev2","postgres","postgresql","query-optimization","query-optimizer","query-plan","query-planner","query-planning"],"created_at":"2024-10-02T23:53:29.222Z","updated_at":"2025-04-15T04:57:22.263Z","avatar_url":"https://github.com/derhuerst.png","language":"JavaScript","funding_links":["https://liberapay.com/derhuerst","https://patreon.com/derhuerst","https://github.com/sponsors/derhuerst"],"categories":[],"sub_categories":[],"readme":"# pev2-cli\n\n**Run the [PostgreSQL Explain Visualizer 2 (pev2)](https://github.com/dalibo/pev2) from the command line.**\n\n[![npm version](https://img.shields.io/npm/v/pev2-cli.svg)](https://www.npmjs.com/package/pev2-cli)\n![ISC-licensed](https://img.shields.io/github/license/derhuerst/pev2-cli.svg)\n![minimum Node.js version](https://img.shields.io/node/v/pev2-cli.svg)\n[![support me via GitHub Sponsors](https://img.shields.io/badge/support%20me-donate-fa7664.svg)](https://github.com/sponsors/derhuerst)\n[![chat with me via Matrix](https://img.shields.io/badge/chat%20with%20me-via%20Matrix-000000.svg)](https://matrix.to/#/@derhuerst:matrix.org)\n\n\n## Installation\n\n```shell\nnpm install -g pev2-cli\n```\n\n\n## Usage\n\n```shell\nUsage:\n    pev2 \u003cpath-to-query-file\u003e [path-to-execution-plan]\nNotes:\n    This tool uses the pev2 to visualize PostgreSQL's execution plan including\n    costs associated to each operation.\n        more info: https://www.postgresql.org/docs/14/using-explain.html\n    To let PostgreSQL generate the plan, prefix it with the following line:\n        EXPLAIN (ANALYZE, COSTS, VERBOSE, BUFFERS, FORMAT JSON)\n\n    If you don't pass an execution plan, this tool will spawn `psql` to run the\n    the query. Use the `PG*` environment variables to make sure `psql` can\n    connect to the right database.\n        more info: https://www.postgresql.org/docs/14/libpq-envars.html\nOptions:\n    --open     -o  Open the URL in the browser.\n    --app          The browser to open the URL with.\n    --quiet    -q  Don't report what's going on.\n    --once     -1  Stop serving after pev2 has received the data.\n    --name     -n  Give the execution plan a name within pev2.\n                     Default: filename and ISO date+time\nExamples:\n    pev2 --open --app firefox -q path/to/some-explain-query.sql\n```\n\n\n## Contributing\n\nIf 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](https://github.com/derhuerst/pev2-cli/issues).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fderhuerst%2Fpev2-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fderhuerst%2Fpev2-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fderhuerst%2Fpev2-cli/lists"}