Skip to content

getting-started.md

Latest commit

 

History

History
57 lines (43 loc) · 1.23 KB

getting-started.md

File metadata and controls

57 lines (43 loc) · 1.23 KB
Raw

🚀 Getting Started

📋 Requirements

  • Docker: Docker 20.10+ and Docker Compose
  • Local Node: Node.js 18+, plus OpenCode CLI

🏁 Docker Deploy (Recommended)

git clone https://github.com/TiaraBasori/opencode2api.git
cd opencode2api
cp .env.example .env        # Edit .env, API_KEY and OPENCODE_SERVER_PASSWORD are required
docker compose up -d

💻 Local Node Deploy

# Install OpenCode CLI
npm install -g opencode-ai@1.19.0
# Or curl -fsSL https://opencode.ai/install | bash

git clone https://github.com/TiaraBasori/opencode2api.git
cd opencode2api
npm install
cp config.json.example config.json
npm start

✅ Verify

# Health check
curl http://127.0.0.1:10000/health

# List models
curl -H "Authorization: Bearer $API_KEY" http://127.0.0.1:10000/v1/models

💡 Quick Test

curl -X POST http://127.0.0.1:10000/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "opencode/big-pickle",
    "messages": [{"role": "user", "content": "hi"}],
    "stream": false
  }'

➡️ Next Steps