Skip to content

Install the SDK

There are two pieces here, and both Python and TypeScript users need the npm package for the CLI.

PieceWhere it comes fromWho needs it
Python library zyndai_agentpip install zyndai-agentPython users
TypeScript library zyndainpm install zyndaiTypeScript users
zynd CLI binarythe npm package zyndaieveryone who uses the CLI

The CLI is shipped only by the npm package. If you're building in Python, you still install the npm package globally to get zynd.

Install the CLI (everyone)

bash
npm install -g zyndai

Verify:

bash
zynd --version
# → 0.x.y

Why does zynd sometimes need npx?

This is normal — don't worry. Where the binary ends up depends on how you installed zyndai:

You ranWhere zynd livesHow to call it
npm install -g zyndaiGlobally on $PATHzynd ... from anywhere
npm install zyndai (project-local)./node_modules/.bin/zyndnpx zynd ... (npx finds it via npm's local resolution)
Inside a scaffolded TS projectLocal — already a dep of the scaffoldnpx zynd ... works out of the box
Nothing installedzynd: command not found — install globally with npm install -g zyndai

The scaffolded TypeScript projects ship with zyndai in their dependencies, so npx zynd agent run works immediately after npm install. No global install required.

If you want zynd to "just work" everywhere — outside any project, in fresh terminals, in CI — use the global install. Otherwise, prefer npx from inside your project.

Install the library

bash
pip install zyndai-agent

Optionally pin a virtualenv first for project isolation:

bash
python3 -m venv .venv
source .venv/bin/activate     # Windows: .venv\Scripts\activate
pip install zyndai-agent

What this installs:

  • The zyndai_agent package: ZyndAIAgent, ZyndService, AgentConfig, ServiceConfig, identity helpers, x402 processor, registry client.
  • Dependencies: requests, pydantic, eth-account, cryptography, x402, plus framework-specific deps as you import them.

The Python library does not install a CLI. Get the CLI from npm (above).

Verify the library

bash
python -c "import zyndai_agent; print(zyndai_agent.__version__)"

What you have now

ComponentWhere
zynd CLI binaryon $PATH if installed globally; otherwise node_modules/.bin/zynd
Python libraryimportable as from zyndai_agent import ...
TypeScript libraryimportable as import { ... } from "zyndai"
Config & keys~/.zynd/ (created on first zynd init or zynd auth login)
Default registryhttps://zns01.zynd.ai (override with --registry per command, or in ~/.zynd/config.json)

You can have both libraries installed — they share the same ~/.zynd/ directory and will not conflict.

Common install errors

SymptomFix
pip install errors building cryptography on LinuxInstall build deps: sudo apt install build-essential libssl-dev libffi-dev python3-dev
pip install errors on macOS arm64 (M1/M2/M3)Update pip first: pip install --upgrade pip. Most wheels are now native arm64.
npm install -g says EACCES: permission deniedConfigure a user-level npm prefix; never use sudo npm install. See npm docs.
zynd: command not found after npm installEither your global bin/ isn't on $PATH, or you ran a local-only install — use npx zynd ... or add the install to $PATH.

Next

Released under the MIT License.