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

# Installation

> Install kipmox and start fixing Salesforce deployment errors in minutes.

## Requirements

Before installing, make sure you have:

* **VS Code** 1.85 or later
* **Salesforce CLI** (`sf`) installed and authenticated
* An active Salesforce org connection in VS Code
* **For full code analysis (recommended):** the Salesforce Code Analyzer plugin and **Java 11+** — see [Code Analysis → set up the Code Analyzer](/workflows/code-analysis#set-up-the-salesforce-code-analyzer). Without them, kipmox uses its built-in rules and flags fewer issues.

<Tip>
  To check your Salesforce CLI version, run `sf --version` in your terminal. To install it, visit [developer.salesforce.com/tools/salesforcecli](https://developer.salesforce.com/tools/salesforcecli).
</Tip>

## Install kipmox

### From the VS Code Marketplace

1. Open VS Code
2. Press `Cmd+Shift+X` (Mac) or `Ctrl+Shift+X` (Windows) to open the Extensions panel
3. Search for **kipmox**
4. Click **Install**

<Frame>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/moxycode/images/installation-marketplace.png" alt="kipmox in the VS Code Marketplace" />
</Frame>

### From the terminal

```bash theme={null}
code --install-extension kipmox.kipmox
```

## Start using kipmox

No sign-in required to get started. Once installed, kipmox is ready immediately — open any Apex, trigger, or LWC file and run your first **deployment fix**, run **code analysis**, or use **kipmox: Explain this code** to **generate a document**.

Your **first 2 requests are free with no account**. From the **3rd request**, kipmox asks you to sign in with a magic link — no password needed. That's still the **Free plan** (15 fixes and 2 documents every 4 hours); an account just lets you keep going.

<Frame>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/moxycode/images/installation-welcome.png" alt="kipmox panel after installation" />
</Frame>

## Sign in

From your 3rd request, kipmox prompts you to sign in. You can sign in **from VS Code or from the website** — either works, and your plan syncs across both.

**From VS Code (magic link)**

1. Enter your email in the sign-in prompt and click **Send Magic Link**
2. Open the email from kipmox and click the link — VS Code signs you in automatically
3. Re-run your original request to continue

**From the website**

1. Sign in at [kipmox.com](https://kipmox.com) with your email
2. Open VS Code from your account page to connect your session

<Tip>
  If you just signed in or upgraded on the website, run **kipmox: Refresh Account** in VS Code to sync it immediately.
</Tip>

<Frame>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/moxycode/images/installation-signin.png" alt="kipmox sign-in prompt" />
</Frame>

<Note>
  Once signed in, kipmox stays signed in. You will not be asked to sign in again.
</Note>

<Tip>
  To view your account details, visit [kipmox.com](https://kipmox.com) and sign in with the same email address.
</Tip>

<Note>
  The magic link expires after 15 minutes. If it expires, return to VS Code and request a new one.
</Note>

<Frame>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/moxycode/images/installation-verified.png" alt="kipmox signed in state" />
</Frame>

## Connect your Salesforce org

kipmox uses your active Salesforce CLI default org. To set one:

1. Look at the bottom status bar in VS Code
2. Click the org name (or **No Default Org Set**)
3. Select **Authorize an Org** if you haven't connected one yet, or choose from your existing orgs
4. Once set, the org name appears in the status bar — kipmox will deploy to that org

<Frame>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/moxycode/images/installation-org-picker.png" alt="Salesforce org picker in VS Code status bar" />
</Frame>

<Note>
  Make sure the correct org is active before deploying — kipmox always deploys to your current default org.
</Note>

## Common issues

<AccordionGroup>
  <Accordion title="Can't find kipmox in the Marketplace">
    In VS Code, open the Extensions panel (`Cmd+Shift+X` / `Ctrl+Shift+X`) and search for **kipmox**. Make sure you're online. If it still doesn't appear, install it another way: run the terminal command above (`code --install-extension …`), or open the listing on the [VS Code Marketplace](https://marketplace.visualstudio.com/) in your browser and click **Install** — it opens VS Code and installs.
  </Accordion>

  <Accordion title="Extension won't install or activate">
    1. Confirm you're on **VS Code 1.85 or later** (Code → About Visual Studio Code).
    2. After installing, run **Developer: Reload Window** from the Command Palette.
    3. Open a supported file (`.cls`, `.trigger`, `.js`, `.html`) — kipmox activates on the first supported file you open.
    4. Behind a corporate proxy or firewall, Go to VS Code Settings, search for http.proxy, and enter your company's proxy URL to allow the extension to install automatically from the Marketplace..
  </Accordion>

  <Accordion title="kipmox icon not appearing in the Activity Bar">
    The extension may not have activated yet. Try opening any `.cls`, `.trigger`, `.js`, or `.html` file — kipmox activates when a supported file type is opened. If the icon still doesn't appear, save the file once to trigger activation. If it's still missing, run **Developer: Reload Window** from the Command Palette.
  </Accordion>

  <Accordion title="Magic link email not arriving">
    Check your spam or junk folder. The email is sent from `auth@kipmox.com`. If it's not there after a few minutes, return to VS Code and click **Send Magic Link** again.
  </Accordion>

  <Accordion title="Magic link opened the website instead of VS Code">
    This can happen if VS Code is not set as the default handler for `vscode://` links on your machine. Make sure VS Code is open before clicking the link, then try again.
  </Accordion>

  <Accordion title="Sign-in prompt not appearing after 2 requests">
    If the sign-in prompt doesn't appear, reload VS Code with **Developer: Reload Window** from the Command Palette and try your action again.
  </Accordion>

  <Accordion title="Salesforce CLI not found">
    kipmox requires the Salesforce CLI to be installed and available in your terminal PATH. Run `sf --version` to verify. If it's not installed, download it from [developer.salesforce.com/tools/salesforcecli](https://developer.salesforce.com/tools/salesforcecli).
  </Accordion>

  <Accordion title="Which files does kipmox work on?">
    kipmox activates on Salesforce source files: **Apex** classes and triggers (`.cls`, `.trigger`) and **Lightning Web Components** (`.js`, `.html`). Open one of these to bring kipmox to life — it stays dormant for other file types.
  </Accordion>

  <Accordion title="kipmox is deploying to the wrong org">
    kipmox always deploys to your **current default org**. Check the org name in the VS Code status bar (bottom-left) and switch it before deploying — see [Connect your Salesforce org](#connect-your-salesforce-org) above.
  </Accordion>

  <Accordion title="How do I update kipmox?">
    VS Code updates extensions automatically. To update now, open the Extensions panel (`Cmd+Shift+X` / `Ctrl+Shift+X`), find kipmox, click **Update** if one is offered, then run **Developer: Reload Window**.
  </Accordion>

  <Accordion title="Do I have to pay to install?">
    No — kipmox is free to install and use. You get **2 requests with no account**, then the Free plan (15 fixes and 2 documents every 4 hours) after signing in. [Pro and Enterprise](/help/plans-and-limits) are optional upgrades.
  </Accordion>
</AccordionGroup>

<Card title="Next — fix your first deployment error" icon="bolt" href="/getting-started/quick-start">
  See kipmox in action in under 2 minutes
</Card>