Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
acro5piano authored Sep 10, 2024
1 parent 4f47d88 commit 1ad451f
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,19 +132,21 @@ Important Notes:
You can run `kysely-migration-cli` without a script file.

```
env DATABASE_URL=postgres://postgres:postgres@127.0.0.1:27253/postgres \
env DATABASE_URL=postgres://postgres:postgres@127.0.0.1:5432/postgres \
npm run kysely-migration-cli
```

If you place an `.env` file containing `DATABASE_URL=postgres://...`, the CLI will automatically load it before execution. To enable this, you need to install the dotenv module (`npm install dotenv`) .

To compile typescript, `kysely-migration-cli` attempts to register a transpiler using Node's hook api. It currently supports the following transpilers:
To transpile TypeScript, `kysely-migration-cli` attempts to register a transpiler using Node's hook api. It currently supports the following transpilers:

- `esbuild-register`
- `ts-node/register/transpile-only`
- `@swc-node/register`

If you require additional support, please submit a pull request.
> Of course, they are not required for platforms which supports TypeScript natively, such as `Deno` and `Bun`.
If you require additional registration supports, please submit a pull request.

# Related Packages

Expand Down

0 comments on commit 1ad451f

Please sign in to comment.