diff --git a/installation.mdx b/installation.mdx index 68eca503e..901ed8067 100644 --- a/installation.mdx +++ b/installation.mdx @@ -109,6 +109,19 @@ If you attempt to run on a port that is already in use, the CLI uses the next av Port 3000 is already in use. Trying 3001 instead. ``` +### Search in local preview + +By default, search is disabled during local preview. To enable search, log in to +the CLI first: + +```bash +mint login +mint dev +``` + +When you are logged in, the local preview connects to your project's search index, +so you can test search behavior as you write. + ## Skip OpenAPI processing If you have many OpenAPI files, skip OpenAPI file processing during local development to improve performance by using the `--disable-openapi` flag: @@ -177,6 +190,39 @@ If this `mint update` command is not available on your local version, re-install ``` +## Authentication + +Log in to your Mintlify account from the CLI to enable features that require +a connection to your project, such as [search in local preview](#search-in-local-preview). + +### Log in + +Authenticate with your Mintlify account: + +```bash +mint login +``` + +A browser window opens for you to complete the authentication flow. After you log in, +your credentials are stored locally so you stay authenticated across sessions. + +### Check authentication status + +View your current authentication status, including the email and organization associated +with your account: + +```bash +mint status +``` + +### Log out + +Remove your stored credentials: + +```bash +mint logout +``` + ## Additional commands ### Find broken links