Installation
Install the ArmorIQ SDK and CLI
Installation
There are two things to install:
- The SDK — available for both Python and TypeScript.
- The
armoriqCLI — a separate, Python-only tool for auth, project scaffolding, and control-plane registration. A Node-native CLI is on the roadmap, but for now CLI users install Python regardless of which SDK they use in their app.
1. Install the SDK
Requirements
- Python 3.9 or higher
- pip 20.0 or higher
- HTTPS-capable network connection
- Node.js 18 or higher
- npm 8.0 or higher
- HTTPS-capable network connection
Install
pip install armoriq-sdkThe Python package ships the armoriq_sdk library and the armoriq CLI
in one install — skip to step 3.
npm install @armoriq/sdkThe npm package ships the TypeScript SDK only. See step 2 for the CLI.
Verify the SDK
import armoriq_sdk
print(armoriq_sdk.__version__)import { VERSION } from '@armoriq/sdk';
console.log(VERSION);2. Install the armoriq CLI
The CLI is distributed with the Python package. TypeScript users install it
in addition to @armoriq/sdk:
pip install armoriq-sdkA standalone Node-native CLI (npm install -g @armoriq/cli) is on the
roadmap. For now, the Python install is the only way to get armoriq on
your $PATH.
3. Verify the CLI
armoriq --helpExpected subcommands: init, validate, register, login, logout,
whoami, orgs, switch-org, status, logs.
Full reference: CLI docs.
Optional: framework integrations
Only the Python + Google ADK integration is live today. Other adapters — and every TypeScript adapter — are on the roadmap.
# Live
pip install "armoriq-sdk[google-adk]"
# Coming soon — extras reserved, adapters not yet ready
pip install "armoriq-sdk[crewai]"
pip install "armoriq-sdk[langchain]"
pip install "armoriq-sdk[openai]"
pip install "armoriq-sdk[anthropic]"# All TypeScript integrations are coming soon.
# Use the core SDK directly, or use the Python SDK + Google ADK adapter.See Integrations for the full status matrix.