Files

gnanam1990 aac326fa3f docs(setup): add beginner and advanced guides

Split the setup documentation into a simple beginner path and a separate advanced path. Add OS-specific quick starts for Windows and macOS/Linux so non-technical users can copy and paste the right commands without sorting through Bun and source-build instructions.

2026-04-02 18:09:04 +05:30

1.7 KiB

Raw Blame History

OpenClaude Quick Start for Windows

This guide uses Windows PowerShell.

1. Install Node.js

Install Node.js 20 or newer from:

https://nodejs.org/

Then open PowerShell and check it:

node --version
npm --version

2. Install OpenClaude

npm install -g @gitlawb/openclaude

3. Pick One Provider

Option A: OpenAI

Replace sk-your-key-here with your real key.

$env:CLAUDE_CODE_USE_OPENAI="1"
$env:OPENAI_API_KEY="sk-your-key-here"
$env:OPENAI_MODEL="gpt-4o"

openclaude

Option B: DeepSeek

$env:CLAUDE_CODE_USE_OPENAI="1"
$env:OPENAI_API_KEY="sk-your-key-here"
$env:OPENAI_BASE_URL="https://api.deepseek.com/v1"
$env:OPENAI_MODEL="deepseek-chat"

openclaude

Option C: Ollama

Install Ollama first from:

https://ollama.com/download/windows

Then run:

ollama pull llama3.1:8b

$env:CLAUDE_CODE_USE_OPENAI="1"
$env:OPENAI_BASE_URL="http://localhost:11434/v1"
$env:OPENAI_MODEL="llama3.1:8b"

openclaude

No API key is needed for Ollama local models.

4. If `openclaude` Is Not Found

Close PowerShell, open a new one, and try again:

openclaude

5. If Your Provider Fails

Check the basics:

For OpenAI or DeepSeek

make sure the key is real
make sure you copied it fully

For Ollama

make sure Ollama is installed
make sure Ollama is running
make sure the model was pulled successfully

6. Updating OpenClaude

npm install -g @gitlawb/openclaude@latest

7. Uninstalling OpenClaude

npm uninstall -g @gitlawb/openclaude

Need Advanced Setup?

Use:

Advanced Setup

1.7 KiB Raw Blame History