passepartout/docs/quickstart.org

Quickstart Guide: The Road to Sovereignty

• 1. Introduction
• 2. Prerequisites
• 3. Installation & Enclosure
  • Step 1: Clone the Sovereignty
  • Step 2: Secret Configuration
  • Step 3: Launch the Image
• 4. Interaction Gateways
  • Gateway A: Emacs (Harness Protocol)
  • Gateway B: External Sensors
• 5. Verification (The Chaos Check)
• 6. Next Steps

1. Introduction

Welcome to org-agent, the "Executive Soul" of your personal OS. This guide will help you set up and interact with your first neurosymbolic agent.

2. Prerequisites

Before launching the harness, ensure your host environment has:

• Docker & Docker Compose: The primary enclosure for the Lisp Machine.
• LLM API Keys: At least one key for Gemini, Anthropic, or OpenAI.
• Emacs (Optional): For the full literate experience via org-agent.el.

3. Installation & Enclosure

Step 1: Clone the Sovereignty

git clone https://github.com/amr/org-agent.git
cd org-agent

Step 2: Secret Configuration

Copy the example environment file and add your keys.

cp .env.example .env
# Edit .env with your favorite editor

Step 3: Launch the Image

This will build the SBCL environment and start the Micro-Loader.

docker-compose up --build -d

4. Interaction Gateways

Once the harness is "Ready", you can interact with it via multiple sensors.

Gateway A: Emacs (Harness Protocol)

If you have configured the org-agent package in Emacs:

1. Open a chat buffer: M-x org-agent-chat-open.
2. Send: "Are you online, agent?"

Gateway B: External Sensors

If you enabled Signal or Telegram in .env, send a message directly to your bot.

5. Verification (The Chaos Check)

To ensure the harness is fully healthy, check the logs for the Micro-Loader summary:

docker-compose logs -f org-agent

Look for: LOADER: Boot Complete. [Ready: 34] [Failed: 0]

6. Next Steps

• Extend the Brain: Read the Skill Creation Guide to add custom Lisp skills.
• Deep Dive: Explore the literate/ directory to understand the harness's architecture.