Documentation

Installation Guide

Install perfecX Agent SDKs and tools for your preferred platform and framework.

System Requirements

Python SDK

Python 3.8 or higher
pip 20.0+
4GB RAM minimum

Node.js SDK

Node.js 16.0 or higher
npm 7+ or yarn 1.22+
4GB RAM minimum

Python SDK Installation

Using pip

pip install perfecxion-agent

Using Poetry

poetry add perfecxion-agent

Using Conda

conda install -c perfecxion perfecxion-agent

Framework-Specific Installation

For LangChain:

pip install "perfecxion-agent[langchain]"

For AutoGPT:

pip install "perfecxion-agent[autogpt]"

For CrewAI:

pip install "perfecxion-agent[crewai]"

Node.js SDK Installation

Using npm

npm install @perfecxion/agent

Using yarn

yarn add @perfecxion/agent

Using pnpm

pnpm add @perfecxion/agent

TypeScript Support

TypeScript definitions are included. No additional @types package needed.

// tsconfig.json
{
  "compilerOptions": {
    "types": ["@perfecxion/agent"]
  }
}

CLI Tool Installation

Global Installation

npm install -g @perfecxion/cli

Verify Installation

perfecx --version
# Output: perfecX CLI v1.0.0

perfecx agent --help
# Shows all available agent commands

Docker Installation

Pull the Docker Image

docker pull perfecxion/agent:latest

Run with Docker Compose

# docker-compose.yml
version: '3.8'
services:
  perfecx-agent:
    image: perfecxion/agent:latest
    environment:
      - PERFECX_API_KEY=your-api-key
      - PERFECX_ENVIRONMENT=production
    ports:
      - "8080:8080"
    volumes:
      - ./config:/app/config
      - ./logs:/app/logs

Environment Configuration

Environment Variables

# .env file
PERFECX_API_KEY=your-api-key-here
PERFECX_ENVIRONMENT=production
PERFECX_LOG_LEVEL=info
PERFECX_AGENT_ID=my-agent-001
PERFECX_REGION=us-east-1

Configuration File

# perfecx.config.json
{
  "apiKey": "undefined",
  "environment": "production",
  "monitoring": {
    "enabled": true,
    "interval": 1000,
    "batchSize": 100
  },
  "security": {
    "encryptMemory": true,
    "validateTools": true,
    "enforceTimeout": 300000
  }
}

Verify Your Installation

Python

import perfecxion_agent

# Check version
print(perfecxion_agent.__version__)

# Test connection
client = perfecxion_agent.Client(api_key="your-api-key")
status = client.health_check()
print(f"Connection status: {status}")

Node.js

const { PerfecXAgent } = require('@perfecxion/agent');

// Check version
console.log(PerfecXAgent.VERSION);

// Test connection
const client = new PerfecXAgent({ apiKey: 'your-api-key' });
const status = await client.healthCheck();
console.log(`Connection status: ${status}`);

Common Installation Issues

SSL Certificate Errors

If behind a corporate proxy, set: NODE_TLS_REJECT_UNAUTHORIZED=0

Permission Denied

Use sudo for global installs or use a Node version manager

Version Conflicts

Clear cache: npm cache clean --force

Next Steps

Follow the Quick Start Guide →Explore the API Reference →View Integration Examples →