Install Vortexify

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 toolsCopy Anchor Link

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

Install the CLICopy Anchor Link

Download the installer for your computer from the latest CLI release:

• macOS / Linux: install.sh
• Windows: install.ps1

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

sh ~/Downloads/install.sh

On Windows, open PowerShell and run the downloaded file:

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.

vortexify --version

To check for a newer release or install it:

vortexify update --check
vortexify update

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

Sign inCopy Anchor Link

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 for selecting a different API environment or explicit token authentication.

Install the SDKsCopy Anchor Link

Use Python 3.10+ in a virtual environment:

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:

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

SDK source and package READMEs: Python SDK and React SDK.

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

Add coding-agent guidanceCopy Anchor Link

Install the Vortexify plugin from vortexifyai/skills through your coding tool's plugin manager, or use the CLI wrapper:

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.