Installation

There are two things to install:

1. The SDK - available for both Python and TypeScript.
2. The armoriq CLI - for auth, API-key management, project scaffolding, and control-plane registration. Both packages ship a binary called armoriq, but they do not cover the same commands: only the Python build has init / validate / register, and only the TypeScript build has policy. See the support matrix.

1. Install the SDK

Requirements

Install

pip install armoriq-sdk

npm install @armoriq/sdk

Verify the SDK

import armoriq_sdk
print(armoriq_sdk.__version__)

import { VERSION } from '@armoriq/sdk';
console.log(VERSION);

2. Install the armoriq CLI

Pick the build by the commands you need.

Python - the fuller CLI, and the only one that can read armoriq.yaml:

pip install armoriq-sdk
# or, to keep it off your project's dependency tree:
pipx install armoriq-sdk

TypeScript - already installed if you have @armoriq/sdk; add -g to put it on your $PATH:

npm install -g @armoriq/sdk

The TypeScript build covers auth, orgs, keys, status, logs, and policy, but answers 'armoriq init' is not yet implemented in the TypeScript CLI for the three config commands. Full breakdown: support matrix.

3. Verify the CLI

armoriq --help

Expected subcommands, Python build: init, validate, register, login, logout, whoami, orgs, switch-org, keys, status, logs.

TypeScript build: login, logout, whoami, orgs, switch-org, keys, policy, status, logs (plus init / validate / register as stubs).

Full reference: CLI docs.

Optional: framework integrations

Python adapters need their extra installed. TypeScript adapters ship inside @armoriq/sdk with no extra install step.

pip install "armoriq-sdk[google-adk]"
pip install "armoriq-sdk[strands]"
pip install "armoriq-sdk[langchain]"     # also covers Langflow
pip install "armoriq-sdk[crewai]"

# Every framework dependency at once
pip install "armoriq-sdk[all]"

npm install @armoriq/sdk

See Integrations for the current status matrix, which is the source of truth, and for the capability differences between adapters.

See Integrations for the full status matrix.

Next steps