Reading the repo
Reading the repo
How to install on macOS
FreeToken brings datacenter-scale model serving to your desktop. Run massive models locally, fast and efficiently.
Saved setup from 9 h ago
The maintainers included install.sh. Run it from the cloned folder after reading it.
bash install.sh
Will it work on my device?
docs/install.mdAMD users: see the AMD ROCm installation guide (WIP).
pip + venv works too)uv venv && source .venv/bin/activate
uv pip install "freetoken[accel]"
CUDA kernels are JIT-compiled on first use, need a CUDA 13 toolkit with nvcc on PATH.
git clone https://github.com/FlashML-org/FreeToken.git && cd FreeToken
uv venv && source .venv/bin/activate
uv pip install -e ".[accel]"
Every night main is built into a wheel pair on the rolling
nightly release:
the freetoken runtime (CPython 3.12, Linux x86_64) and the matching
freetoken-kernel-cache with FreeToken's own CUDA kernels prebuilt.
Install both from the URLs on that release page:
uv pip install \
"freetoken[accel] @ https://github.com/FlashML-org/FreeToken/releases/download/nightly/<runtime wheel>" \
"https://github.com/FlashML-org/FreeToken/releases/download/nightly/<kernel-cache wheel>"
Filenames carry a +g<sha> build stamp and change every night, and the nightly
tag moves with them. Pin a wheel URL, never the tag. A local copy of the tag goes
stale: git fetch leaves it alone and git fetch --tags refuses to overwrite it;
refresh it with git fetch --force origin tag nightly. engine-linux_x86_64.json
next to the wheels names the current pair for scripts.
source .venv/bin/activate
ft --version
ft serve --model ~/path/to/Qwen3.6-35B-A3B
curl http://127.0.0.1:1919/v1/chat/completions -H 'Content-Type: application/json' \
-d '{"model":"Qwen3.6-35B-A3B","messages":[{"role":"user","content":"hi"}]}'
Then head to quickstart.md.
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.
Needs Git: xcode-select --install
git clone https://github.com/FlashML-org/FreeToken.git cd FreeToken
Python >=3.10
brew install python@3.10
python -m venv .venv source .venv/bin/activate pip install -e .
pytest
Download FreeToken for Windows or Linux at flashml.ai. It sets the engine up for you and gives you a GUI for running models, chatting, and tuning the engine.
<div align="center"> <img alt="FreeToken Desktop" src="https://raw.githubusercontent.com/FlashML-org/FreeToken/main/assets/desktop-console.png" width=92%> </div>Install FreeToken with uv (recommended) or pip:
uv pip install "freetoken[accel]"
Or build from source:
git clone https://github.com/FlashML-org/FreeToken.git && cd FreeToken
uv venv && source .venv/bin/activate
uv pip install -e ".[accel]"
For More details:
No reports for macOS yet.
Opens a chat with this manual already filled in, for macOS. It uses your own account; gitmanual sends nothing.