Quick Start

1. Clone the Repository

git clone https://github.com/AnthusAI/Plexus.git
cd Plexus

2. Set Up Python Environment

Create and activate a virtual environment (recommended):

# Create virtual environment
python -m venv venv

# Activate virtual environment
# On macOS/Linux:
source venv/bin/activate
# On Windows:
venv\Scripts\activate

3. Install Plexus

Install Plexus in development mode:

pip install -e .

The -e flag installs in "editable" mode, allowing you to modify the code and see changes immediately.

4. Set Up Configuration

Create your configuration directory and copy the example file:

# Create configuration directory
mkdir -p .plexus

# Copy example configuration
cp plexus.yaml.example .plexus/config.yaml

Edit .plexus/config.yaml with your specific settings. See the Configuration Files guide for detailed instructions.

5. Verify Installation

Test that everything is working:

# Check Plexus version
plexus --help

# Test configuration loading (requires valid credentials)
plexus item last

Command Not Found

If you get a "command not found" error when running plexus:

• Make sure your virtual environment is activated
• Verify the installation with pip list | grep plexus
• Try reinstalling with pip install -e .

Missing Credentials

If you get AWS credentials errors, make sure your .plexus/config.yaml file contains valid AWS credentials and API keys. See the Configuration Files guide for details.