Skip to content

Installation

Install the Cloudmind SDK for JavaScript or Python and configure your API key.

JavaScript

npm install @cloudmind-ai/js

The package ships ESM and CommonJS builds with TypeScript types. Node 18 or later is required for native fetch.

Python

pip install cloudmind

Python 3.9 or later.

Configuration

Set your API key as an environment variable. You can find it in your workspace under Settings → API keys.

CLOUDMIND_API_KEY=cm_live_xxxxxxxxxxxxx

Optional variables:

Variable Default Purpose
CLOUDMIND_API_URL https://api.cloudmind.ai Point at a self-hosted instance
CLOUDMIND_VERBOSE false Log SDK activity to stderr for debugging
CLOUDMIND_FLUSH_INTERVAL 5000 Milliseconds between background flushes
CLOUDMIND_DISABLED false Turn off all tracing without removing code

CLOUDMIND_DISABLED is the recommended way to keep tracing out of local development and unit tests.

Verifying the install

npx cloudmind whoami

This prints the workspace your key belongs to. If it errors, the key is wrong or your network is blocking outbound HTTPS to api.cloudmind.ai.

Next: send your first trace.

Last updated 2026-07-30