Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.julep.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

This guide covers the installation of Julep in various environments and configurations.

​
Prerequisites

Before installing Julep, ensure you have:
  • Python 3.8+ or Node.js 16+ installed
  • pip (for Python) or npm/bun (for Node.js) package manager
  • A Julep API key (Get one here)

​
Package Installation

  1. Using pip:
pip install julep
  1. Using poetry:
poetry add julep
  1. Using pipenv:
pipenv install julep

​
Environment Setup

​
Setting up Environment Variables

It’s recommended to use environment variables for sensitive information like API keys:
  1. Create a .env file in your project root:
JULEP_API_KEY=your_api_key_here
JULEP_ENVIRONMENT=production  # or dev (development)
  1. Load the environment variables in your code:
import os
from dotenv import load_dotenv
from julep import Julep

load_dotenv()

client = Julep(
    api_key=os.getenv('JULEP_API_KEY'),
    environment=os.getenv('JULEP_ENVIRONMENT', 'production')
)

​
Verification

To verify your installation: 
from julep import Julep
import os
from dotenv import load_dotenv

load_dotenv()

client = Julep(
    api_key=os.getenv('JULEP_API_KEY'),
    environment=os.getenv('JULEP_ENVIRONMENT', 'production')
)

# Test connection
agent = client.agents.create(
    name="Test Agent",
    model="claude-3.5-haiku",
    about="A test agent"
)
print(f"Successfully created agent: {agent.id}")

​
IDE Integration

Enhance your development experience by accessing Julep documentation directly in your IDE through the Context7 MCP server. This integration allows you to:
  • Access Julep documentation without leaving your IDE
  • Get instant answers about Julep APIs and concepts
  • View code examples and best practices inline
To set up the integration, visit Context7 Julep Documentation and follow the instructions for your specific IDE.

​
Troubleshooting

Common installation issues and solutions:
  1. API Key Issues
    • Ensure your API key is valid and properly set in environment variables
    • Check if you’re using the correct environment (production/development)
  2. Version Compatibility
    • Make sure you’re using compatible versions of Python/Node.js
    • Update to the latest SDK version if you encounter issues
  3. Docker Issues
    • Verify Docker is running and has sufficient resources
    • Check if required ports are available and not blocked

​
Next Steps

Now that you have Julep installed, you can:

Quick Start

Create your first Julep agent and task