Skip to content

Document --outDir CLI flag #5043

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

Merged
sarah11918 merged 4 commits into from
Oct 12, 2023
Merged

Document --outDir CLI flag #5043

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
aa0a9da
Document `--outDir` CLI flag
delucis Oct 11, 2023
3840023
Fix flags section under `astro build`
delucis Oct 11, 2023
cb67b27
Make flags mention in `astro build` docs match `astro preview`
delucis Oct 11, 2023
345ada0
Merge branch 'main' into dx-716/cli-reference
delucis Oct 12, 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
10 changes: 7 additions & 3 deletions src/content/docs/en/reference/cli-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,9 +219,7 @@ Do not use the `--host` flag to expose the dev server in a production environmen

Builds your site for deployment. By default, this will generate static files and place them in a `dist/` directory. If [SSR is enabled](/en/guides/server-side-rendering/), this will generate the necessary server files to serve your site.

<h3>Flags</h3>

Use these flags to customize your build. For flags shared with other Astro commands, see [common flags](#common-flags) below.
Can be combined with the [common flags](#common-flags) documented below.

## `astro preview`

Expand Down Expand Up @@ -339,6 +337,12 @@ Specifies the path to the config file relative to the project root. Defaults to
astro --config config/astro.config.mjs dev
```

### `--outDir <path>`

<Since v="3.3.0" />

Configures the [`outDir`](/en/reference/configuration-reference/#outdir) for your project. Passing this flag will override the `outDir` value in your `astro.config.mjs` file, if one exists.

### `--site <url>`

Configures the [`site`](/en/reference/configuration-reference/#site) for your project. Passing this flag will override the `site` value in your `astro.config.mjs` file, if one exists.
Expand Down