Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/archestra-ai/archestra/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks you through everything you need to get Archestra running locally for development. The platform uses a local Kubernetes cluster orchestrated by Tilt, which gives you hot-reload on code changes, a development dashboard, and a close approximation of the production deployment environment.

Prerequisites

Before cloning the repository, make sure the following tools are installed and available on your PATH.

Core Requirements

Node.js

Version 18–24 required. Used as the JavaScript runtime for all platform services.

pnpm

Version 8 or higher. Install with:
npm install -g pnpm

Git

Standard version control. Required to clone the repository and work with branches.

Kubernetes Development Tools

Tilt

Development environment orchestrator. See the Tilt install guide.

kubectl

Kubernetes CLI. See the kubectl install guide.

Helm

Package manager for Kubernetes. See the Helm install guide.

Local Kubernetes Cluster

Choose one option: Docker Desktop (with Kubernetes enabled), Kind, or OrbStack (recommended on macOS).

Development Tools

Quick Start

1

Clone the Repository

git clone https://github.com/archestra-ai/archestra.git
cd archestra/platform
2

Launch the Development Environment

Start the local Kubernetes development environment:
tilt up
This single command will:
  • Build and deploy all platform services to your local Kubernetes cluster
  • Set up hot-reload so code changes are reflected immediately without manual restarts
  • Open the Tilt UI at http://localhost:10350 for service health and logs
  • Open the Archestra UI at http://localhost:3000
By default, the platform allows localhost origins on any port for CORS. For production deployments or custom CORS configuration, see Environment Variables.
3

Understand Dependency Security

The platform enforces two security controls on all dependencies to reduce supply-chain risk:

Install Scripts Disabled

Install scripts are disabled by default to prevent malicious code execution during package installation.

7-Day Minimum Release Age

Newly published packages are held for 7 days before installation is allowed, guarding against package-squatting attacks.
If a package requires its install scripts to function correctly, rebuild it manually:
pnpm rebuild <package-name>
This is rarely needed. The vast majority of packages work without their install scripts.

Development Workflow

Once tilt up is running, Tilt watches your source files and automatically rebuilds and redeploys affected services when changes are detected. You can monitor all services, view logs, and trigger manual rebuilds from the Tilt UI at http://localhost:10350.
Before writing any code, check in with the team on Slack. The core team can share existing designs, flag related work in progress, and give you effective feedback before you invest time in implementation. See the Contributing Guidelines for the full contribution process.

Build docs developers (and LLMs) love