Quick Start Guide

This guide will help you get started with Trinity Framework 2.0 Core quickly, setting up the basic components and creating agent workspaces.

Prerequisites

Linux or macOS operating system
Git installed
Node.js environment
Claude API access or Claude Pro subscription
Bash shell

Note: Trinity Framework 2.0 Core is not currently supported on Windows due to Claude Code limitations. It may work in WSL, but this is not officially supported.

Step 1: Clone the Repository

First, clone the Trinity Framework 2.0 Core repository:

git clone https://github.com/jlchatha/trinity-framework-core.git
cd trinity-framework-core

Step 2: Choose Your Setup Approach

The framework provides several setup options:

Option A: Create All Agent Workspaces (Recommended)

This will create workspaces for all three agent types:

$ chmod +x tools/setup/*.sh
$ ./tools/setup/create-workspaces.sh $(dirname $(pwd))

Option B: Create a Specific Agent Workspace

If you only need one agent type:

$ # For APEX agent
$ ./tools/setup/setup-apex.sh $(dirname $(pwd))/trinity-apex-workspace
$
$ # For ANALYST agent
$ ./tools/setup/setup-analyst.sh $(dirname $(pwd))/trinity-analyst-workspace
$
$ # For HISTORIAN agent
$ ./tools/setup/setup-historian.sh $(dirname $(pwd))/trinity-historian-workspace

Option C: Custom Location

If you want to specify a different location:

$ # Create all agent workspaces in a specific location
$ ./tools/setup/create-workspaces.sh ~/trinity-workspaces

Step 3: Verify Installation

After creating the workspaces, verify that everything is set up correctly:

$ # Verify APEX workspace
$ ./tools/setup/verify-installation.sh $(dirname $(pwd))/trinity-apex-workspace
$
$ # Verify ANALYST workspace
$ ./tools/setup/verify-installation.sh $(dirname $(pwd))/trinity-analyst-workspace
$
$ # Verify HISTORIAN workspace
$ ./tools/setup/verify-installation.sh $(dirname $(pwd))/trinity-historian-workspace

The verification script checks for required protocol files, directory structure, and basic functionality.

Step 4: Set Up Claude API Environment (Required)

Trinity Framework 2.0 Core requires Claude AI models. Set up your environment variable:

$ # Set your Claude API key
$ export CLAUDE_API_KEY=your_api_key_here

For persistent access, add this to your shell profile:

$ # Add to your ~/.bashrc or ~/.zshrc
$ echo 'export CLAUDE_API_KEY=your_api_key_here' >> ~/.bashrc
$ source ~/.bashrc

Step 5: Explore Your Workspace

Navigate to your new agent workspace and explore the structure:

$ # Example for APEX agent
$ cd $(dirname $(pwd))/trinity-apex-workspace
$ ls -la

You should see the core protocol files in the workspace root:

AGENT.md: Agent identity and role definition
STATUS.md: Current operational status
AUTO-COMPACT.md: Context management protocol

Step 6: Optional Context Management Setup

If you want to use the optional context management system:

$ # Install dependencies
$ cd tools/token-tracker/context-manager-v2/bin/setup
$ ./install-dependencies.sh

Context management helps track token usage and handle context limitations when working with Claude AI models.

Troubleshooting

Common Issues

Permission Denied: Make sure scripts are executable with chmod +x
Missing Dependencies: Ensure Node.js is installed
API Key Issues: Verify your Claude API key is correctly set

Next Steps

Now that you have set up your Trinity Framework 2.0 Core workspaces, you can:

Read the Agent Roles documentation to understand each agent's responsibilities
Learn about Context Resilience principles
Explore the AAR System for knowledge preservation
Set up Context Management for token tracking

← Back to Documentation Home