Quickstart: Run the Offline Demo

Use Python 3.12 or newer, Git and a new working directory. The commands below install the official stable v0.1.1 source tag. Create a virtual environment to keep this installation separate.

git clone https://github.com/Siyuan-chat/KabuForge.git
cd KabuForge
git checkout v0.1.1
python -m venv .venv
# Windows PowerShell
.venv\Scripts\Activate.ps1
# macOS / Linux: source .venv/bin/activate
python -m pip install .
kabuforge doctor
kabuforge demo --out output/demo
kabuforge factors
kabuforge strategies

This guide pins the stable v0.1.1 tag (package version 0.1.1). doctor reports the installed version, local capabilities, paper opt-in and disabled external actions. The synthetic offline demo needs no market-data key or broker account.

The demo creates fictional inputs and configuration files under output/demo. Inspect paper.json, backtest.json and timeline.json. These files describe a local simulation workflow; planned orders are not broker submissions.

Check python --version and that your virtual environment is active. If kabuforge is missing, reinstall using that environment’s python -m pip install .. Choose a new demo output directory. Preserve the error and inputs for an issue report.

Next: validate and simulate the demo, or install the desktop interface.

For current source-branch GUI research material, use main and treat package version 0.2.0rc1 as an unpublished candidate. It is separate from the stable v0.1.1 instructions above. See the main GUI courses.