Skip to content
For the complete documentation index optimized for AI agents, see llms.txt or llms-full.txt. A markdown version of this page is available by appending .md to the URL or sending Accept: text/markdown.

Installation Reference

For AI agents: the documentation index is at llms.txt (full corpus: llms-full.txt). A markdown source for this page is /using-stacks/installation.md.

Complete installation reference for all Arete client SDKs.


For Node.js, Vue, Svelte, or vanilla JS:

Terminal window
npm install @usearete/sdk

Framework-agnostic with AsyncIterable-based streaming. No peer dependencies.


For React applications:

Terminal window
npm install @usearete/react @usearete/sdk zod

React is an application peer dependency. zustand is a normal dependency of @usearete/react and must not be installed separately. Generated stack files use the core SDK and Zod directly, so generated React consumers install all three packages shown above.

For hosted ORE browser apps, set VITE_ARETE_PUBLISHABLE_KEY and pass it to AreteProvider as auth={{ publishableKey }}. Read-only viewing requires authentication but does not require a wallet.


Add to your Cargo.toml:

[dependencies]
a4-sdk = "0.20.1"


The Arete CLI (a4) handles project scaffolding, deployment, and SDK generation. Install the prebuilt binary:

Terminal window
curl -fsSL https://arete.run/install.sh | sh # macOS / Linux
irm https://arete.run/install.ps1 | iex # Windows PowerShell
npx @usearete/a4 install # if you prefer npm

The binary lands in ~/.local/bin/a4 (override with A4_INSTALL_DIR) and the installer prints A4_BIN=<absolute path>. Verify and update with:

Terminal window
a4 doctor --json
a4 self update

Full installer options: CLI Command Reference → Installation.

Only if you need an unreleased build. It requires a Rust toolchain and is not the supported install path:

Terminal window
cargo install a4-cli

IssueSolution
Cannot find module '@usearete/*'Install the React, core SDK, and Zod packages shown above
React peer dependency warningInstall the React version required by your application