Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/egoist/prisma-repl

REPL for Prisma databases.
https://github.com/egoist/prisma-repl

Last synced: 15 days ago
JSON representation

REPL for Prisma databases.

Awesome Lists containing this project

README

        

**💛 You can help the author become a full-time open-source maintainer by [sponsoring him on GitHub](https://github.com/sponsors/egoist).**

---

# prisma-repl

[![npm version](https://badgen.net/npm/v/prisma-repl)](https://npm.im/prisma-repl) [![npm downloads](https://badgen.net/npm/dm/prisma-repl)](https://npm.im/prisma-repl)

A REPL for [Prisma](https://www.prisma.io/).

## Install

```bash
npm i -g prisma-repl
# Or install locally
npm i -D prisma-repl
```

## Usage

Make sure you're inside a valid Prisma project, i.e. the directory where you ran `prisma init` or other Prisma commands.

```bash
$ prisma-repl
```

The Prisma client instance is available as `db`:

CleanShot 2021-06-03 at 21 58 31@2x

After regenerating the Prisma client, type `.reload` in the REPL to reload it.

## Running commands in the REPL

You can directly run commands in the REPL using `sh` tag:

running commands in the repl

For Prisma commands, you can use use the `prisma` shorthand:

CleanShot 2021-06-04 at 17 46 27@2x

The Prisma client is automatically reloaded in the REPL when you run commands like `prisma db push` or `prisma generate`.

## Help

```
prisma-repl/0.0.0

Usage:
$ prisma-repl [options]

Options:
--url Override database URL
--client The output directory for your prisma client (default: node_modules/@prisma/client)
--verbose Show all Prisma logs
-v, --version Display version number
-h, --help Display this message
```

## Sponsors

[![sponsors](https://sponsors-images.egoist.sh/sponsors.svg)](https://github.com/sponsors/egoist)

## License

MIT © [EGOIST](https://github.com/sponsors/egoist)