Installation
Install the ArmorIQ CLI and SDK via pipx, pip, uv, or npm. Verify your installation and understand when to use each installer.
The ArmorIQ Python package ships the armoriq CLI and the Python SDK as a single distribution — one install gives you both. The TypeScript SDK is a separate npm package for Node runtimes.
Python CLI + SDK
The CLI and SDK live in the same package (armoriq-sdk). For most users, pipx is the right installer because it puts the armoriq command on your shell's PATH in an isolated virtual environment — no conflict with your project dependencies.
pipx install armoriq-sdk
armoriq --version# Only use pip if you want the SDK inside your project's virtualenv.
python -m venv .venv && source .venv/bin/activate
pip install armoriq-sdk
armoriq --version# Installs the CLI globally via uv's tool manager.
uv tool install armoriq-sdk
armoriq --versionpipx vs pip — pipx installs the CLI globally in a hidden virtualenv; armoriq is on your PATH from any directory, and upgrades never break your project deps. pip install armoriq-sdk puts the SDK inside the currently active venv — useful when you're importing armoriq_sdk from your Python code and want the SDK pinned with your other project dependencies.
Verify the Python install
armoriq --helpYou should see a list of subcommands including login, orgs, switch-org, init, validate, register, status, logs, whoami, and logout.
Requirements
- Python 3.10 or later.
- Supported on macOS, Linux, and Windows (WSL recommended on Windows for the best terminal experience).
TypeScript SDK
The TypeScript SDK is a library for Node.js runtimes. It does not ship a CLI — use the Python CLI for authentication even if your runtime is Node.
npm install @armoriq/sdkpnpm add @armoriq/sdkyarn add @armoriq/sdkVerify the TypeScript install
node -e "console.log(require('@armoriq/sdk').ArmorIQClient.name)"Prints ArmorIQClient if the package loaded successfully.
Requirements
- Node.js 18 or later.
- TypeScript 5.0 or later (if you're using TS directly).
What to install — decision tree
| You're building… | Install |
|---|---|
| A Python agent (CrewAI, Google ADK, LangChain, or raw client) | pipx install armoriq-sdk |
| A Node/TypeScript agent | pipx install armoriq-sdk and npm install @armoriq/sdk |
| Only using the CLI to manage keys and orgs | pipx install armoriq-sdk |
| Both a Python service and a Node service | Install both — they share ~/.armoriq/credentials.json |
Install the Python CLI on any developer machine. It's the source of truth for armoriq login, armoriq orgs, and armoriq switch-org. The TypeScript SDK reads the same credentials file the CLI writes, so a single login works for both runtimes.
Next steps
SDK & CLI
Install the ArmorIQ CLI, wire the Python or TypeScript SDK into your agent, and ship authorized tool calls backed by cryptographic intent tokens and per-user policy enforcement.
Quickstart
Sixty seconds from installation to your first authorized tool call. Log in, capture a plan, get an intent token, invoke a tool.