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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add nuxi init missing options #27051

Merged
merged 5 commits into from
May 7, 2024
Merged

docs: add nuxi init missing options #27051

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
599bb05
docs: add nuxi init missing options
angelhdzmultimedia May 3, 2024
cd4d514
Merge branch 'main' of https://github.com/nuxt/nuxt
angelhdzmultimedia May 3, 2024
f2def55
chore: use kebab case cli options
danielroe May 7, 2024
ed41592
chore: preserve previous wording about offline mode
danielroe May 7, 2024
90e5aa6
chore: add experimental label to `--shell`
danielroe May 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 10 additions & 4 deletions docs/3.api/4.commands/init.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,17 @@ The `init` command initializes a fresh Nuxt project using [unjs/giget](https://g

Option | Default | Description
-------------------------|-----------------|------------------
`--cwd` | | Current working directory
`--log-level` | | Log level
`--template, -t` | `v3` | Specify template name or git repository to use as a template. Format is `gh:org/name` to use a custom github template.
`--force` | `false` | Force clone to any existing directory.
`--offline` | `false` | Do not attempt to download from github and only use local cache.
`--prefer-offline` | `false` | Try local cache first to download templates.
`--shell` | `false` | Open shell in cloned directory (experimental).
`--force, -f` | `false` | Force clone to any existing directory.
`--offline` | `false` | Force offline mode.
danielroe marked this conversation as resolved.
Show resolved Hide resolved
`--prefer-offline` | `false` | Prefer offline mode.
danielroe marked this conversation as resolved.
Show resolved Hide resolved
`--no-install` | `false` | Skip installing dependencies.
`--git-init` | `false` | Initialize git repository.
`--shell` | `false` | Start shell after installation in project directory.
danielroe marked this conversation as resolved.
Show resolved Hide resolved
`--package-manager` | `npm` | Package manager choice (npm, pnpm, yarn, bun).
`--dir` | | Project directory.

## Environment variables

Expand Down