Skip to content

7.4 billion tokens per month. 34 free LLM providers. 635 free model endpoints. All behind one /v1 endpoint, plus any custom OpenAI-compatible endpoint. Smart routing, automatic failover, encrypted keys. Personal experimentation only.

TypeScript

docs: Windows/PowerShell setup equivalents + native build prereqs (#434) (#425)

phoenix2c44cc1d23c6
diff --git a/README.md b/README.md
index 2b91d21e..c3e15ad2 100644
--- a/README.md
+++ b/README.md
@@ -140,6 +140,7 @@ On Windows, the easiest path is the desktop **[`.exe` installer from Releases](h
**Prerequisites:** Docker, Docker Compose, OpenSSL.
+*On macOS / Linux (Bash):*
```bash
git clone https://github.com/tashfeenahmed/freellmapi.git
cd freellmapi
@@ -151,6 +152,18 @@ printf "ENCRYPTION_KEY=%s\nPORT=3001\n" "$ENCRYPTION_KEY" > .env
docker compose up -d
```
+*On Windows (PowerShell):*
+```powershell
+git clone https://github.com/tashfeenahmed/freellmapi.git
+cd freellmapi
+
+$Bytes = New-Object Byte[] 32
+[Security.Cryptography.RandomNumberGenerator]::Create().GetBytes($Bytes)
+$ENCRYPTION_KEY = -join ($Bytes | ForEach-Object { "{0:x2}" -f $_ })
+"ENCRYPTION_KEY=$ENCRYPTION_KEY`nPORT=3001" | Out-File -Encoding utf8 .env
+docker compose up -d
+```
+
Open http://localhost:3001, add your provider keys on the **Keys** page, reorder the **Fallback Chain** to taste, and grab your unified API key from the **Keys** page header. That unified key is what you point your OpenAI SDK at.
Your fresh install ships with the free catalog snapshot (82 models today) and keeps itself updated from there. Everything the live feed adds on top is listed at [freellmapi.co/models](https://freellmapi.co/models.html).
@@ -167,6 +180,7 @@ Your fresh install ships with the free catalog snapshot (82 models today) and ke
**Prerequisites:** Node.js 20+, npm.
+*On macOS / Linux (Bash):*
```bash
git clone https://github.com/tashfeenahmed/freellmapi.git
cd freellmapi
@@ -177,6 +191,17 @@ printf "ENCRYPTION_KEY=%s\nPORT=3001\n" "$ENCRYPTION_KEY" > .env
npm run dev
```
+*On Windows (PowerShell):*
+```powershell
+git clone https://github.com/tashfeenahmed/freellmapi.git
+cd freellmapi
+npm install
+Copy-Item .env.example .env
+$ENCRYPTION_KEY = node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"
+"ENCRYPTION_KEY=$ENCRYPTION_KEY`nPORT=3001" | Out-File -Encoding utf8 .env
+npm run dev
+```
+
`ENCRYPTION_KEY` is required for startup. The server only falls back to a
database-stored development key when `DEV_MODE=true` and `NODE_ENV` is not
`production`; do not use that fallback with real provider keys.
@@ -284,10 +309,13 @@ request stats.
**[Download from Releases](https://github.com/tashfeenahmed/freellmapi/releases/latest)** — the macOS `.dmg` and the Windows `.exe` installer are built and attached to every release by the [`desktop-release`](.github/workflows/desktop-release.yml) workflow. Or build it from this repo in a few minutes:
+> **Note for Windows users building from source:** Building the desktop app requires compiling native SQLite modules for Electron. You must have [Visual Studio Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/) installed (specifically the "Desktop development with C++" workload) and Python installed before running `npm install`.
+
```bash
npm install
-npm run desktop:dist # macOS → desktop/dist-electron/FreeLLMAPI-…-arm64.dmg
-npm run desktop:dist:win # Windows → "desktop/dist-electron/FreeLLMAPI Setup ….exe"
+npm install --prefix desktop # install desktop dependencies
+npm run desktop:dist # macOS → desktop/dist-electron/FreeLLMAPI-…-arm64.dmg
+npm run desktop:dist:win # Windows → "desktop/dist-electron/FreeLLMAPI Setup ….exe"
```
> Locally built apps are unsigned, so Windows SmartScreen may warn on first run
@@ -605,12 +633,20 @@ Claude model names map to your free pool on the **Keys → Anthropic** tab: each
**Claude Code** — point it at your server and start it:
+*On macOS / Linux (Bash):*
```bash
export ANTHROPIC_BASE_URL=http://localhost:3001
export ANTHROPIC_AUTH_TOKEN=freellmapi-your-unified-key # NOT ANTHROPIC_API_KEY
claude
```
+*On Windows (PowerShell):*
+```powershell
+$env:ANTHROPIC_BASE_URL="http://localhost:3001"
+$env:ANTHROPIC_AUTH_TOKEN="freellmapi-your-unified-key"
+claude
+```
+
> Use `ANTHROPIC_AUTH_TOKEN` (sent as a Bearer token), **not** `ANTHROPIC_API_KEY` — Claude Code treats a set `ANTHROPIC_API_KEY` as a conflicting first-party credential and refuses to start.
## Screenshots
diff --git a/desktop/README.md b/desktop/README.md
index 0972c96c..6c2cf108 100644
--- a/desktop/README.md
+++ b/desktop/README.md
@@ -22,8 +22,9 @@ From the **repo root** (one-time client build + package):
```bash
npm install
-npm run desktop:dist # macOS → desktop/dist-electron/FreeLLMAPI-…-arm64.dmg
-npm run desktop:dist:win # Windows → desktop/dist-electron/FreeLLMAPI-…-x64 installer
+npm install --prefix desktop # install desktop dependencies
+npm run desktop:dist # macOS → desktop/dist-electron/FreeLLMAPI-…-arm64.dmg
+npm run desktop:dist:win # Windows → desktop/dist-electron/FreeLLMAPI-…-x64 installer
```
> Locally built apps don't carry the macOS quarantine attribute or Windows