/* **Prerequisite** You should have installed Node.js (version 18.10.0 or higher). Step 1. Install Mintlify on your OS: ```bash npm npm i -g mintlify ``` ```bash yarn yarn global add mintlify ``` Step 2. Go to the docs are located (where you can find `mint.json`) and run the following command: ```bash mintlify dev ``` The documentation website is now available at `http://localhost:3000`. ### Custom Ports Mintlify uses port 3000 by default. You can use the `--port` flag to customize the port Mintlify runs on. For example, use this command to run in port 3333: ```bash mintlify dev --port 3333 ``` You will see an error like this if you try to run Mintlify in a port that's already taken: ```md Error: listen EADDRINUSE: address already in use :::3000 ``` ## Mintlify Versions Each CLI is linked to a specific version of Mintlify. Please update the CLI if your local website looks different than production. ```bash npm npm i -g mintlify@latest ``` ```bash yarn yarn global upgrade mintlify ``` ## Deployment Unlimited editors available under the [Startup Plan](https://mintlify.com/pricing) You should see the following if the deploy successfully went through:

## Troubleshooting Here's how to solve some common problems when working with the CLI. Update to Node v18. Run `mintlify install` and try again. Go to the `C:/Users/Username/.mintlify/` directory and remove the `mint` folder. Then Open the Git Bash in this location and run `git clone https://github.com/mintlify/mint.git`. Repeat step 3. Try navigating to the root of your device and delete the ~/.mintlify folder. Then run `mintlify dev` again. Curious about what changed in a CLI version? [Check out the CLI changelog.](/changelog/command-line) */ "use strict"; const {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0]; const {useMDXComponents: _provideComponents} = arguments[0]; function _createMdxContent(props) { const _components = { a: "a", code: "code", li: "li", ol: "ol", p: "p", pre: "pre", span: "span", ..._provideComponents(), ...props.components }, {CodeBlock} = _components; if (!CodeBlock) _missingMdxReference("CodeBlock", true); return _jsxs(_Fragment, { children: [_jsxs(_components.ol, { children: ["\n", _jsxs(_components.li, { children: ["Clone the ", _jsx(_components.a, { href: "https://github.com/Eigen-DB/eigen-db", children: "repo" }), " from GitHub:"] }), "\n"] }), "\n", _jsx(CodeBlock, { numberOfLines: "1", language: "shellscript", children: _jsx(_components.pre, { className: "shiki shiki-themes github-light-default dark-plus", style: { backgroundColor: "transparent", "--shiki-dark-bg": "transparent", color: "#1f2328", "--shiki-dark": "#f3f7f6" }, language: "shellscript", children: _jsxs(_components.code, { language: "shellscript", numberOfLines: "1", children: [_jsxs(_components.span, { className: "line", children: [_jsx(_components.span, { style: { color: "#953800", "--shiki-dark": "#DCDCAA" }, children: "git" }), _jsx(_components.span, { style: { color: "#0A3069", "--shiki-dark": "#CE9178" }, children: " clone" }), _jsx(_components.span, { style: { color: "#0A3069", "--shiki-dark": "#CE9178" }, children: " https://github.com/Eigen-DB/eigen-db" })] }), "\n"] }) }) }), "\n", _jsxs(_components.ol, { start: "2", children: ["\n", _jsx(_components.li, { children: "Inside the repo, build and run EigenDB:" }), "\n"] }), "\n", _jsx(CodeBlock, { numberOfLines: "1", language: "shellscript", children: _jsx(_components.pre, { className: "shiki shiki-themes github-light-default dark-plus", style: { backgroundColor: "transparent", "--shiki-dark-bg": "transparent", color: "#1f2328", "--shiki-dark": "#f3f7f6" }, language: "shellscript", children: _jsxs(_components.code, { language: "shellscript", numberOfLines: "1", children: [_jsxs(_components.span, { className: "line", children: [_jsx(_components.span, { style: { color: "#953800", "--shiki-dark": "#DCDCAA" }, children: "docker-compose" }), _jsx(_components.span, { style: { color: "#0A3069", "--shiki-dark": "#CE9178" }, children: " up" }), _jsx(_components.span, { style: { color: "#0550AE", "--shiki-dark": "#9cdcfe" }, children: " --build" })] }), "\n"] }) }) }), "\n", _jsxs(_components.p, { children: ["Your EigenDB instance should now be running on port ", _jsx(_components.code, { children: ":8080" }), "."] }), "\n"] }); } function MDXContent(props = {}) { const {wrapper: MDXLayout} = { ..._provideComponents(), ...props.components }; return MDXLayout ? _jsx(MDXLayout, { ...props, children: _jsx(_createMdxContent, { ...props }) }) : _createMdxContent(props); } return { default: MDXContent }; function _missingMdxReference(id, component) { throw new Error("Expected " + (component ? "component" : "object") + " `" + id + "` to be defined: you likely forgot to import, pass, or provide it."); }

Get Started