kysely-ctl

#### Node.js:

``bash
npm i -g kysely-ctl
`

or:

`bash
pnpm add -g kysely-ctl
`

#### Bun

`bash
bun add -g kysely-ctl
`

#### Deno

`bash
deno install -g -f npm:kysely-ctl@latest
`


`bash
npm i -D kysely-ctl
`

or:

`bash
yarn add -D kysely-ctl
`

or:

`bash
pnpm add -D kysely-ctl
`

#### Bun

`bash
bun add -D kysely-ctl
`

#### Deno

`bash
deno add -D npm:kysely-ctl
`


`ts
import { defineConfig } from "kysely-ctl";

export default defineConfig({
destroyOnExit, // optional. dictates whether the (resolved) kysely instance should be destroyed when a command is finished executing. default is true.
dialect, // a Kysely dialect instance OR the name of an underlying driver library (e.g. 'pg').
dialectConfig, // optional. when dialect is the name of an underlying driver library, dialectConfig is the options passed to the Kysely dialect that matches that library.
migrations: { // optional.
allowJS, // optional. controls whether .js, .cjs or .mjs migrations are allowed. default is false.
getMigrationPrefix, // optional. a function that returns a migration prefix. affects migrate make command. default is () => ${Date.now()}_.
migrationFolder, // optional. path to where migration files are located. default is a folder named "migrations" next to the config file/folder.
migrator, // optional. a Kysely migrator instance factory of shape (db: Kysely) => Migrator | Promise. default is Kysely's Migrator.
provider, // optional. a Kysely migration provider instance. default is kysely-ctl's TSFileMigrationProvider.
},
plugins, // optional. Kysely plugins list. default is [].
seeds: { // optional.
allowJS, // optional. controls whether .js, .cjs or .mjs seeds are allowed. default is false.
getSeedPrefix, // optional. a function that returns a seed prefix. affects seed make command. default is () => ${Date.now()}_.
provider, // optional. a seed provider instance. default is kysely-ctl's FileSeedProvider.
seeder, // optional. a seeder instance factory of shape (db: Kysely) => Seeder | Promise. default is kysely-ctl's Seeder.
seedFolder, // optional. path to where seed files are located. default is a folder named "seeds" next to the config file/folder.
}
});
`

#### Reuse Kysely instance defined elsewhere

You can pass a Kysely instance, instead of dialect, dialectConfig & plugins:

`ts
import { defineConfig } from "kysely-ctl";
import { kysely } from 'path/to/kysely/instance';

export default defineConfig({
destroyOnExit, // optional. dictates whether the kysely instance should be destroyed when a command is finished executing. default is true.
// ...
kysely,
// ...
});
`

#### Custom migration/seed file prefixes

To use Knex's timestamp prefixes:

`ts
import { defineConfig, getKnexTimestampPrefix } from "kysely-ctl";

export default defineConfig({
// ...
migrations: {
// ...
getMigrationPrefix: getKnexTimestampPrefix,
// ...
},
// ...
});
`

#### Extending configuration

See c12 docs and the following example.

#### Environment-specific configuration

See c12 docs and the following example.

`bash
knex migrate:
`

Can now be called as either:

`bash
kysely migrate:
`

or

`bash
kysely migrate
`

> [!NOTE]
> rollback without --all flag is not supported, as Kysely
doesn't keep track of "migration batches".

`bash
knex seed:
`

Can now be called as either:

`bash
kysely seed:
`

or

`bash
kysely seed
`

> [!NOTE]
> We also provide kysely seed list, which is not part of Knex.js
CLI.

`bash
kysely sql "select 1"
`

or interactive mode:

`bash
kysely sql -f json

✔ sqlite ❯
select 1;
{
"rows": [
{
"1": 1
}
]
}

❯ sqlite ❯
exit
``