Skip to content

Quick Start

🎯 Choose Your Learning Path

👋 I'm a Beginner - Complete Tutorial

1. Installation

bash
pip install agbcloud-sdk
export AGB_API_KEY="your_key"

2. First Example

Important: When using AGB, you need to specify an appropriate image_id. Please ensure you use valid image IDs that are available in your account. You can view and manage your available images in the AGB Console Image Management page.

python
from agb import AGB
from agb.session_params import CreateSessionParams

# Create client
agb = AGB()

# Create code execution session
params = CreateSessionParams(image_id="agb-code-space-1")
session = agb.create(params).session

# Execute code
result = session.code.run_code("print('Hello AGB!')", "python")
print(result.result)

# Cleanup
agb.delete(session)

3. Explore More Features

python
from agb import AGB
from agb.session_params import CreateSessionParams

agb = AGB()

# Create session with custom image
params = CreateSessionParams(
    image_id="agb-code-space-1"
)
session = agb.create(params).session

# Use different modules
# Code execution
code_result = session.code.run_code("import os; print(os.getcwd())", "python")

# Command execution
cmd_result = session.command.execute_command("ls -la")

# File operations
session.file_system.write_file("/tmp/test.txt", "Hello World!")
file_result = session.file_system.read_file("/tmp/test.txt")


print("Code output:", code_result.result)
print("Command output:", cmd_result.output)
print("File content:", file_result.content)

agb.delete(session)

4. Next Steps

🚀 I Have Experience - Quick Start

Core Concepts

python
from agb import AGB
from agb.session_params import CreateSessionParams

agb = AGB()

# Type-safe session creation
params = CreateSessionParams(image_id="agb-code-space-1")
session = agb.create(params).session

# Modules included in all sessions
session.code.run_code(code, "python")           # Code execution
session.command.execute_command("ls -la")       # Shell commands
session.file_system.read_file("/path/file")     # File operations

Key Differences

vs Traditional Tools:

  • Cloud Environment with No Configuration: No need to install Python/Node.js locally
  • Unified API: Integrated code execution, commands, files, and cloud storage
  • Session Isolation: Independent cloud environment for each session
  • Type Safety: Strongly typed sessions and response objects

vs Other Cloud Services:

  • Multi-language Support: Python + JavaScript + Java + R
  • Complete File System: More than just code execution
  • Command Line Access: Full shell environment

Advanced Usage

python
# Session management
params = CreateSessionParams(
    image_id="agb-code-space-1"
)

# Error handling
result = agb.create(params)
if result.success:
    session = result.session
    # Use session...
else:
    print(f"Creation failed: {result.error_message}")

# Batch operations
sessions = []
for i in range(3):
    params = CreateSessionParams(image_id="agb-code-space-1")
    result = agb.create(params)
    if result.success:
        sessions.append(result.session)

# Clean up all sessions
for session in sessions:
    agb.delete(session)

Production Environment Configuration

python
import os

# Environment variable configuration
agb = AGB()

# Custom configuration
from agb.config import Config
config = Config(
    endpoint="your-custom-endpoint.com",
    timeout_ms=60000,
)
agb = AGB(cfg=config)