Install & Configure

Set up your development environment for the AIP SDK.

⚠️ Requirements

  • Python: 3.10 or higher

  • Operating System: Windows, macOS, or Linux

  • Network: Internet access for package installation

Corporate Networks: If behind a corporate proxy, you may need to configure HTTP_PROXY and HTTPS_PROXY environment variables.

🐍 Python SDK Installation

# Install from PyPI (recommended)
pip install glaip-sdk

# Install specific version
pip install glaip-sdk==0.1.0

Virtual Environment: Consider using a virtual environment (python -m venv venv && source venv/bin/activate) to isolate dependencies.

CLI Tool

# Install via pipx (recommended for CLI)
pipx install glaip-sdk

# Install globally
pip install --user glaip-sdk

# Verify installation
aip --version

pipx PATH: If aip command is not found, run pipx ensurepath and restart your terminal.

Use pipx for isolated CLI installs. It keeps dependencies separate and prevents conflicts.

🔧 Configuration

Environment Variables

Create a .env file in your project directory:

# AIP Platform Configuration
AIP_API_URL=https://your-aip-instance.com
AIP_API_KEY=your-api-key-here

# Optional Configuration
AIP_TIMEOUT=300
AIP_DEBUG=false

Shell Configuration

Add to your shell profile (.bashrc, .zshrc, etc.):

# AIP SDK Configuration
export AIP_API_URL="https://your-aip-instance.com"
export AIP_API_KEY="your-api-key-here"
export AIP_TIMEOUT="300"

Interactive Configuration

# Initialize configuration interactively
aip init

# This will prompt for:
# - API URL
# - API Key
# - Timeout
# - Other settings

Configuration Precedence: CLI config > Environment variables > .env file > Defaults. Later sources override earlier ones.

Config File Location: CLI configuration is stored in ~/.aip/config.yaml (Linux/macOS) or %USERPROFILE%\.aip\config.yaml (Windows).

🔍 Verification

Test Connection

# Check platform connection
aip status

# Expected output:
# ✅ Connected to AIP Platform
# API URL: https://your-aip-instance.com
# Version: 0.1.0

Test Python SDK

from glaip_sdk import Client

# Initialize client
client = Client()

# Test connection
if client.ping():
    print("✅ Connected to AIP Platform")
else:
    print("❌ Connection failed")

🔒 Security Best Practices

Use Different Keys for Different Environments

# Development
AIP_API_URL=https://dev-aip.company.com
AIP_API_KEY=dev-key-123

# Production
AIP_API_URL=https://prod-aip.company.com
AIP_API_KEY=prod-key-456

🔧 Configuration Management

CLI Configuration Commands

# List current configuration
aip config list

# Get specific configuration value
aip config get api_url

# Set configuration value
aip config set api_url "https://your-aip-instance.com"

# Remove configuration value
aip config unset api_url

# Reset all configuration to defaults
aip config reset

Python Configuration

import os
from glaip_sdk import Client

# Load from environment variables
client = Client(
    api_url=os.getenv("AIP_API_URL"),
    api_key=os.getenv("AIP_API_KEY"),
    timeout=int(os.getenv("AIP_TIMEOUT", "300"))
)

# Or load from .env file
from dotenv import load_dotenv
load_dotenv()

client = Client()

📋 Configuration Reference

Variable
Description
Default
Required

AIP_API_URL

AIP Platform API endpoint

-

Yes

AIP_API_KEY

Authentication API key

-

Yes

AIP_TIMEOUT

Request timeout in seconds

300

No

AIP_DEBUG

Enable debug output

false

No

🚀 Next Steps

  • Test your setup: Run Quick Start examples

  • Learn concepts: Understand Core Concepts

  • Build agents: Follow the Agents Guide

🔍 Troubleshooting

Common Issues

# Check connection status
aip status

# Verify configuration
aip config list

# Test with debug output
aip --debug status

# Reset configuration if needed
aip config reset

Debug Mode

# Enable debug output
aip --debug agents list

# Show detailed error information
aip --debug agents run <AGENT_ID> --input "test"

Remember to keep your API keys secure and never hardcode them in your applications!

PreviousQuick StartNextExamples (Hello World+)