Welcome to Lemo Docs

This guide will walk you through the process of installing and using Lemo on your system.

Prerequisites

Before installing Lemo, ensure you have the following prerequisites:

  • node.js and npm
  • pipx - If you don't have this installed, visit pipx installation guide
  • API Key (just one is required):
    • Anthropic API Key
    • OpenAI API Key

Note: Windows support is currently in development. We welcome contributions to help improve Windows compatibility!

Installation Steps

1. Ensure pipx Path

First, ensure the directory where pipx stores apps is in your PATH environment variable:

pipx ensurepath

2. Install Backend

Install the Lemo agent backend using pipx:

pipx install lemo_agent

3. Install and Run UI

Install and run the main UI using npx:

npx lemo-ui

That's it! You're ready to start using Lemo.

Updating Lemo

If you already have Lemo installed, you can update it using:

pipx install --force lemo_agent

Terminal UI Installation (Optional)

If you prefer using the terminal interface:

  1. Install the terminal UI:
    npm install -g lemo-tui
  2. Set your API key as an environment variable:
    # For Anthropic
export ANTHROPIC_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

# OR for OpenAI
export OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

# OR for Groq
export GROQ_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  3. Run the terminal UI:
    lemo-tui

To update the terminal UI:

npm uninstall -g lemo-tui
npm install -g lemo-tui

Running in Debug Mode

To run in debug mode:

lemo-tui --debug

Local Model Support (Experimental)

To run with a local model:

  1. Get deepseek running with ollama
  2. Start the local ollama server:
    ollama run deepseek-coder:6.7b
  3. Configure Lemo:
    lemo-tui configure
# Select "ollama/deepseek-coder:6.7b" from the model options
  4. Run with local configuration:
    lemo-tui --api_key=FOSS

Warning: Local model support is currently experimental. Expect reduced performance compared to cloud-based models.

Troubleshooting

If you encounter any issues during installation:

  • Ensure all prerequisites are properly installed
  • Check that your API key is valid and properly set
  • For terminal UI issues, try a clean reinstall:
    npm uninstall -g lemo-tui
npm install -g lemo-tui

Next Steps

  • Check out the Quick Start Guide to begin using Lemo
  • Review the Configuration Guide to customize your setup
  • Explore the Features Overview to learn about Lemo capabilities