Skip to content
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

Jump to bottom

Update CLI Reference with --site & --base flags #1646

Merged
merged 5 commits into from
Oct 13, 2022
Merged

Update CLI Reference with --site & --base flags #1646

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
22a785f
Update cli-reference.md
natemoo-re Sep 29, 2022
e7ad558
Add since label to `--base`
natemoo-re Sep 29, 2022
5696c3d
Merge branch 'main' into feat/update-cli-refs
sarah11918 Oct 12, 2022
4e16552
Merge branch 'main' into feat/update-cli-refs
sarah11918 Oct 13, 2022
78a7395
Merge branch 'main' into feat/update-cli-refs
sarah11918 Oct 13, 2022
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
11 changes: 11 additions & 0 deletions src/pages/en/reference/cli-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ layout: ~/layouts/MainLayout.astro
title: CLI Reference
i18nReady: true
setup: |
import Since from '~/components/Since.astro';
import PackageManagerTabs from '~/components/tabs/PackageManagerTabs.astro'
---

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

### `--site`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do these need to indicate the arguments they get passed like we do for --root and --config?

Suggested change
### `--site`
### `--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.

### `--base`
Copy link
Member

@delucis delucis Sep 30, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### `--base`
### `--base <pathname>`


<Since v="1.4.1" />

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

### `--verbose`

Enables verbose logging, which is helpful when debugging an issue.
Expand Down