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

# Install

> How to install atopile

## Install via VSCode/Cursor (Recommended)

atopile officially supports VSCode and Cursor.

We recommend using Cursor. AI is already getting very good at writing `ato` code.

Download it here: [https://www.cursor.com/](https://www.cursor.com/)

Once you have VSCode/Cursor just install the [atopile VSCode/Cursor extension](https://marketplace.visualstudio.com/items?itemName=atopile.atopile).

<img src="https://mintcdn.com/atopile-feature-versioned-docs/c_qwF00FOeiVj0AQ/atopile-0.12.x/images/vscode-plugin.png?fit=max&auto=format&n=c_qwF00FOeiVj0AQ&q=85&s=88eb39d303ac08765e06e956ef3dcb52" alt="atopile extension" width="279" height="178" data-path="atopile-0.12.x/images/vscode-plugin.png" />

After installation it will prompt you to install the `ato` CLI. Click the `Install Automatically` button.

<img src="https://mintcdn.com/atopile-feature-versioned-docs/c_qwF00FOeiVj0AQ/atopile-0.12.x/images/vscode-plugin-install-popup.png?fit=max&auto=format&n=c_qwF00FOeiVj0AQ&q=85&s=7b0a49b944db2749b2103307dc51d596" alt="atopile extension install" width="384" height="126" data-path="atopile-0.12.x/images/vscode-plugin-install-popup.png" />

<Accordion title="(Experimental) MCP server">
  Set up an MCP server for this documentation with

  ```sh theme={null}
  npx mint-mcp add atopile
  ```
</Accordion>

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

Ultimately, `atopile` is a Python package, so you can install it wherever and however you want—but some Python package managers are better than others. Here's the recommended method to install atopile.

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

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

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

1. Install `uv`. See: [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 (Best for development)

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

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
   ```