Skip to content

Update CLI command reference #4891

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
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update CLI command reference #4891

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 8 additions & 2 deletions installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@
```

<Note>
Only HTTPS URLs are supported in production deployments. The `--local-schema` flag is for local development only.

Check warning on line 248 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L248 

In general, use active voice instead of passive voice ('are supported').
</Note>

### Create a workflow
Expand All @@ -266,6 +266,12 @@
mint rename <path/to/old-filename> <path/to/new-filename>
```

Use `--force` to rename files and skip errors:

```bash
mint rename <path/to/old-filename> <path/to/new-filename> --force
```

### Migrate MDX endpoint pages

Migrate MDX endpoint pages to autogenerated pages from your OpenAPI specification with the following command:
Expand Down Expand Up @@ -293,13 +299,13 @@
**Import an entire site:**

```bash
mint scrape site <url>
mint scrape <url>
```

Use the `--filter` (or `-f`) flag to limit scraping to URLs matching a specific path prefix:

```bash
mint scrape site <url> --filter=<path>
mint scrape <url> --filter=<path>
```

**Import a single page:**
Expand Down
Loading