Skip to content

Commit

Permalink
Restore README
Browse files Browse the repository at this point in the history
  • Loading branch information
msakrejda committed May 22, 2020
1 parent 7b92a58 commit 6824b4b
Showing 1 changed file with 27 additions and 8 deletions.
35 changes: 27 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,38 @@ Like heroku pg:psql but for any Postgres database

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g heroku-plugin-psql
$ oclif-example COMMAND
running command...
$ oclif-example (-v|--version|version)
heroku-plugin-psql/0.0.2 linux-x64 node-v13.8.0
$ oclif-example --help [COMMAND]
$ yarn add --global heroku-plugin-psql
$ heroku psql --app example-app
--> Connecting to DATABASE_URL
DATABASE=> help
You are using psql, the command-line interface to PostgreSQL.
Type: \copyright for distribution terms
\h for help with SQL commands
\? for help with psql commands
\g or terminate with semicolon to execute query
\q to quit
DATABASE=> \q
$ heroku psql --help
Like heroku pg:psql but for non-Heroku databases

USAGE
$ oclif-example COMMAND
...
$ heroku psql [DATABASE]

OPTIONS
-a, --app=app (required) app to run command against
-r, --remote=remote git remote of app to use
--command=command like --command (-c) in psql, runs single command and exits
--file=file like --file (-f) in psql, runs commands from a file and exits

EXAMPLE
$ heroku psql -a sushi
DATABASE=>

```
<!-- usagestop -->

Expand Down

0 comments on commit 6824b4b

Please sign in to comment.