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

# 1. Install

> Get atopile extension and KiCad set up

<Tip>
  Just want to try atopile without installing anything? Check out the [playground](https://playground.atopile.io/) — it runs entirely in your browser.

  Note: Nothing is saved between sessions. If you want to save your work, proceed with installing the extension.
</Tip>

The primary way to interact with atopile locally is via the VS Code extension. We also support forks like Cursor or Antigravity.

## 1. Install Preferred VS Code Fork

| Editor             | Download                                                                         |
| ------------------ | -------------------------------------------------------------------------------- |
| VSCode             | [https://code.visualstudio.com/download](https://code.visualstudio.com/download) |
| Cursor             | [https://cursor.com/download](https://cursor.com/download)                       |
| Google Antigravity | [https://antigravity.google/download](https://antigravity.google/download)       |

## 2. Install Extension

Once you have a VS Code editor, search for the extension or install by clicking [atopile extension](https://marketplace.visualstudio.com/items?itemName=atopile.atopile).

<img src="https://mintcdn.com/atopile/DwBxr5aqA-UPK0qU/atopile-0.14.x/images/vscode-plugin.png?fit=max&auto=format&n=DwBxr5aqA-UPK0qU&q=85&s=1a1abae298d2aff8c61c0747d4b97a83" alt="atopile extension" width="279" height="178" data-path="atopile-0.14.x/images/vscode-plugin.png" />

Once the extension is installed, you might see a popup for uv installing. Allow that to finish.

<img src="https://mintcdn.com/atopile/DwBxr5aqA-UPK0qU/atopile-0.14.x/images/vscode-plugin-installing.png?fit=max&auto=format&n=DwBxr5aqA-UPK0qU&q=85&s=1f4368d5b67cd826ed722989739e6acb" alt="atopile extension installing" width="912" height="136" data-path="atopile-0.14.x/images/vscode-plugin-installing.png" />

Complete!

<img src="https://mintcdn.com/atopile/DwBxr5aqA-UPK0qU/atopile-0.14.x/images/vscode-plugin-install-complete.png?fit=max&auto=format&n=DwBxr5aqA-UPK0qU&q=85&s=26e87764c1613b1a16c0773b680476e6" alt="atopile extension installed" width="914" height="102" data-path="atopile-0.14.x/images/vscode-plugin-install-complete.png" />

You will now have a *fresh* new atopile icon in your sidebar. Click it to open the extension and get started.

<img src="https://mintcdn.com/atopile/DwBxr5aqA-UPK0qU/atopile-0.14.x/images/vscode-plugin-overview.png?fit=max&auto=format&n=DwBxr5aqA-UPK0qU&q=85&s=aae40cab93011e15f75aa435de627238" alt="atopile extension overview" width="2400" height="1600" data-path="atopile-0.14.x/images/vscode-plugin-overview.png" />

## 3. Install KiCAD

If you want to layout or route PCBs you will need to install [KiCAD](https://www.kicad.org/download/).

<CodeGroup>
  ```sh macOS (brew) theme={null}
  brew install kicad
  ```

  ```sh Arch Linux theme={null}
  sudo pacman -S kicad
  ```

  ```sh Ubuntu theme={null}
  sudo apt install kicad
  ```

  ```sh other theme={null}
  https://www.kicad.org/download/
  # or click the KiCAD link above
  ```
</CodeGroup>

## 4. Done!

Great! At this point you can move on and [create your first project](./2-create-a-project).

## Other Install Methods (Optional)

### Homebrew <small>(recommended for macOS)</small>

```sh theme={null}
brew install atopile/tap/atopile
```

### uv <small>(recommended for other platforms)</small>

1. Install `uv`

   [https://docs.astral.sh/uv/getting-started/installation/](https://docs.astral.sh/uv/getting-started/installation/)

2. Install atopile with `uv`

   ```sh theme={null}
   uv tool install atopile
   ```

   <Warning>
     If this is the first time you've used `uv` for a tool install, it might give you another command to run to finish setup.

     Do it.
   </Warning>

3. Check `ato` installed

   ```sh theme={null}
   ato --version
   ```

### Editable Installation <small>(best for development)</small>

1. Install `uv` (see above)

2. Clone the repo

   ```sh theme={null}
   git clone https://github.com/atopile/atopile
   ```

3. `cd` into the repo

   ```sh theme={null}
   cd atopile
   ```

4. Install

   ```sh theme={null}
   uv sync --dev
   ```