@alexvyber/pg-tools

A new CLI generated with oclif

• Usage
• Commands

Usage

$ npm install -g @alexvyber/pg-tools
$ pg-tools COMMAND
running command...
$ pg-tools (--version)
@alexvyber/pg-tools/0.0.0-dev.12 darwin-arm64 node-v24.7.0
$ pg-tools --help [COMMAND]
USAGE
  $ pg-tools COMMAND
...

Commands

• pg-tools create
• pg-tools drop

pg-tools create

create an empty database

USAGE
  $ pg-tools create [-h] [-e] [-i <value>] [-n <value> | -l <value>] [-u <value> | ] [-p <value> | ] [-o
    <value> | ] [-w <value> | ]

FLAGS
  -e, --existsError              [default: false] whether throw error if DB already exists
  -h, --help                     Show CLI help.
  -i, --initialDatabase=<value>  [default: postgres] Initial DB name
  -l, --url=<value>              DB URL, e.g. postgres://user:password@localhost:5432/my_db
  -n, --database=<value>         new DB name
  -o, --host=<value>             [default: localhost] new DB host
  -p, --port=<value>             [default: 5432] DB port, default `5432`
  -u, --user=<value>             [default: postgres] DB user name
  -w, --password=<value>         [default: empty] DB password

DESCRIPTION
  create an empty database

EXAMPLES
  $ pg-tools create --database=some-db

  $ DB_NAME=some-db pg-tools create

  $ pg-tools create --url postgresql://localhost:5432/some-db

  $ pg-tools create --database=some-db --existsError

  $ pg-tools create --database=some-db --password=123 --port=5433 --host=a.example.com --user=beer

See code: src/commands/create.ts

pg-tools drop

drop a database

USAGE
  $ pg-tools drop [-h] [-e] [-d] [-i <value>] [-n <value> | -l <value>] [-u <value> | ] [-p <value> | ]
    [-o <value> | ] [-w <value> | ]

FLAGS
  -d, --[no-]dropConnections     [default: true] whether automatically drop DB connections
  -e, --notExistsError           [default: false] whether throw error if DB doesn't exist
  -h, --help                     Show CLI help.
  -i, --initialDatabase=<value>  [default: postgres] Initial DB name
  -l, --url=<value>              URL of DB that will be dropped, e.g. postgres://user:password@localhost:5432/my_db
  -n, --database=<value>         name of DB that will be dropped
  -o, --host=<value>             [default: localhost] DB host
  -p, --port=<value>             [default: 5432] DB port, default `5432`
  -u, --user=<value>             [default: postgres] DB user name
  -w, --password=<value>         [default: empty] DB password

DESCRIPTION
  drop a database

EXAMPLES
  $ pg-tools drop --database=some-db

  $ DB_NAME=some-db pg-tools drop

  $ pg-tools drop --url postgresql://localhost:5432/some-db

  $ pg-tools drop --database=some-db --not-exists-error --no-dropConnections

  $ pg-tools drop --database=some-db --password=123 --port=5433 --host=a.example.com --user=beer

See code: src/commands/drop.ts