Initial Setup - Sentinel Framework
Description: The Agentic AI Framework for Python.

Skip to content

# Initial Setup & Configuration

Antilogix is designed to get you up and running with a production-ready AI agent in under 5 minutes.

## 1. Installation

Install the framework from PyPI:

    pip install antilogix

## 2. Create a New Project

Antilogix includes a CLI tool to scaffold your application structure. Run the following command to create a new agent:

    antilogix new my_agent_app
    cd my_agent_app

This will create the following structure:

- app/: Your source code (agents, API routes, workflows).
- config/: Configuration files.
- .env: API keys and secrets.
- sentinel.yaml: Main configuration file.
- main.py: The entry point for your application.

## 3. Configuration (sentinel.yaml)

The behavior of your agent is controlled by sentinel.yaml. You can configure your LLM provider, debug mode, and application settings here.

    app_name: "My Antilogix Agent"
    version: "1.0.0"
    debug: true

    # Brain Configuration (LLM)
    llm:
      provider: "openai"  # Options: "openai", "gemini", "ollama"
      model: "gpt-4o"
      temperature: 0.7
      # base_url: "..." # Optional: For local LLMs or proxies

    # Memory Configuration
    memory:
      provider: "mem0"
      user_id: "default_user"

## 4. Environment Variables (.env)

Never commit API keys to version control. Antilogix automatically loads variables from the .env file in your project root.

Example .env:

```Ini, TOML

# OpenAI Key

OPENAI_API_KEY=sk-proj-...

# Google Gemini Key

GEMINI_API_KEY=AIzaSy...

# Mem0 Key (Optional - for long-term memory)

MEM0_API_KEY=m0-xxx...

    ## 5. Running the App

    Start the server using the entry point:

    ```Bash
    python main.py

- API: http://127.0.0.1:8000

- Dashboard: http://127.0.0.1:8000/dashboard

- Documentation: http://127.0.0.1:8000/framework-docs/