Browse Documentation

Start / installation

Grow a local Wildflower.

The current pre-release path runs the API and generated clients from source. It gives contributors and approved preview users a complete local sandbox boundary without pretending that hosted signup or public package installation already exists.

Pre-release availability

The source repositories and generated SDK packages are currently private and marked source-only. Public registry installation and hosted API access require separate launch approval. This guide is fully runnable for developers who already have repository access.

Requirements

The narrow local path needs Node.js, pnpm through Corepack, Rust, and one sandbox-provider credential. Full multi-language validation additionally uses Python, uv, Go, Zig, PostgreSQL, and ClickHouse.

terminal
node --version   # v24.18.xcorepack pnpm --version   # 11.17.xrustc --version   # 1.97.1

Start the API

From the root of the wildflower source checkout, install the JavaScript workspace, create a strong local bearer key, and start the Rust API. Without DATABASE_URL, this key authenticates the entire local process and connected provider profiles remain in memory.

terminal
corepack pnpm installexport WILDFLOWER_API_KEY="$(openssl rand -hex 32)"cargo run --package wildflower-api

Verify the public boundary

Health and OpenAPI are public. Sandbox lifecycle routes require the bearer key created above.

terminal
export WILDFLOWER_URL="http://localhost:8080"curl -fsS "$WILDFLOWER_URL/healthz" | jqcurl -fsS "$WILDFLOWER_URL/openapi.json" | jq '.info.version'

Choose a client

What happens next

Connect provider access

Store one project-scoped profile or use an inline override.

Run the lifecycle

Create, execute, inspect, and delete one persistent sandbox.

Validate locally

Run contract and SDK checks before any release action.