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

# Quick Start Tutorial

> Learn Gobi's core features through hands-on exercises. Get started with Autocomplete, Edit, Chat, and Agent mode in minutes.

Welcome to Gobi! This interactive tutorial will guide you through all four core features using practical examples. Follow along step-by-step to learn more about Gobi's capabilities.

<Info>
  **Prerequisites**: Make sure you have [installed
  Gobi](/ide-extensions/install) and [signed
  in](https://auth.gourmand.dev/) to get started.
</Info>

***

## 🔄 Autocomplete

**What it does**: Provides intelligent inline code suggestions as you type, powered by AI.

<Steps>
  <Step title="Create a Test File">
    Create a new file called `tutorial.js` (or use any language you prefer) in your IDE
  </Step>

  <Step title="Try Autocomplete">
    Copy this starter code and place your cursor at the end of the comment:

    ```javascript theme={null}
    // TODO: Implement a sorting algorithm function
    function sortingAlgorithm(arr) {
      // Place cursor here and press Enter
    }
    ```

    Press **Enter** and watch Gobi suggest code completions. Press **Tab** to accept suggestions.
  </Step>

  <Step title="See the Magic">
    Gobi will intelligently suggest function implementations based on the context and comment.
  </Step>
</Steps>

<Tip>
  Autocomplete works best when you provide clear function names, comments, or
  type annotations that give context about your intent.
</Tip>

***

<img src="https://mintcdn.com/gourmand/cY6wRTl5s2wbpiM-/images/autocomplete-quick-start.gif?s=f5c5315e0972785a68fc364cd29fabf2" alt="autocomplete-demo" width="924" height="720" data-path="images/autocomplete-quick-start.gif" />

## ✏️ Edit

**What it does**: Make quick, targeted changes to specific code sections using natural language instructions.

<Steps>
  <Step title="Add Sample Code">
    Paste this bubble sort implementation in your file:

    ```javascript theme={null}
    function sortingAlgorithm(x) {
      for (let i = 0; i < x.length; i++) {
        for (let j = 0; j < x.length - 1; j++) {
          if (x[j] > x[j + 1]) {
            let temp = x[j];
            x[j] = x[j + 1];
            x[j + 1] = temp;
          }
        }
      }
      return x;
    }
    ```
  </Step>

  <Step title="Highlight the Function">
    **Highlight** the entire function in your editor
  </Step>

  <Step title="Open Edit Mode">Press **Cmd/Ctrl + I** to open Edit mode</Step>

  <Step title="Give Instructions">
    Type: `"make this more readable and add TypeScript types"`
  </Step>

  <Step title="Watch the Magic">
    Watch Gobi refactor your code automatically!
  </Step>

  <Step title="Review Changes">
    Gobi will show you a diff of the proposed changes. Accept or reject individual changes as needed.
  </Step>
</Steps>

<Note>
  Edit is perfect for refactoring, adding documentation, fixing bugs, or
  converting between languages/frameworks.
</Note>

<img src="https://mintcdn.com/gourmand/kkqYf7UwBaqLLOdV/images/edit-quick-start.gif?s=cc0040cbe42dc2b3ce8765a910e2624b" alt="edit-demo" width="980" height="720" data-path="images/edit-quick-start.gif" />

## 💬 Chat Mode

**What it does**: Interactive AI assistant that can analyze code, answer questions, and provide guidance without leaving your IDE.

<Steps>
  <Step title="Add Another Function">
    Add this second sorting function to your file:

    ```javascript theme={null}
    function sortingAlgorithm2(x) {
      for (let i = 0; i < x.length; i++) {
        for (let j = 0; j < x.length - 1; j++) {
          if (x[j] > x[j + 1]) {
            let temp = x[j];
            x[j] = x[j + 1];
            x[j + 1] = temp;
          }
        }
      }
      return x;
    }
    ```
  </Step>

  <Step title="Start a Conversation">
    1. **Highlight** the function
    2. Use the keyboard shortcuts below to add it to Chat.
    3. Ask: `"What sorting algorithm is this and how can I optimize it?"`
  </Step>

  <Step title="Explore Further">
    Try these follow-up questions:

    * `"Show me how to implement quicksort instead"`
    * `"What's the time complexity of this algorithm?"`
    * `"Can you write unit tests for this function?"`
  </Step>
</Steps>

### Chat Mode Keyboard Shortcuts

<Tabs>
  <Tab title="VS Code">
    **Cmd/Ctrl + L**\
    New Chat / New Chat With Selected Code / Close Gobi Sidebar If Chat Already In Focus

    **Cmd/Ctrl + Shift + L**\
    Focus Current Chat / Add Selected Code To Current Chat / Close Gobi Sidebar If Chat Already In Focus
  </Tab>

  <Tab title="JetBrains IDEs">
    **Cmd/Ctrl + J**\
    New Chat / New Chat With Selected Code / Close Gobi Sidebar If Chat Already In Focus

    **Cmd/Ctrl + Shift + J**\
    Focus Current Chat / Add Selected Code To Current Chat / Close Gobi Sidebar If Chat Already In Focus
  </Tab>
</Tabs>

<Tip>
  Use Chat for code reviews, debugging help, learning new concepts, or
  brainstorming solutions to complex problems.
</Tip>

<img src="https://mintcdn.com/gourmand/cY6wRTl5s2wbpiM-/images/chat-quick-start.gif?s=7c4685b7396fe7fe0844df114a2b0a0b" alt="chat-demo" width="1140" height="720" data-path="images/chat-quick-start.gif" />

***

## 🤖 Agent Mode

**What it does**: An autonomous coding assistant that can read files, make changes, run commands, and handle complex multi-step tasks.

<Steps>
  <Step title="Switch to Agent Mode">
    1. Open the Gobi panel
    2. Click the **dropdown** in the bottom left of the input box
    3. Select **"Agent"** mode
  </Step>

  <Step title="Give Agent Mode a Complex Task">
    Try this prompt: `"Write comprehensive unit tests for the sorting functions
          in this file. Create the tests in a new file using Jest, and make sure to test
          edge cases like empty arrays and single elements."`
  </Step>

  <Step title="Watch Agent Mode Work">
    Agent mode will:

    * ✅ Analyze your existing code
    * ✅ Create a new test file
    * ✅ Write comprehensive tests
    * ✅ Handle setup and imports
    * ✅ Explain what it's doing at each step
  </Step>
</Steps>

<Warning>
  Agent mode has powerful capabilities including file creation and modification.
  Always review Agent mode's changes before accepting them.
</Warning>

<img src="https://mintcdn.com/gourmand/cY6wRTl5s2wbpiM-/images/agent-quick-start.gif?s=0f54f781f58da9edd9821df2715b11e7" alt="agent-demo" width="996" height="720" data-path="images/agent-quick-start.gif" />

***

## Explore More Extension Examples

Ready to explore more? Gobi offers five powerful features to enhance your coding workflow:

<Tabs>
  <Tab title="Agent Mode">
    [Agent Mode](/ide-extensions/agent/quick-start) equips the Chat model with the tools needed to handle a wide range of coding tasks

    <img src="https://mintcdn.com/gourmand/cY6wRTl5s2wbpiM-/images/agent-9ef792cfc196a3b5faa984fb072c4400.gif?s=50e3215743ec9e90b68dfa942f54f472" alt="agent mode" width="1552" height="1080" data-path="images/agent-9ef792cfc196a3b5faa984fb072c4400.gif" />

    <Info>
      Learn more about [Agent Mode](/ide-extensions/agent/quick-start)
    </Info>
  </Tab>

  <Tab title="Chat Mode">
    [Chat](/ide-extensions/chat/quick-start) makes it easy to ask for help from an LLM without needing to leave the IDE

    <img src="https://mintcdn.com/gourmand/cY6wRTl5s2wbpiM-/images/chat-489b68d156be2aafe09ee7cedf233fba.gif?s=3ebf398335129457e849aebf3a437f4a" alt="chat" width="1552" height="1080" data-path="images/chat-489b68d156be2aafe09ee7cedf233fba.gif" />

    <Info>
      Learn more about [Chat Mode](/ide-extensions/chat/quick-start)
    </Info>
  </Tab>

  <Tab title="Plan">
    [Plan](/ide-extensions/agent/plan-mode) provides a safe environment with read-only tools for exploring code and planning changes

    <img src="https://mintcdn.com/gourmand/lfYeqLX2hvXkgz5p/images/plan-mode.gif?s=d6e5ad7e6d35831bf4bf3c94305300c5" alt="plan" width="1108" height="720" data-path="images/plan-mode.gif" />

    <Info>
      Learn more about [Plan Mode](/ide-extensions/agent/plan-mode)
    </Info>
  </Tab>

  <Tab title="Edit">
    [Edit](/ide-extensions/edit/quick-start) is a convenient way to modify code without leaving your current file

    <img src="https://mintcdn.com/gourmand/kkqYf7UwBaqLLOdV/images/edit.gif?s=db562c1367d4f05e4743a0bcf1aedd08" alt="edit" width="1552" height="1080" data-path="images/edit.gif" />

    <Info>
      Learn more about [Edit](/ide-extensions/edit/quick-start)
    </Info>
  </Tab>

  <Tab title="Autocomplete">
    [Autocomplete](/ide-extensions/autocomplete/quick-start) provides inline code suggestions as you type

    <img src="https://mintcdn.com/gourmand/cY6wRTl5s2wbpiM-/images/autocomplete-9d4e3f7658d3e65b8e8b20f2de939675.gif?s=acde9a6522d5c136a7f0ce4b5e2017f1" alt="autocomplete" width="1552" height="1080" data-path="images/autocomplete-9d4e3f7658d3e65b8e8b20f2de939675.gif" />

    <Info>
      Learn more about [Autocomplete](/ide-extensions/autocomplete/quick-start)
    </Info>
  </Tab>
</Tabs>

## 🚀 Next Steps

Congratulations! You've experienced all four core Gobi features. Here's what to explore next:

<CardGroup cols={2}>
  <Card title="Customize Your Setup" icon="gear" href="/customize/overview">
    Configure models, add context providers, and personalize your workflow
  </Card>

  <Card title="Advanced Features" icon="rocket" href="/ide-extensions/agent/quick-start">
    Dive deeper into Agent mode capabilities and advanced use cases
  </Card>

  <Card title="Model Providers" icon="brain" href="/customize/model-providers/overview">
    Connect your preferred AI models and providers
  </Card>

  <Card title="Join Community" icon="users" href="https://discord.gg/TODO">
    Get help and share experiences with other Gobi users
  </Card>
</CardGroup>

***

## 📚 Feature Deep Dives

Ready to master specific features? Check out these detailed guides:

<AccordionGroup>
  <Accordion title="Autocomplete Deep Dive">
    Learn about [configuring autocomplete
    models](/customize/model-roles/autocomplete), [fine-tuning
    suggestions](/customize/deep-dives/autocomplete), and [troubleshooting
    common issues](/troubleshooting).
  </Accordion>

  <Accordion title="Chat & Agent Mode Best Practices">
    Discover [effective prompting techniques](/customize/deep-dives/prompts), [hub
    v. local configuration](/guides/understanding-configs), and [custom slash
    commands](/customize/deep-dives/prompts).
  </Accordion>

  <Accordion title="Enterprise & Teams">
    Explore [Hub configurations](/hub/configs/intro), [organization
    management](/hub/governance/creating-an-org), and [sharing
    configurations](/hub/sharing).
  </Accordion>
</AccordionGroup>

<Info>
  **Need help?** Check our [troubleshooting guide](/troubleshooting) or ask a
  question in our [community
  discussions](https://github.com/gourmand/gobi/discussions).
</Info>
