> ## Documentation Index
> Fetch the complete documentation index at: https://docs.memvid.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Install the CLI

> Install the Memvid CLI globally via npm

Install Memvid CLI and start building AI memory in seconds. No complex setup required.

***

## Install

<Tabs>
  <Tab title="Auto Installer (Recommended)">
    The installer automatically checks for and installs required dependencies (git, node, npm), then installs Memvid globally.

    **macOS / Linux:**

    ```bash theme={null}
    curl -fsSL https://raw.githubusercontent.com/memvid/preflight-installer/main/install.sh | bash
    ```

    **Windows (PowerShell):**

    ```powershell theme={null}
    irm https://raw.githubusercontent.com/memvid/preflight-installer/main/install.ps1 | iex
    ```

    <Note>
      The installer only installs missing tools and asks for confirmation before proceeding.
      [View source on GitHub](https://github.com/memvid/preflight-installer)
    </Note>
  </Tab>

  <Tab title="npm">
    ```bash theme={null}
    npm install -g memvid-cli
    ```
  </Tab>
</Tabs>

Verify installation:

```bash theme={null}
memvid --version
```

That's it. You're ready to go.

***

## Quick Start

```bash theme={null}
# Create your first memory
memvid create my-memory.mv2

# Add some documents
memvid put my-memory.mv2 --input ./documents/

# Search immediately
memvid find my-memory.mv2 --query "your search term"

# Ask questions
memvid ask my-memory.mv2 --question "What is this about?"
```

***

## Without Installing

Run without global installation:

```bash theme={null}
npx memvid-cli --help
npx memvid-cli create test.mv2
```

***

## Environment Variables

Optional configuration:

| Variable            | Description                |
| ------------------- | -------------------------- |
| `MEMVID_API_KEY`    | Dashboard API key for sync |
| `OPENAI_API_KEY`    | OpenAI for LLM synthesis   |
| `GROQ_API_KEY`      | Groq for fast synthesis    |
| `ANTHROPIC_API_KEY` | Claude for synthesis       |

<Note>
  **No API keys required** to get started. Memvid works offline with local search and the built-in TinyLlama model.
</Note>

***

## Updating

```bash theme={null}
npm update -g memvid-cli
```

***

## Troubleshooting

<AccordionGroup>
  <Accordion title="Command Not Found">
    Make sure npm global bin is in your PATH:

    ```bash theme={null}
    # Check npm global bin location
    npm root -g

    # Add to PATH if needed
    export PATH="$PATH:$(npm root -g)/../bin"
    ```
  </Accordion>

  <Accordion title="Permission Denied (macOS)">
    If macOS blocks the binary:

    1. Go to **System Settings > Privacy & Security**
    2. Click **"Allow Anyway"** next to the blocked app
  </Accordion>
</AccordionGroup>

***

## System Requirements

| Platform | Requirement                    |
| -------- | ------------------------------ |
| Node.js  | 14+                            |
| macOS    | 11+ (ARM64 or x86\_64)         |
| Linux    | glibc 2.17+ (x86\_64 or ARM64) |
| Windows  | 10+ (x86\_64)                  |

The npm package automatically downloads the correct native binary for your platform.

***

## Next Steps

<CardGroup cols={2}>
  <Card title="5-Minute Quickstart" icon="rocket" href="/quickstart/five-minute-guide">
    Build your first memory
  </Card>

  <Card title="The Memvid Approach" icon="lightbulb" href="/introduction/the-memvid-approach">
    Why Memvid doesn't need embeddings
  </Card>
</CardGroup>