Installation Guide
Get CodeFlow Engine up and running in minutes. Choose your preferred installation method.
Quick Install (Recommended)
Use our automated installation script for the fastest setup:
curl -fsSL https://raw.githubusercontent.com/JustAGhosT/codeflow-engine/main/install.sh | bashDocker Installation
Run CodeFlow Engine in a containerized environment:
# Pull the image
docker pull ghcr.io/justaghost/codeflow-engine:latest# Run the container
docker run -p 8000:8000 ghcr.io/justaghost/codeflow-engine:latestPython Installation
Install from PyPI using pip:
pip install codeflow-engine# Or using Poetry
poetry add codeflow-engineGitHub App Setup
Configure CodeFlow Engine as a GitHub App:
- Create a new GitHub App in your organization settings
- Set the webhook URL to your CodeFlow Engine instance
- Configure the required permissions (read/write access to PRs and issues)
- Install the app on your repositories
- Configure environment variables in your CodeFlow Engine instance
Need Help?
Check out our documentation or open an issue on GitHub.