Document new CLI flags for mint new command #2710
Merged
+11
−8
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
ethanpalm
approved these changes
Jan 16, 2026
![tembo[bot]](https://avatars.githubusercontent.com/in/1223475?s=60&v=4){kind=small}
| * `--theme`: Set the theme of the new project. | ||
| * `--name`: Set the name of the new project. | ||
| * `--force`: Overwrite the current directory if it already exists. | ||
| | Flag | Description | Required | |
Contributor
There was a problem hiding this comment.
The table reads like --name/--theme are always required, but the section above says the CLI prompts for these interactively. Clarifying the column header would avoid that mismatch.
Suggested change
| | Flag | Description | Required | | |
| | Flag | Description | Required in non-interactive | |
| | `--force` | Overwrite the current directory without prompting, even if it contains existing files. | No | | ||
|
|
||
| For example, to create a new project in the `docs` directory with the name `my-project` and the theme `linden`, run the following command: | ||
| When running `mint new` in non-interactive environments like CI/CD pipelines or with AI coding agents, you must provide all required flags (`--name` and `--theme`). |
Contributor
There was a problem hiding this comment.
Since this section targets CI/CD and agents, a copy/paste example is still really helpful (and shows quoting when the name has spaces).
Suggested change
| When running `mint new` in non-interactive environments like CI/CD pipelines or with AI coding agents, you must provide all required flags (`--name` and `--theme`). | |
| When running `mint new` in non-interactive environments like CI/CD pipelines or with AI coding agents, you must provide `--name` and `--theme` to skip the interactive prompts. | |
| ```bash | |
| mint new docs --name "My Project" --theme linden |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Enhanced the installation documentation to better document the new --theme, --name, and --force flags for the mint new command. Added examples for non-interactive/programmatic usage in CI/CD pipelines and with AI coding agents.
Created by Mintlify agent
Note
Updates installation docs for
mint new:--name,--theme, and--force(with required status)--nameand--theme, with a tip on auto-detection and usage outputWritten by Cursor Bugbot for commit 9c43c02. This will update automatically on new commits. Configure here.