Skip to main content

Environment & Tooling Checklist

Before building on ACM, ensure your workstation or CI runners satisfy the baseline requirements.

Core requirements

ComponentMinimumNotes
Node.js18.x LTSRuntime for all Node packages and the documentation site
pnpm8.xWorkspace package manager (ships with lockfiles in the repo)
Python (optional)3.10+Required only when running vLLM or Python-based tooling
Git2.30+Needed for versioning and replay bundle storage

Install pnpm if you have not already:

npm install -g pnpm@8

Provider credentials

ProviderNeeded forHow to supply
vLLMLocal LLM hostingRun python -m vllm.entrypoints.openai.api_server
OllamaLocal LLM hostingInstall Ollama and pull a compatible model
OpenAI / Azure OpenAIManaged inferenceExport OPENAI_API_KEY / AZURE_OPENAI_KEY
Brave Search MCPContext retrievalExport BRAVE_API_KEY before launching demo
GitHub MCPRepository insightsExport GITHUB_TOKEN with appropriate scopes
  • VS Code with TypeScript / Markdown / Mermaid support
  • Graphviz (optional) if you render DOT diagrams inside the docs
  • direnv or similar to manage environment variables per project

Reproducible environments

For deterministic builds in CI/CD, cache the pnpm store:

default:
cache:
key: pnpm-${CI_COMMIT_REF_SLUG}
paths:
- .pnpm-store

Use corepack to pin pnpm per Node version:

corepack enable
corepack prepare pnpm@8.15.0 --activate

Next steps

  • Build the workspace with pnpm build.
  • Run pnpm test to ensure packages pass their integration suites.
  • Jump to Authoring with the SDK.