|
|
||
|---|---|---|
| .claude | ||
| .github | ||
| docs | ||
| kiro | ||
| systemd | ||
| tests | ||
| web | ||
| .clabot | ||
| .dockerignore | ||
| .env.example | ||
| .gitignore | ||
| AGENTS.md | ||
| app_icon.icns | ||
| app_icon.ico | ||
| build.spec | ||
| build_mac.sh | ||
| build_win.bat | ||
| CLA.md | ||
| CLAUDE.md | ||
| CONTRIBUTING.md | ||
| CONTRIBUTORS.md | ||
| docker-compose.yml | ||
| Dockerfile | ||
| gui.py | ||
| LICENSE | ||
| main.py | ||
| manual_api_test.py | ||
| pytest.ini | ||
| README.md | ||
| requirements.txt | ||
| run.sh | ||
| start.sh | ||
| stop.sh | ||
👻 Kiro Gateway
Proxy gateway for Kiro API (Amazon Q Developer / AWS CodeWhisperer)
🇷🇺 Русский • 🇨🇳 中文 • 🇪🇸 Español • 🇮🇩 Indonesia • 🇧🇷 Português • 🇯🇵 日本語 • 🇰🇷 한국어
Made with ❤️ by @Jwadow
Use Claude models from Kiro with Claude Code, OpenCode, Codex app, Cursor, Cline, Roo Code, Kilo Code, Obsidian, OpenAI SDK, LangChain, Continue and other OpenAI or Anthropic compatible tools
Models • Features • Quick Start • Configuration • 💖 Sponsor
🤖 Available Models
⚠️ Important: Model availability depends on your Kiro tier (free/paid). The gateway provides access to whatever models are available in your IDE or CLI based on your subscription. The list below shows models commonly available on the free tier.
🔒 Claude Opus 4.5 was removed from the free tier on January 17, 2026. It may be available on paid tiers — check your IDE/CLI model list.
🚀 Claude Sonnet 4.5 — Balanced performance. Great for coding, writing, and general-purpose tasks.
⚡ Claude Haiku 4.5 — Lightning fast. Perfect for quick responses, simple tasks, and chat.
📦 Claude Sonnet 4 — Previous generation. Still powerful and reliable for most use cases.
📦 Claude 3.7 Sonnet — Legacy model. Available for backward compatibility.
🐋 DeepSeek-V3.2 — Open MoE model (685B params, 37B active). Balanced performance for coding, reasoning, and general tasks.
🧩 MiniMax M2.1 — Open MoE model (230B params, 10B active). Great for complex tasks, planning, and multi-step workflows.
🤖 Qwen3-Coder-Next — Open MoE model (80B params, 3B active). Coding-focused. Excellent for development and large projects.
💡 Smart Model Resolution: Use any model name format —
claude-sonnet-4-5,claude-sonnet-4.5, or even versioned names likeclaude-sonnet-4-5-20250929. The gateway normalizes them automatically.
✨ Features
| Feature | Description |
|---|---|
| 🔌 OpenAI-compatible API | Works with any OpenAI-compatible tool |
| 🔌 Anthropic-compatible API | Native /v1/messages endpoint |
| 🌐 VPN/Proxy Support | HTTP/SOCKS5 proxy for restricted networks |
| 🧠 Extended Thinking | Reasoning is exclusive to our project |
| 👁️ Vision Support | Send images to model |
| 🛠️ Tool Calling | Supports function calling |
| 💬 Full message history | Passes complete conversation context |
| 📡 Streaming | Full SSE streaming support |
| 🔄 Retry Logic | Automatic retries on errors (403, 429, 5xx) |
| 📋 Extended model list | Including versioned models |
| 🔐 Smart token management | Automatic refresh before expiration |
🚀 Quick Start
Choose your deployment method:
- 🐍 Native Python - Full control, easy debugging
- 🐳 Docker - Isolated environment, easy deployment → jump to Docker
Prerequisites
- Python 3.10+
- One of the following:
Installation
# Clone the repository (requires Git)
git clone https://github.com/qinqiang2000/kiro-gateway.git
cd kiro-gateway
# Or download ZIP: Code → Download ZIP → extract → open kiro-gateway folder
# Install dependencies
pip install -r requirements.txt
# Configure (see Configuration section)
cp .env.example .env
# Copy and edit .env with your credentials
# Start the server
python main.py
# Or with custom port (if 8000 is busy)
python main.py --port 9000
The server will be available at http://localhost:8000
⚙️ Configuration
Option 1: JSON Credentials File (Kiro IDE / Enterprise)
Specify the path to the credentials file:
Works with:
- Kiro IDE (standard) - for personal accounts
- Enterprise - for corporate accounts with SSO
KIRO_CREDS_FILE="~/.aws/sso/cache/kiro-auth-token.json"
# Password to protect YOUR proxy server (make up any secure string)
# You'll use this as api_key when connecting to your gateway
PROXY_API_KEY="my-super-secret-password-123"
📄 JSON file format
{
"accessToken": "eyJ...",
"refreshToken": "eyJ...",
"expiresAt": "2025-01-12T23:00:00.000Z",
"profileArn": "arn:aws:codewhisperer:us-east-1:...",
"region": "us-east-1",
"clientIdHash": "abc123..." // Optional: for corporate SSO setups
}
Note: If you have two JSON files in
~/.aws/sso/cache/(e.g.,kiro-auth-token.jsonand a file with a hash name), usekiro-auth-token.jsoninKIRO_CREDS_FILE. The gateway will automatically load the other file.
Option 2: Environment Variables (.env file)
Create a .env file in the project root:
# Required
REFRESH_TOKEN="your_kiro_refresh_token"
# Password to protect YOUR proxy server (make up any secure string)
PROXY_API_KEY="my-super-secret-password-123"
# Optional
PROFILE_ARN="arn:aws:codewhisperer:us-east-1:..."
KIRO_REGION="us-east-1"
Option 3: AWS SSO Credentials (kiro-cli / Enterprise)
If you use kiro-cli or Kiro IDE with AWS SSO (AWS IAM Identity Center), the gateway will automatically detect and use the appropriate authentication.
Works with both free Builder ID accounts and corporate accounts.
KIRO_CREDS_FILE="~/.aws/sso/cache/your-sso-cache-file.json"
# Password to protect YOUR proxy server
PROXY_API_KEY="my-super-secret-password-123"
# Note: PROFILE_ARN is NOT needed for AWS SSO (Builder ID and corporate accounts)
# The gateway will work without it
📄 AWS SSO JSON file format
AWS SSO credentials files (from ~/.aws/sso/cache/) contain:
{
"accessToken": "eyJ...",
"refreshToken": "eyJ...",
"expiresAt": "2025-01-12T23:00:00.000Z",
"region": "us-east-1",
"clientId": "...",
"clientSecret": "..."
}
Note: AWS SSO (Builder ID and corporate accounts) users do NOT need profileArn. The gateway will work without it (if specified, it will be ignored).
🔍 How it works
The gateway automatically detects the authentication type based on the credentials file:
-
Kiro Desktop Auth (default): Used when
clientIdandclientSecretare NOT present- Endpoint:
https://prod.{region}.auth.desktop.kiro.dev/refreshToken
- Endpoint:
-
AWS SSO (OIDC): Used when
clientIdandclientSecretARE present- Endpoint:
https://oidc.{region}.amazonaws.com/token
- Endpoint:
No additional configuration is needed — just point to your credentials file!
Option 4: kiro-cli SQLite Database
If you use kiro-cli and prefer to use its SQLite database directly:
KIRO_CLI_DB_FILE="~/.local/share/kiro-cli/data.sqlite3"
# Password to protect YOUR proxy server
PROXY_API_KEY="my-super-secret-password-123"
# Note: PROFILE_ARN is NOT needed for AWS SSO (Builder ID and corporate accounts)
# The gateway will work without it
📄 Database locations
| CLI Tool | Database Path |
|---|---|
| kiro-cli | ~/.local/share/kiro-cli/data.sqlite3 |
| amazon-q-developer-cli | ~/.local/share/amazon-q/data.sqlite3 |
The gateway reads credentials from the auth_kv table which stores:
kirocli:odic:tokenorcodewhisperer:odic:token— access token, refresh token, expirationkirocli:odic:device-registrationorcodewhisperer:odic:device-registration— client ID and secret
Both key formats are supported for compatibility with different kiro-cli versions.
Getting Credentials
For Kiro IDE users:
- Log in to Kiro IDE and use Option 1 above (JSON credentials file)
- The credentials file is created automatically after login
For Kiro CLI users:
- Log in with
kiro-cli loginand use Option 3 or Option 4 above - No manual token extraction needed!
🔧 Advanced: Manual token extraction
If you need to manually extract the refresh token (e.g., for debugging), you can intercept Kiro IDE traffic:
- Look for requests to:
prod.us-east-1.auth.desktop.kiro.dev/refreshToken
🐳 Docker Deployment
Docker-based deployment. Prefer native Python? See Quick Start above.
Quick Start
# 1. Clone and configure
git clone https://github.com/qinqiang2000/kiro-gateway.git
cd kiro-gateway
cp .env.example .env
# Edit .env with your credentials
# 2. Run with docker-compose
docker-compose up -d
# 3. Check status
docker-compose logs -f
curl http://localhost:8000/health
Docker Compose Configuration
Edit docker-compose.yml and uncomment volume mounts for your OS:
volumes:
# Kiro IDE credentials (choose your OS)
- ~/.aws/sso/cache:/home/kiro/.aws/sso/cache:ro # Linux/macOS
# - ${USERPROFILE}/.aws/sso/cache:/home/kiro/.aws/sso/cache:ro # Windows
# kiro-cli database (choose your OS)
- ~/.local/share/kiro-cli:/home/kiro/.local/share/kiro-cli:ro # Linux/macOS
# - ${USERPROFILE}/.local/share/kiro-cli:/home/kiro/.local/share/kiro-cli:ro # Windows
# Debug logs (optional)
- ./debug_logs:/app/debug_logs
Management Commands
docker-compose logs -f # View logs
docker-compose restart # Restart
docker-compose down # Stop
docker-compose pull && docker-compose up -d # Update
🔧 Building from Source
docker build -t kiro-gateway .
docker run -d -p 8000:8000 --env-file .env kiro-gateway
🖥️ Desktop GUI
A native desktop app that bundles the gateway server with a GUI dashboard. No terminal needed — just double-click to run.
Download
Pre-built binaries are available on the Releases page:
| Platform | File | Notes |
|---|---|---|
| Windows | KiroGateway-windows.zip |
Requires Windows 10+. Must extract the full zip before running |
| macOS | KiroGateway-macos.zip |
Requires macOS 10.15+. Extract and move Kiro Gateway.app to Applications |
⚠️ Windows users: Do NOT double-click the exe inside the zip. You must extract the entire zip first — the exe depends on the
_internal/folder next to it.
Run from Source
# Install additional dependency
pip install pywebview
# Launch GUI window
python gui.py
# Or specify a port
python gui.py --port 9000
# Server-only mode (no GUI window)
python gui.py --no-gui
What the GUI Does
- Auto-detects Kiro credentials (Kiro IDE, kiro-cli)
- Starts the gateway server on
127.0.0.1:8000 - Opens a native desktop window with the dashboard UI
- Automatically injects Claude CLI settings to route through the gateway
- Restores original Claude CLI settings on exit
Claude CLI Integration
When the GUI starts, it automatically configures ~/.claude/settings.json to point Claude CLI at the gateway. This means Claude Code will use Kiro models through the gateway without manual configuration.
Prerequisite: Claude CLI must be installed and run at least once (so ~/.claude/settings.json exists).
Build from Source
pip install pyinstaller pywebview
# On Windows, also: pip install pythonnet
pyinstaller build.spec --noconfirm
# Output: dist/KiroGateway/ (Windows) or dist/Kiro Gateway.app (macOS)
🌐 VPN/Proxy Support
For users in China, corporate networks, or regions with connectivity issues to AWS services.
The gateway supports routing all Kiro API requests through a VPN or proxy server. This is essential if you experience connection problems to AWS endpoints or need to use a corporate proxy.
Configuration
Add to your .env file:
# HTTP proxy
VPN_PROXY_URL=http://127.0.0.1:7890
# SOCKS5 proxy
VPN_PROXY_URL=socks5://127.0.0.1:1080
# With authentication (corporate proxies)
VPN_PROXY_URL=http://username:password@proxy.company.com:8080
# Without protocol (defaults to http://)
VPN_PROXY_URL=192.168.1.100:8080
Supported Protocols
- ✅ HTTP — Standard proxy protocol
- ✅ HTTPS — Secure proxy connections
- ✅ SOCKS5 — Advanced proxy protocol (common in VPN software)
- ✅ Authentication — Username/password embedded in URL
When You Need This
| Situation | Solution |
|---|---|
| Connection timeouts to AWS | Use VPN/proxy to route traffic |
| Corporate network restrictions | Configure your company's proxy |
| Regional connectivity issues | Use a VPN service with proxy support |
| Privacy requirements | Route through your own proxy server |
Popular VPN Software with Proxy Support
Most VPN clients provide a local proxy server you can use:
- Sing-box — Modern VPN client with HTTP/SOCKS5 proxy
- Clash — Usually runs on
http://127.0.0.1:7890 - V2Ray — Configurable SOCKS5/HTTP proxy
- Shadowsocks — SOCKS5 proxy support
- Corporate VPN — Check your IT department for proxy settings
Leave VPN_PROXY_URL empty (default) if you don't need proxy support.
📡 API Reference
Endpoints
| Endpoint | Method | Description |
|---|---|---|
/ |
GET | Health check |
/health |
GET | Detailed health check |
/v1/models |
GET | List available models |
/v1/chat/completions |
POST | OpenAI Chat Completions API |
/v1/messages |
POST | Anthropic Messages API |
💡 Usage Examples
OpenAI API
🔹 Simple cURL Request
curl http://localhost:8000/v1/chat/completions \
-H "Authorization: Bearer my-super-secret-password-123" \
-H "Content-Type: application/json" \
-d '{
"model": "claude-sonnet-4-5",
"messages": [{"role": "user", "content": "Hello!"}],
"stream": true
}'
Note: Replace
my-super-secret-password-123with thePROXY_API_KEYyou set in your.envfile.
🔹 Streaming Request
curl http://localhost:8000/v1/chat/completions \
-H "Authorization: Bearer my-super-secret-password-123" \
-H "Content-Type: application/json" \
-d '{
"model": "claude-sonnet-4-5",
"messages": [
{"role": "system", "content": "You are a helpful assistant."},
{"role": "user", "content": "What is 2+2?"}
],
"stream": true
}'
🛠️ With Tool Calling
curl http://localhost:8000/v1/chat/completions \
-H "Authorization: Bearer my-super-secret-password-123" \
-H "Content-Type: application/json" \
-d '{
"model": "claude-sonnet-4-5",
"messages": [{"role": "user", "content": "What is the weather in London?"}],
"tools": [{
"type": "function",
"function": {
"name": "get_weather",
"description": "Get weather for a location",
"parameters": {
"type": "object",
"properties": {
"location": {"type": "string", "description": "City name"}
},
"required": ["location"]
}
}
}]
}'
🐍 Python OpenAI SDK
from openai import OpenAI
client = OpenAI(
base_url="http://localhost:8000/v1",
api_key="my-super-secret-password-123" # Your PROXY_API_KEY from .env
)
response = client.chat.completions.create(
model="claude-sonnet-4-5",
messages=[
{"role": "system", "content": "You are a helpful assistant."},
{"role": "user", "content": "Hello!"}
],
stream=True
)
for chunk in response:
if chunk.choices[0].delta.content:
print(chunk.choices[0].delta.content, end="")
🦜 LangChain
from langchain_openai import ChatOpenAI
llm = ChatOpenAI(
base_url="http://localhost:8000/v1",
api_key="my-super-secret-password-123", # Your PROXY_API_KEY from .env
model="claude-sonnet-4-5"
)
response = llm.invoke("Hello, how are you?")
print(response.content)
Anthropic API
🔹 Simple cURL Request
curl http://localhost:8000/v1/messages \
-H "x-api-key: my-super-secret-password-123" \
-H "anthropic-version: 2023-06-01" \
-H "Content-Type: application/json" \
-d '{
"model": "claude-sonnet-4-5",
"max_tokens": 1024,
"messages": [{"role": "user", "content": "Hello!"}]
}'
Note: Anthropic API uses
x-api-keyheader instead ofAuthorization: Bearer. Both are supported.
🔹 With System Prompt
curl http://localhost:8000/v1/messages \
-H "x-api-key: my-super-secret-password-123" \
-H "anthropic-version: 2023-06-01" \
-H "Content-Type: application/json" \
-d '{
"model": "claude-sonnet-4-5",
"max_tokens": 1024,
"system": "You are a helpful assistant.",
"messages": [{"role": "user", "content": "Hello!"}]
}'
Note: In Anthropic API,
systemis a separate field, not a message.
📡 Streaming
curl http://localhost:8000/v1/messages \
-H "x-api-key: my-super-secret-password-123" \
-H "anthropic-version: 2023-06-01" \
-H "Content-Type: application/json" \
-d '{
"model": "claude-sonnet-4-5",
"max_tokens": 1024,
"stream": true,
"messages": [{"role": "user", "content": "Hello!"}]
}'
🐍 Python Anthropic SDK
import anthropic
client = anthropic.Anthropic(
api_key="my-super-secret-password-123", # Your PROXY_API_KEY from .env
base_url="http://localhost:8000"
)
# Non-streaming
response = client.messages.create(
model="claude-sonnet-4-5",
max_tokens=1024,
messages=[{"role": "user", "content": "Hello!"}]
)
print(response.content[0].text)
# Streaming
with client.messages.stream(
model="claude-sonnet-4-5",
max_tokens=1024,
messages=[{"role": "user", "content": "Hello!"}]
) as stream:
for text in stream.text_stream:
print(text, end="", flush=True)
🔧 Debugging
Debug logging is disabled by default. To enable, add to your .env:
# Debug logging mode:
# - off: disabled (default)
# - errors: save logs only for failed requests (4xx, 5xx) - recommended for troubleshooting
# - all: save logs for every request (overwrites on each request)
DEBUG_MODE=errors
Debug Modes
| Mode | Description | Use Case |
|---|---|---|
off |
Disabled (default) | Production |
errors |
Save logs only for failed requests (4xx, 5xx) | Recommended for troubleshooting |
all |
Save logs for every request | Development/debugging |
Debug Files
When enabled, requests are logged to the debug_logs/ folder:
| File | Description |
|---|---|
request_body.json |
Incoming request from client (OpenAI format) |
kiro_request_body.json |
Request sent to Kiro API |
response_stream_raw.txt |
Raw stream from Kiro |
response_stream_modified.txt |
Transformed stream (OpenAI format) |
app_logs.txt |
Application logs for the request |
error_info.json |
Error details (only on errors) |
📜 License
This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).
This means:
- ✅ You can use, modify, and distribute this software
- ✅ You can use it for commercial purposes
- ⚠️ You must disclose source code when you distribute the software
- ⚠️ Network use is distribution — if you run a modified version on a server and let others interact with it, you must make the source code available to them
- ⚠️ Modifications must be released under the same license
See the LICENSE file for the full license text.
Why AGPL-3.0?
AGPL-3.0 ensures that improvements to this software benefit the entire community. If you modify this gateway and deploy it as a service, you must share your improvements with your users.
Contributor License Agreement (CLA)
By submitting a contribution to this project, you agree to the terms of our Contributor License Agreement (CLA). This ensures that:
- You have the right to submit the contribution
- You grant the maintainer rights to use and relicense your contribution
- The project remains legally protected
💖 Support the Project
If this project saved you time or money, consider supporting it!
Every contribution helps keep this project alive and growing
🤑 Donate
☕ One-time Donation • 💎 Monthly Support
🪙 Or send crypto
| Currency | Network | Address |
|---|---|---|
| USDT | TRC20 | TSVtgRc9pkC1UgcbVeijBHjFmpkYHDRu26 |
| BTC | Bitcoin | 12GZqxqpcBsqJ4Vf1YreLqwoMGvzBPgJq6 |
| ETH | Ethereum | 0xc86eab3bba3bbaf4eb5b5fff8586f1460f1fd395 |
| SOL | Solana | 9amykF7KibZmdaw66a1oqYJyi75fRqgdsqnG66AK3jvh |
| TON | TON | UQBVh8T1H3GI7gd7b-_PPNnxHYYxptrcCVf3qQk5v41h3QTM |
⚠️ Disclaimer
This project is not affiliated with, endorsed by, or sponsored by Amazon Web Services (AWS), Anthropic, or Kiro IDE. Use at your own risk and in compliance with the terms of service of the underlying APIs.