flama

(β˜… 296)

The production framework for Predictive and Generative AI. Serve any model as an API in one line, with OpenAI/Anthropic/Ollama-compatible endpoints, a built-in chat UI, and native MCP.

  • .gitignore
  • .pre-commit-config.yaml
  • Cargo.lock
  • Cargo.toml
  • CHANGELOG.md
  • commitlint.config.mjs
  • CONTRIBUTORS.md
  • LICENSE
  • Makefile
  • pyproject.toml
  • README.md
  • release.config.js
  • SECURITY.md
  • SUPPORT.md
  • uv.lock

# Installation Guide

1. Get the code
git clone https://github.com/vortico/flama

Downloads the entire project code from GitHub to your computer.

cd flama

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install flama

Installs the package published on PyPI directly β€” no need to clone the source.

pip install "flama[pydantic]" # schema validation (also: typesystem, marshmallow)

Installs the package published on PyPI directly β€” no need to clone the source.

pip install "flama[database]" # SQLAlchemy-backed resources

Installs the package published on PyPI directly β€” no need to clone the source.

pip install "flama[llm]" # generative AI serving (vLLM on Linux, MLX on Apple Silicon)

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker build -f Dockerfiles/slim/Dockerfile -t flama .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 flama

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install flama

Installs the package published on PyPI directly β€” no need to clone the source.

pip install "flama[pydantic]" # schema validation (also: typesystem, marshmallow)

Installs the package published on PyPI directly β€” no need to clone the source.

pip install "flama[database]" # SQLAlchemy-backed resources

Installs the package published on PyPI directly β€” no need to clone the source.

pip install "flama[llm]" # generative AI serving (vLLM on Linux, MLX on Apple Silicon)

Installs the package published on PyPI directly β€” no need to clone the source.

pip install "flama[full]" # everything

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

5. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo build --release

Compiles the Rust project.

cargo run

Builds and then immediately runs the program.

βœ… If cargo build finishes without errors, it worked. The executable is created under target/.

6. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation