> ## 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.

# Quick Start

> Fix a warning, fix a deployment error, and document your code — a few clicks each.

kipmox works right inside your normal Salesforce workflow. Here are the three things you'll do most — each in a few clicks. For the full details, follow the links to the workflow guides.

## 1. Fix a warning

As you open and save Apex, triggers, and LWC, kipmox flags issues inline — SOQL in loops, DML in loops, security gaps, and more.

<Steps>
  <Step title="Spot a flagged line">
    The issue is highlighted in your code, with a **kipmox: 💡 Explain & Fix** action above the line.
  </Step>

  <Step title="Explain & Fix">
    Click it. kipmox explains the issue and generates a fix with a **Confidence** rating, a **Risk** note, and a **What Changed** summary.
  </Step>

  <Step title="Apply the fix">
    On **Pro**, click **Apply Fix** to apply and save the change automatically (undo anytime with `Cmd+Z` / `Ctrl+Z`). On **Free**, the fixed code is shown in the panel — copy it and paste it into your file.
  </Step>
</Steps>

<Frame>
  <img src="https://mintcdn.com/moxycode/h8Qb-_2xOx_QG1GA/images/quick-start-warning.png?fit=max&auto=format&n=h8Qb-_2xOx_QG1GA&q=85&s=e369f6f4c9f9be1c066d242b75dcd904" alt="Explain & Fix on a flagged line" width="2626" height="1808" data-path="images/quick-start-warning.png" />
</Frame>

<Card title="Full guide — Code Analysis" icon="magnifying-glass" href="/workflows/code-analysis">
  Warnings, Fix All, and custom rules
</Card>

## 2. Fix a deployment error

Deploy from VS Code — when it fails, kipmox catches every error and helps you fix it.

<Steps>
  <Step title="Deploy to Org">
    Right-click a file (or use the Command Palette) and choose **kipmox: Deploy to Org**.
  </Step>

  <Step title="Review the errors">
    If the deploy fails, the **Deploy Errors** panel opens with every error listed. Click **Explain** on any error for a plain-English analysis and a fix.
  </Step>

  <Step title="Fix and re-deploy">
    On **Free**, copy each error's fix from **Explain** into your file. On **Pro**, click **Analyze & Generate Fixes** to fix them all, then **Apply Fix**. Run **kipmox: Deploy to Org** again — repeat until it's clean (some errors are layered).
  </Step>
</Steps>

<Frame>
  <img src="https://mintcdn.com/moxycode/h8Qb-_2xOx_QG1GA/images/quick-start-deploy.png?fit=max&auto=format&n=h8Qb-_2xOx_QG1GA&q=85&s=b33e4075a0e3af09feaad79399bfe129" alt="kipmox Deploy Errors panel" width="3012" height="1822" data-path="images/quick-start-deploy.png" />
</Frame>

<Note>
  In the Deploy Errors panel, **Explain** (understand + copy a fix) is on every plan. **Analyze & Generate Fixes** (fix them all) and one-click **Apply Fix** are Pro.
</Note>

<Card title="Full guide — Deploy & Fix Errors" icon="cloud-arrow-up" href="/workflows/deploy-to-org">
  Deploying, plus the fix engine end to end
</Card>

## 3. Generate documentation

Turn any file into a clear technical document — straight from your source.

<Steps>
  <Step title="Open a file">
    Open any Apex class, trigger, or LWC.
  </Step>

  <Step title="Explain this code">
    Use the Command Palette and choose **kipmox: Explain this code**.
  </Step>

  <Step title="Read the document">
    A document opens beside your editor — overview, key methods, and dependencies.
  </Step>
</Steps>

<Frame>
  <img src="https://mintcdn.com/moxycode/h8Qb-_2xOx_QG1GA/images/quick-start-docs.png?fit=max&auto=format&n=h8Qb-_2xOx_QG1GA&q=85&s=c658b23124c8a904810ae4cdfeb924c9" alt="A generated kipmox document" width="1456" height="1012" data-path="images/quick-start-docs.png" />
</Frame>

<Card title="Full guide — Generate Documentation" icon="file-lines" href="/workflows/generate-documentation">
  What's in a document, and online vs offline
</Card>

## Online or offline

All three of the above — fixes, analysis, and documentation — work two ways. Switch anytime with **kipmox: Toggle Online / Offline Mode**:

* **Online** — kipmox's cloud AI. Fast, nothing to set up (the default).
* **Offline** (Pro) — a local model on your own machine, so your code never leaves your computer. See [Offline Mode](/configuration/offline-mode) to set it up.

## Common questions

<AccordionGroup>
  <Accordion title="Do I need to sign in?">
    Your first 2 requests are free with no account. From the 3rd request, kipmox prompts you to sign in with a magic link — or sign in at [kipmox.com](https://kipmox.com). Full steps in [Installation → Sign in](/getting-started/installation#sign-in).
  </Accordion>

  <Accordion title="Hit the Free-plan limit">
    The Free plan includes **15 deployment-error fixes and 2 code documents every 4 hours**; each resets 4 hours after you reach it. Static analysis, viewing warnings, and deploying don't count. Upgrade to Pro to remove the limits — see [Plans & Limits](/help/plans-and-limits).
  </Accordion>

  <Accordion title="Analyze & Generate Fixes shows Upgrade to Pro">
    Bulk **Analyze & Generate Fixes** — fixing every deployment error at once — is a Pro feature. On the Free plan, use **Explain** on each error and copy the fixed code into your file. One-click **Apply Fix** is also Pro.
  </Accordion>

  <Accordion title="Deploy Errors panel didn't open after a failed deploy">
    The panel opens when kipmox detects errors in the Salesforce CLI output. Make sure you used **kipmox: Deploy to Org** — kipmox only monitors its own deploys, not the standard CLI command.
  </Accordion>

  <Accordion title="Fix applied but the deploy still fails">
    Some errors are layered — fixing one can reveal another underneath. Run **kipmox: Deploy to Org** again and repeat the cycle until it's clean.
  </Accordion>
</AccordionGroup>

<CardGroup cols={2}>
  <Card title="How Fixes Are Verified" icon="circle-check" href="/trust/how-fixes-are-verified">
    The checks behind every fix
  </Card>

  <Card title="Plans & Limits" icon="credit-card" href="/help/plans-and-limits">
    Free, Pro, and Enterprise
  </Card>
</CardGroup>
