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

# One-Click Install

> Install Nometria in your AI coding tool with one click. No terminal required.

Pick your tool and click install. No terminal or coding experience needed.

## Cursor

<Steps>
  <Step title="Install the MCP server">
    Click this link to install Nometria in Cursor with one click:

    <Card title="Install in Cursor" icon="arrow-pointer" href="cursor://anysphere.cursor-deeplink/mcp/install?name=nometria&config=eyJtY3BTZXJ2ZXJzIjp7Im5vbWV0cmlhIjp7ImNvbW1hbmQiOiJucHgiLCJhcmdzIjpbIi15IiwiQG5vbWV0cmlhLWFpL2NsYXVkZS1jb2RlIl0sImVudiI6e319fX0%3D">
      Click to auto-configure Nometria in Cursor. No terminal needed.
    </Card>

    Cursor will open a dialog asking you to confirm the MCP server installation. Click **Install**.
  </Step>

  <Step title="Get your API key">
    Go to [nometria.com/settings/api-keys](https://nometria.com/settings/api-keys), sign in, and copy your API key.
  </Step>

  <Step title="Tell Cursor your key">
    In Cursor chat, type:

    ```
    Set my NOMETRIA_API_KEY to nometria_sk_your_key_here
    ```

    Or add it to your project's `.env` file:

    ```
    NOMETRIA_API_KEY=nometria_sk_your_key_here
    ```
  </Step>

  <Step title="Deploy">
    In Cursor chat, just say:

    ```
    Deploy my app to production
    ```

    Cursor will use the Nometria MCP server to handle everything automatically.
  </Step>
</Steps>

***

## Claude Code

<Tabs>
  <Tab title="Plugin (recommended)">
    <Steps>
      <Step title="Add the Nometria marketplace">
        In Claude Code, type:

        ```
        /plugin marketplace add nometria/claude-code-plugin
        ```
      </Step>

      <Step title="Install the plugin">
        ```
        /plugin install nometria
        ```

        This installs the MCP server (20 deployment tools) and all slash commands (`/deploy`, `/preview`, `/status`, `/nometria-login`) in one step.
      </Step>

      <Step title="Deploy">
        Type `/deploy` or just say "deploy my app". Done.
      </Step>
    </Steps>
  </Tab>

  <Tab title="MCP server only">
    <Steps>
      <Step title="Install the MCP server">
        Open Claude Code and paste this command:

        ```bash theme={null}
        claude mcp add nometria -- npx -y @nometria-ai/claude-code
        ```

        <Tip>
          If you're already in a Claude Code session, you can type this directly in the chat. Claude will run it for you.
        </Tip>
      </Step>

      <Step title="Add slash commands to your project">
        In your project directory, run:

        ```bash theme={null}
        npx @nometria-ai/nom setup
        ```

        This adds `/deploy`, `/preview`, `/status`, and `/nometria-login` commands to your project.
      </Step>

      <Step title="Deploy">
        In Claude Code, type any of these:

        ```
        /deploy                    # Deploy to production
        /preview                   # Free staging preview
        /status                    # Check deployment status
        ```

        Or just say "deploy my app" in natural language.
      </Step>
    </Steps>
  </Tab>
</Tabs>

***

## VS Code

<Steps>
  <Step title="Install the extension">
    <Card title="Install from Marketplace" icon="arrow-pointer" href="https://marketplace.visualstudio.com/items?itemName=nometria.nometria">
      Click to open the VS Code Marketplace page. Then click **Install**.
    </Card>

    Or search for **"Nometria"** in the VS Code Extensions panel (`Cmd+Shift+X`).
  </Step>

  <Step title="Sign in">
    Click the **Nometria icon** in the left sidebar, then click **Sign In**. This opens your browser — sign in with Google, GitHub, or email.
  </Step>

  <Step title="Deploy">
    Press `Cmd+Shift+D` (Mac) or `Ctrl+Shift+D` (Windows) to deploy. That's it.

    Or right-click any app in the sidebar for more options: preview, start/stop, upgrade, scan, etc.
  </Step>
</Steps>

***

## ChatGPT / Custom GPTs

If you use ChatGPT or a custom GPT, you can deploy using curl commands. Share this with your GPT:

```
Read the AGENTS.md file in the project root for deployment instructions.
```

To add AGENTS.md to your project:

```bash theme={null}
npx @nometria-ai/nom setup
```

This creates an `AGENTS.md` file with the full API reference that any AI agent can read and use.

***

## Any other AI tool

Every AI coding tool can deploy via Nometria. Run this once in your project:

```bash theme={null}
npx @nometria-ai/nom setup
```

This generates config files for:

| Tool                 | File created                            |
| -------------------- | --------------------------------------- |
| **Cursor**           | `.cursor/rules/nometria.mdc`            |
| **Claude Code**      | `CLAUDE.md` + `.claude/commands/`       |
| **GitHub Copilot**   | `.github/copilot-instructions.md`       |
| **Cline / Roo Code** | `.clinerules`                           |
| **Windsurf**         | `.windsurfrules`                        |
| **Continue.dev**     | `.continue/config.json`                 |
| **Any agent**        | `AGENTS.md`                             |
| **CI/CD**            | `.github/workflows/nometria-deploy.yml` |

After running setup, your AI tool automatically knows how to deploy your project.

***

## Quick comparison

| Method                | Install effort | Best for                                       |
| --------------------- | -------------- | ---------------------------------------------- |
| **Cursor deep link**  | One click      | Cursor users who want zero setup               |
| **VS Code extension** | One click      | VS Code / Cursor users who prefer a sidebar UI |
| **Claude Code MCP**   | One command    | Claude Code users                              |
| **`nom setup`**       | One command    | Teams who want every tool configured at once   |
| **AGENTS.md**         | Automatic      | Custom GPTs, Aider, or any AI that reads files |