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

# Installation

> Install the Feather CLI and check you have the prerequisites for the kind of app you are building.

## Prerequisites

<Tabs>
  <Tab title="Core (all apps)">
    | Requirement      | Why                                     |
    | ---------------- | --------------------------------------- |
    | **Python 3.11+** | The runtime                             |
    | **Node.js 22+**  | Vite 7 (build tooling) and Tailwind CSS |
    | **pipx**         | Installing the Feather CLI globally     |
  </Tab>

  <Tab title="Simple apps">
    No auth, prototypes, internal tools.

    | Requirement | Why                                     |
    | ----------- | --------------------------------------- |
    | **SQLite**  | Works out of the box, no setup required |
  </Tab>

  <Tab title="Production apps">
    Auth, multi-tenant, background jobs.

    | Requirement                         | Why                                                                |
    | ----------------------------------- | ------------------------------------------------------------------ |
    | **PostgreSQL**                      | Required for multi-tenant apps, recommended for anything with auth |
    | **Google Cloud credentials**        | OAuth — the free tier works fine                                   |
    | **Redis** (optional)                | Distributed caching and persistent job queues                      |
    | **Google Cloud Storage** (optional) | File uploads in production                                         |
    | **Resend** (optional)               | Transactional emails                                               |
  </Tab>
</Tabs>

## Install the CLI

<CodeGroup>
  ```bash From PyPI (recommended) theme={null}
  pip install feather-framework
  ```

  ```bash With pipx (isolated) theme={null}
  brew install pipx && pipx ensurepath   # if you don't have pipx
  pipx install feather-framework
  ```

  ```bash For development (contributing) theme={null}
  git clone https://github.com/RolandFlyBoy/Feather.git
  cd Feather
  pipx install -e .
  feather test --framework
  ```
</CodeGroup>

That is all you need to run `feather new`. You can now run it from any directory.

## Extras and reproducible builds

The generated project's `requirements.txt` names the [extras](/deployment/overview)
your answers enabled, pinned to the version that generated it, so builds are
reproducible:

```text requirements.txt theme={null}
feather-framework[postgres,redis,prod,test]==0.9.8
```

<Note>
  Importing a feature whose extra is missing raises an error naming the exact install
  command, rather than an import traceback.
</Note>

<Card title="Next: create your first app" icon="rocket" href="/quickstart" horizontal>
  Scaffold a project, run the migrations and start the dev server.
</Card>
