# Install Vortexify

Source: /docs/getting-started/installation.md

Install the CLI and published SDKs, then sign in to the organization where you will build your project. Your coding agent works in the local project directory; Vortexify stores saved source and runs backend work.

## Developer tools [#developer-tools]

Choose the tool for the part of your project you are building. Each package is released independently.

<div class="docs-package-grid">
  <article class="docs-package-card">
    <div class="docs-package-top"><span class="docs-package-category">Command line</span><a class="docs-package-version" href="https://github.com/vortexifyai/cli/releases/tag/v0.1.3" aria-label="CLI version 0.1.3 release">v0.1.3</a></div>
    <h3>Vortexify CLI</h3>
    <code class="docs-package-name">vortexify</code>
    <p>Create and commit resources, run jobs, inspect logs, and develop apps locally.</p>
    <div class="docs-package-links"><a href="#install-the-cli">Install CLI <span aria-hidden="true">→</span></a><a href="https://github.com/vortexifyai/cli">GitHub <span aria-hidden="true">↗</span></a></div>
  </article>
  <article class="docs-package-card">
    <div class="docs-package-top"><span class="docs-package-category">Backend resources</span><a class="docs-package-version" href="https://pypi.org/project/vortexify/0.1.1/" aria-label="Python SDK version 0.1.1 on PyPI">v0.1.1</a></div>
    <h3>Python SDK</h3>
    <code class="docs-package-name">vortexify</code>
    <p>Define transforms, APIs, connectors, and agents with typed inputs and resource declarations.</p>
    <div class="docs-package-links"><a href="https://pypi.org/project/vortexify/">PyPI <span aria-hidden="true">↗</span></a><a href="https://github.com/vortexifyai/python-sdk">GitHub <span aria-hidden="true">↗</span></a></div>
  </article>
  <article class="docs-package-card">
    <div class="docs-package-top"><span class="docs-package-category">Application UI</span><a class="docs-package-version" href="https://www.npmjs.com/package/@vortexify/react/v/0.1.1" aria-label="React SDK version 0.1.1 on npm">v0.1.1</a></div>
    <h3>React SDK</h3>
    <code class="docs-package-name">@vortexify/react</code>
    <p>Connect React apps to project APIs, agents, and data through the Vortexify client and hooks.</p>
    <div class="docs-package-links"><a href="https://www.npmjs.com/package/@vortexify/react">npm <span aria-hidden="true">↗</span></a><a href="https://github.com/vortexifyai/react-sdk">GitHub <span aria-hidden="true">↗</span></a></div>
  </article>
  <article class="docs-package-card">
    <div class="docs-package-top"><span class="docs-package-category">Coding-agent guidance</span><a class="docs-package-version" href="https://github.com/vortexifyai/skills/tree/v0.1.1" aria-label="Agent skills version 0.1.1 on GitHub">v0.1.1</a></div>
    <h3>Agent skills</h3>
    <code class="docs-package-name">vortexifyai/skills</code>
    <p>Give Codex or Claude Code project workflows for building resources, connectors, and apps.</p>
    <div class="docs-package-links"><a href="#add-coding-agent-guidance">Install skills <span aria-hidden="true">→</span></a><a href="https://github.com/vortexifyai/skills">GitHub <span aria-hidden="true">↗</span></a></div>
  </article>
</div>

## Install the CLI [#install-the-cli]

Download the installer for your computer from the latest [CLI release](https://github.com/vortexifyai/cli/releases/latest):

- [macOS / Linux: install.sh](https://github.com/vortexifyai/cli/releases/latest/download/install.sh)
- [Windows: install.ps1](https://github.com/vortexifyai/cli/releases/latest/download/install.ps1)

On macOS or Linux, open Terminal and run the downloaded file:

```sh
sh ~/Downloads/install.sh
```

On Windows, open PowerShell and run the downloaded file:

```powershell
powershell.exe -NoProfile -ExecutionPolicy Bypass -File "$HOME\Downloads\install.ps1"
```

The installer downloads the matching CLI executable and verifies its checksum. On macOS/Linux it installs to `~/.local/bin`; add that directory to PATH if the installer asks. On Windows it installs to your local app-data directory and adds it to your user PATH; open a new terminal afterward.

```sh
vortexify --version
```

To check for a newer release or install it:

```sh
vortexify update --check
vortexify update
```

Windows updates finish in a separate PowerShell window after the current CLI exits.

## Sign in [#sign-in]

```sh
vortexify login
```

Use the account and organization that have access to the project. Creating a project requires the server's builder/admin permissions; project membership is checked separately from organization membership. See [CLI configuration](/docs/reference/cli/configuration) for selecting a different API environment or explicit token authentication.

## Install the SDKs [#install-the-sdks]

Use Python 3.10+ in a virtual environment:

```sh
python3 -m venv .venv
source .venv/bin/activate
python -m pip install vortexify==0.1.1
```

On Windows, activate with `.venv\Scripts\activate`. Keep `python3` available on PATH for the CLI's Python dependency inspection.

Install Node.js/npm for the React interface. App starters declare `@vortexify/react`; run `npm install` in the app directory. To add it to an existing React 18+ app:

```sh
npm install --save-exact @vortexify/react@0.1.1
```

SDK source and package READMEs: [Python SDK](https://github.com/vortexifyai/python-sdk) and [React SDK](https://github.com/vortexifyai/react-sdk).

Backend resource dependencies belong in each resource's `requirements.in`; browser dependencies belong in the app's `package.json`.

## Add coding-agent guidance [#add-coding-agent-guidance]

Install the Vortexify plugin from [vortexifyai/skills](https://github.com/vortexifyai/skills) through your coding tool's plugin manager, or use the CLI wrapper:

```sh
vortexify skills install --agent codex
```

Use `--agent claude` for Claude Code. The chosen coding tool must already be installed. `--dry-run` prints the native installation commands; `--source` can select another accessible marketplace source.

The plugin provides project, connector/sync, and app workflows. It is separate from SDK installation and CLI authentication. Other harnesses can follow the generated project guidance and the same CLI workflow.

Next: [Your first app](/docs/getting-started/first-app).