Reading the repo
Opening the box…
Reading the repo
Opening the box…
Assembly instructions
The Open Source Trading Ecosystem for Everyone.
Saved setup from 12 h ago
Will it work on macOS?
Connect your algo strategies and run from any platform:
/download)Receive your strategy alerts directly to Telegram for all platforms.
Also: Docs ↗
The maintainers included start.sh. Run it from the cloned folder after reading it.
bash start.sh
INSTALL.mdThe maintained installation instructions live under docs/:
Install Git, Python 3.12 or newer, and uv, then run:
git clone --filter=blob:none https://github.com/marketcalls/openalgo.git
cd openalgo
uv run app.py
Open http://127.0.0.1:5000, create your administrator account, sign in and
configure your broker at Select Broker → Configure. A fresh checkout creates
.env with unique installation secrets on first start. Keep those secrets with
the database when upgrading or restoring an existing instance.
The main branch includes the CI-built React frontend. Node.js is needed only
for frontend development. Use the version required by frontend/package.json
and run frontend commands inside frontend/:
cd frontend
npm ci
npm run dev
Use the deployment guides for production. Both supported Gunicorn workers use exactly one worker process; eventlet is the default and gthread is opt-in. The development command above uses normal threading.
Then run bash setup.sh. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.
Compare yours with the README's “Supported Platforms” list above before installing anything.
Needs Git: xcode-select --install
git clone https://github.com/marketcalls/openalgo.git cd openalgo
Python >=3.12
brew install uv
uv sync
uv run flask run
uv run pytest
OpenAlgo uses the modern uv package manager for faster, more reliable installations:
# Clone the repository
git clone --filter=blob:none https://github.com/marketcalls/openalgo.git
cd openalgo
# Install UV package manager
pip install uv
# Run the application using UV
uv run app.py
On the first start OpenAlgo creates .env with new security keys and no broker;
sign in and add your broker keys in Broker Configuration. To keep the broker in
.env instead, copy .sample.env to .env and fill in the broker lines first.
The application will be available at http://127.0.0.1:5000
For detailed installation instructions, deployment options (Docker, AWS, etc.), and configuration guides, visit docs.openalgo.in/installation-guidelines/getting-started
No reports for macOS yet.
GitManual AI Agent reads the 8 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.