Installation
Install @trickest/sdk from GitHub Packages, Node version requirements, and environment variables.
On this page5
Requirements
- Node.js 22+ (
engines.nodeis>=22) - A Trickest API token
- npm, pnpm, or bun
Registry configuration
The package publishes under the @trickest scope on GitHub Packages. Add this to
.npmrc in your project (or user-level ~/.npmrc):
@trickest:registry=https://npm.pkg.github.comAuthenticate to GitHub Packages with a PAT that has read:packages, or use your CI
provider's secret.
Install
npm install @trickest/sdkVerify:
import { TrickestClient } from '@trickest/sdk'
console.log(typeof TrickestClient) // 'function'Environment variables
| Variable | Purpose |
|---|---|
TRICKEST_TOKEN | API token (read by constructor if token option omitted) |
TRICKEST_BASE_URL | API host (default https://trickest.io) |
TRICKEST_WS_URL | WebSocket URL for agent realtime (optional; see Sessions) |
export TRICKEST_TOKEN=<your-token>
export TRICKEST_BASE_URL=https://trickest.io # or http://localhost:3000 for local v2
export TRICKEST_WS_URL=ws://localhost:3002 # local dev WS worker, if separate from HTTP