mirror of
https://github.com/LukeHagar/better-auth.git
synced 2025-12-10 12:27:44 +00:00
docs(cli): update init and config file references
This commit is contained in:
@@ -14,12 +14,6 @@ The `init` command allows you to initialize Better Auth in your project.
|
|||||||
npx @better-auth/cli@latest init
|
npx @better-auth/cli@latest init
|
||||||
```
|
```
|
||||||
|
|
||||||
You can also pass a list of plugins separated by a comma to the `init` command.
|
|
||||||
|
|
||||||
```bash title="Terminal"
|
|
||||||
npx @better-auth/cli@latest init admin, organization, two-factor
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
### Options
|
||||||
|
|
||||||
- `--name` - The name of your application. (Defaults to your `package.json`'s `name` property.)
|
- `--name` - The name of your application. (Defaults to your `package.json`'s `name` property.)
|
||||||
@@ -28,13 +22,6 @@ npx @better-auth/cli@latest init admin, organization, two-factor
|
|||||||
- `--database` - The database you want to use. Currently, the only supported database is `sqlite`.
|
- `--database` - The database you want to use. Currently, the only supported database is `sqlite`.
|
||||||
- `--package-manager` - The package manager you want to use. Currently, the only supported package managers are `npm`, `pnpm`, `yarn`, `bun`. (Defaults to the manager you used to initialize the CLI.)
|
- `--package-manager` - The package manager you want to use. Currently, the only supported package managers are `npm`, `pnpm`, `yarn`, `bun`. (Defaults to the manager you used to initialize the CLI.)
|
||||||
|
|
||||||
### How it works
|
|
||||||
|
|
||||||
1. Checks if you have `package.json` file in your project.
|
|
||||||
2. Checks if you have `lib` directory, or `src/lib` directory in your project.
|
|
||||||
3. Checks if you have `better-auth.ts` file in your project. (If not, it will create one.)
|
|
||||||
4.
|
|
||||||
|
|
||||||
|
|
||||||
## Generate
|
## Generate
|
||||||
|
|
||||||
@@ -47,7 +34,7 @@ npx @better-auth/cli@latest generate
|
|||||||
### Options
|
### Options
|
||||||
|
|
||||||
- `--output` - Where to save the generated schema. For Prisma, it will be saved in prisma/schema.prisma. For Drizzle, it goes to schema.ts in your project root. For Kysely, it’s an SQL file saved as schema.sql in your project root.
|
- `--output` - Where to save the generated schema. For Prisma, it will be saved in prisma/schema.prisma. For Drizzle, it goes to schema.ts in your project root. For Kysely, it’s an SQL file saved as schema.sql in your project root.
|
||||||
- `--config` - The path to your Better Auth config file. By default, the CLI will search for a better-auth.ts file in **./**, **./utils**, **./lib**, or any of these directories under `src` directory.
|
- `--config` - The path to your Better Auth config file. By default, the CLI will search for a auth.ts file in **./**, **./utils**, **./lib**, or any of these directories under `src` directory.
|
||||||
- `--y` - Skip the confirmation prompt and generate the schema directly.
|
- `--y` - Skip the confirmation prompt and generate the schema directly.
|
||||||
|
|
||||||
|
|
||||||
@@ -61,7 +48,7 @@ npx @better-auth/cli@latest migrate
|
|||||||
|
|
||||||
### Options
|
### Options
|
||||||
|
|
||||||
- `--config` - The path to your Better Auth config file. By default, the CLI will search for a better-auth.ts file in **./**, **./utils**, **./lib**, or any of these directories under `src` directory.
|
- `--config` - The path to your Better Auth config file. By default, the CLI will search for a auth.ts file in **./**, **./utils**, **./lib**, or any of these directories under `src` directory.
|
||||||
- `--y` - Skip the confirmation prompt and apply the schema directly.
|
- `--y` - Skip the confirmation prompt and apply the schema directly.
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user