Skip to content

AxonPush Wizard

The AxonPush wizard is a CLI tool that integrates the AxonPush SDK into your AI agent project in seconds.

Quick Start

bash
npx @axonpush/wizard

The wizard will:

  1. Detect your framework — scans your project for LangChain, OpenAI Agents, CrewAI, Anthropic, or plain Python
  2. Authenticate — log in via browser or enter an API key manually
  3. Integrate — installs the SDK, adds credentials to .env, and wires up tracing in your code

Installation

You can run the wizard directly with npx (no install needed):

bash
npx @axonpush/wizard

Or install it globally:

bash
npm install -g @axonpush/wizard

CLI Options

FlagDescriptionDefault
-i, --integrationFramework: langchain, openai-agents, anthropic, crewai, coreAuto-detected
--api-keyAxonPush API keyPrompted
--tenant-idOrganization/tenant IDPrompted
--base-urlAxonPush API URLhttps://api.axonpush.xyz
--install-dirProject directoryCurrent directory
--debugEnable debug outputfalse

Example

bash
# Auto-detect everything
npx @axonpush/wizard

# Specify framework and skip prompts
npx @axonpush/wizard -i langchain --api-key ak_... --tenant-id 1

What Gets Modified

The wizard modifies your project files to add:

  • .env — adds AXONPUSH_API_KEY, AXONPUSH_TENANT_ID, AXONPUSH_BASE_URL
  • Dependencies — installs axonpush (with framework extras if needed)
  • Source code — adds imports, client initialization, and integration code to your main entry point

Existing code is never removed or modified — only AxonPush integration code is added.