Skip to content

Improve docs for blitz start, blitz dev, blitz build #804

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tordans wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Improve docs for blitz start, blitz dev, blitz build #804

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
15b6543
Update cli-build.mdx
tordans Jan 4, 2023
8934f58
Update cli-build.mdx
tordans Jan 4, 2023
18aa445
Update cli-dev.mdx
tordans Jan 4, 2023
8e92bbe
Update cli-start.mdx
tordans Jan 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 7 additions & 13 deletions app/pages/docs/cli-build.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,23 @@ sidebar_label: blitz build

**Alias: `blitz b`**

Create a production build of your Blitz app. It compiles your Blitz app
Create a **production build** of your Blitz app. It compiles your Blitz app
into Next.js runtime code inside `.next`

This is a super thin wrapper over Next CLI to improve environment variable
loading.

```bash
blitz dev -e staging
```

It does the following:

1. Loads correct `.env.X` and `.env.X.local` files based on the `-e X`
flag that you specify. Ex: `-e staging` loads `.env.staging`.
2. Sets `process.env.APP_ENV` to the env name. Ex: `-e staging` =>
`APP_ENV=staging`.
3. Passes all other arguments directly to the next build command
1. Loads `.env.production`.
2. Sets `process.env.APP_ENV` to `production`
3. Passes all other arguments directly to the [`next build` command](https://nextjs.org/docs/api-reference/cli#build)

#### Options

| Option | Shorthand | Description | Default |
| ------- | --------- | ------------------------------------------------------------------------------------- | ------- |
| `--env` | `-e` | Set app environment name. [Read more](/docs/custom-environments#custom-environments). | None |
| Option | Shorthand | Description | Default |
| ------------------------ | --------- | ------------------------------------------------------------------------------------- | ------------- |
| `--inspect` | | Enable the Node.js inspector | `false` |

#### Examples

Expand Down
14 changes: 4 additions & 10 deletions app/pages/docs/cli-dev.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,16 @@ sidebar_label: blitz dev

**Alias: `blitz d`**

Starts the Blitz development server.
Starts the Blitz **development** server.

This is a super thin wrapper over Next CLI to improve environment variable
loading.

```bash
blitz dev -e staging
```

It does the following:

1. Loads correct `.env.X` and `.env.X.local` files based on the `-e X`
flag that you specify. Ex: `-e staging` loads `.env.staging`.
2. Sets `process.env.APP_ENV` to the env name. Ex: `-e staging` =>
`APP_ENV=staging`.
3. Passes all other arguments directly to the next build command
1. Loads correct `.env.local`.
2. Sets `process.env.APP_ENV` to the env `dev`.
3. Passes all other arguments directly to the [`next dev` command](https://nextjs.org/docs/api-reference/cli#development)

#### Options

Expand Down
14 changes: 4 additions & 10 deletions app/pages/docs/cli-start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,16 @@ sidebar_label: blitz start

**Alias: `blitz s`**

Starts the Blitz production server.
Starts the Blitz **production** server.

This is a super thin wrapper over Next CLI to improve environment variable
loading.

```bash
blitz dev -e staging
```

It does the following:

1. Loads correct `.env.X` and `.env.X.local` files based on the `-e X`
flag that you specify. Ex: `-e staging` loads `.env.staging`.
2. Sets `process.env.APP_ENV` to the env name. Ex: `-e staging` =>
`APP_ENV=staging`.
3. Passes all other arguments directly to the next build command
1. Loads correct `.env.production`.
2. Sets `process.env.APP_ENV` to the env `production`.
3. Passes all other arguments directly to the [`next start` command](https://nextjs.org/docs/api-reference/cli#production)

#### Options

Expand Down