Installation Guide#

MetaBeeAI can be installed using pip, simply run:

pip install metabeeai

Post-Installation Setup#

After installation, set up your configuration:

  1. Create a configuration file:

    # Copy the example config to get started
    cp config.example.yaml config.yaml
    
  2. Set up API keys (required for most operations):

    You can set API keys via environment variables:

    export OPENAI_API_KEY=sk-your-openai-key
    export LANDING_AI_API_KEY=your-landing-ai-key
    

    Or add them to a .env file in your project directory:

    # .env
    OPENAI_API_KEY=sk-your-openai-key
    LANDING_AI_API_KEY=your-landing-ai-key
    

    Note: The configuration file takes precedence over environment variables. See the Configuration Guide for details on the hierarchy.

  3. Verify installation:

    metabeeai --help
    

For complete configuration options, see the Configuration Guide.

Development Installation#

To install MetaBeeAI for development, clone the repository and install the package in editable mode:

git clone https://github.com/MetaBeeAI/MetaBeeAI
cd MetaBeeAI
pip install -e .[dev]