Installation

This guide covers everything you need to install and configure Connix for your development environment.

System Requirements

Minimum Requirements

• Operating System: Linux, macOS, or Windows
• Internet Connection: Required for API calls and package downloads
• Git: For cloning examples and managing code

Language-Specific Requirements

JavaScript/Node.js

• Node.js: 14.0 or later
• npm: 6.0 or later (or yarn/pnpm/bun)
• TypeScript: 4.0+ (optional but recommended)

Python

• Python: 3.7 or later
• pip: Latest version
• Virtual Environment: Recommended (venv, conda, poetry)

Go

• Go: 1.19 or later
• Go Modules: Enabled (default in Go 1.11+)

Java

• Java: 8 or later (11+ recommended)
• Maven: 3.6+ or Gradle: 6.0+

C++

• C++: 17 or later
• CMake: 3.15 or later
• vcpkg or Conan: For dependency management

SDK Installation

JavaScript/TypeScript

npm

npm install @connix/sdk

yarn

yarn add @connix/sdk

pnpm

pnpm add @connix/sdk

bun

bun add @connix/sdk

For TypeScript projects, types are included automatically. No additional installation needed.

Python

pip

pip install connix-sdk

poetry

poetry add connix-sdk

conda

conda install -c connix connix-sdk

Virtual Environment Setup (Recommended):

# Create virtual environment
python -m venv connix-env

# Activate virtual environment
# On macOS/Linux:
source connix-env/bin/activate
# On Windows:
connix-env\Scripts\activate

# Install SDK
pip install connix-sdk

Go

# Initialize Go module (if not already done)
go mod init your-project-name

# Install Connix SDK
go get github.com/connix-io/connix-go

Example go.mod:

module your-project

go 1.21

require github.com/connix-io/connix-go v1.0.0

Java

Maven

Add to your pom.xml:

<dependency>
  <groupId>io.connix</groupId>
  <artifactId>connix-sdk</artifactId>
  <version>1.0.0</version>
</dependency>

Gradle

Add to your build.gradle:

dependencies {
    implementation 'io.connix:connix-sdk:1.0.0'
}

Gradle (Kotlin DSL)

Add to your build.gradle.kts:

dependencies {
    implementation("io.connix:connix-sdk:1.0.0")
}

C++

vcpkg

vcpkg install connix-sdk

Then in your CMakeLists.txt:

find_package(connix-sdk CONFIG REQUIRED)
target_link_libraries(main PRIVATE connix-sdk::connix-sdk)

Conan

Add to your conanfile.txt:

[requires]
connix-sdk/1.0.0

[generators]
cmake

Manual

git clone https://github.com/connix-io/connix-cpp
cd connix-cpp
mkdir build && cd build
cmake ..
make install

Configuration

Environment Variables

Set up your environment for seamless authentication:

Linux/macOS

# Add to ~/.bashrc, ~/.zshrc, or ~/.profile
export CONNIX_API_KEY="your-api-key-here"
export CONNIX_BASE_URL="https://api.connix.io"  # Optional

Reload your shell:

source ~/.bashrc  # or ~/.zshrc

Windows

PowerShell:

$env:CONNIX_API_KEY="your-api-key-here"
$env:CONNIX_BASE_URL="https://api.connix.io"

Command Prompt:

set CONNIX_API_KEY=your-api-key-here
set CONNIX_BASE_URL=https://api.connix.io

For persistence, use System Properties → Environment Variables

Project Configuration Files

Create configuration files for your projects:

JavaScript

.env file:

CONNIX_API_KEY=your-api-key-here
CONNIX_BASE_URL=https://api.connix.io
CONNIX_TIMEOUT=30000

connix.config.js:

export default {
  apiKey: process.env.CONNIX_API_KEY,
  baseURL: 'https://api.connix.io',
  timeout: 30000,
  retries: 3
};

Python

.env file:

CONNIX_API_KEY=your-api-key-here
CONNIX_BASE_URL=https://api.connix.io
CONNIX_TIMEOUT=30

config.py:

import os
from dataclasses import dataclass

@dataclass
class ConnixConfig:
    api_key: str = os.getenv('CONNIX_API_KEY')
    base_url: str = os.getenv('CONNIX_BASE_URL', 'https://api.connix.io')
    timeout: int = int(os.getenv('CONNIX_TIMEOUT', '30'))

Go

config.go:

package main

import "os"

type Config struct {
    APIKey  string
    BaseURL string
    Timeout int
}

func LoadConfig() *Config {
    return &Config{
        APIKey:  os.Getenv("CONNIX_API_KEY"),
        BaseURL: getEnvOrDefault("CONNIX_BASE_URL", "https://api.connix.io"),
        Timeout: 30,
    }
}

func getEnvOrDefault(key, defaultValue string) string {
    if value := os.Getenv(key); value != "" {
        return value
    }
    return defaultValue
}

Verification

Verify your installation works correctly:

JavaScript

Create test.js:

import { ConnixClient } from '@connix/sdk';

const client = new ConnixClient();

async function test() {
  try {
    const response = await client.hello('Installation Test');
    console.log('✅ Connix SDK working!', response.message);
  } catch (error) {
    console.error('❌ Error:', error.message);
  }
}

test();

Run: node test.js

Python

Create test.py:

import connix

client = connix.Client()

try:
    response = client.hello("Installation Test")
    print(f"✅ Connix SDK working! {response.message}")
except Exception as error:
    print(f"❌ Error: {error}")

Run: python test.py

Go

Create test.go:

package main

import (
    "context"
    "fmt"
    "log"

    connix "github.com/connix-io/connix-go"
)

func main() {
    client := connix.NewClientFromEnv()

    response, err := client.Hello(context.Background(), "Installation Test")
    if err != nil {
        log.Printf("❌ Error: %v", err)
        return
    }

    fmt.Printf("✅ Connix SDK working! %s\n", response.Message)
}

Run: go run test.go

IDE Setup

Visual Studio Code

Install recommended extensions:

{
  "recommendations": [
    "ms-vscode.vscode-typescript-next",
    "ms-python.python",
    "golang.go",
    "redhat.java",
    "ms-vscode.cpptools"
  ]
}

IntelliJ IDEA / WebStorm

1. Install the Connix plugin (if available)
2. Configure SDK paths in Settings
3. Set up environment variables in Run Configurations

Docker Setup

For containerized development:

FROM node:18-alpine

WORKDIR /app

# Install Connix SDK
COPY package*.json ./
RUN npm install

# Copy your application
COPY . .

# Set environment variables
ENV CONNIX_API_KEY=your-api-key-here

EXPOSE 3000
CMD ["node", "index.js"]

Troubleshooting

Common Installation Issues

Package not found:

• Ensure you’re using the correct package name
• Check your package manager is up to date
• Verify network connectivity

Permission errors:

• Use sudo on Linux/macOS (not recommended)
• Better: Use virtual environments or user installs
• On Windows: Run as Administrator

Version conflicts:

• Update your package manager
• Clear package cache
• Use fresh virtual environment

SSL/TLS errors:

• Update certificates: pip install --upgrade certifi
• Check corporate firewall settings
• Verify system time is correct

Getting Help

If you encounter issues:

1. Check our authentication guide
2. Search existing issues
3. Join our Discord community
4. Contact engineering@connix.io

Next Steps

• 🚀 Quick Start - Create your first project
• 🤖 Build Your First Agent - Deploy an AI agent
• 📚 API Reference - Explore all endpoints