Merge pull request #10 from dtinth/main

Add image support, allow setting a list of models, etc.

Author: missuo

.github/workflows/docker.yaml

@@ -34,6 +34,7 @@ jobs:
 
       - name: Login to DockerHub
         uses: docker/login-action@v2
+        if: env.DOCKER_USERNAME != ''
         with:
           registry: docker.io
           username: ${{ env.DOCKER_USERNAME }}
@@ -46,12 +47,21 @@ jobs:
           username: ${{ env.GHCR_USERNAME }}
           password: ${{ env.GHCR_TOKEN }}
 
+      - name: Set Docker Hub image flag
+        id: dockerhub_image
+        run: |
+          if [ -n "${{ env.DOCKER_USERNAME }}" ]; then
+            echo "enabled=true" >> $GITHUB_OUTPUT
+          else
+            echo "enabled=false" >> $GITHUB_OUTPUT
+          fi
+
       - name: Docker meta
         id: meta
         uses: docker/metadata-action@v4
         with:
           images: |
-            docker.io/${{ env.DOCKER_IMAGE_NAME }}
+            ${{ steps.dockerhub_image.outputs.enabled == 'true' && format('docker.io/{0}', env.DOCKER_IMAGE_NAME) || '' }}
             ghcr.io/${{ env.GHCR_IMAGE_NAME }}
           tags: |
             type=ref,event=tag

CLAUDE.md

@@ -0,0 +1,30 @@
+# Claude2OpenAI Development Guide
+
+## Build & Run Commands
+```bash
+# Build the application
+go build -o claude2openai .
+
+# Run locally (default port: 6600)
+./claude2openai
+
+# Run with custom port
+./claude2openai -p 8080
+
+# Docker build
+docker build -t claude2openai .
+
+# Docker run
+docker run -d --restart always -p 6600:6600 claude2openai
+```
+
+## Code Style Guidelines
+- **Naming**: Use camelCase for functions and variables
+- **Error Handling**: Return JSON responses with descriptive error messages and appropriate HTTP status codes
+- **Comments**: Add comments for non-obvious code sections, consider bilingual (English/Chinese) for key components
+- **Imports**: Group standard library imports separate from external dependencies
+- **Formatting**: Maintain consistent struct definitions with appropriate JSON tags
+- **Types**: Follow Go idioms with proper type definitions in types.go
+- **Structure**: Maintain separation between OpenAI and Claude data structures
+
+This project is a proxy service that converts Anthropic's Claude API to an OpenAI-compatible format.

README.md

@@ -4,6 +4,15 @@ Used to convert the Claude API to OpenAI compatible API. **Easily use Claude wit
 ## Compatibility
 Currently it is only compatible with the Claude-3 family of models, if you pass in any other model, the default will be to use **claude-3-5-haiku-20241022**.
 
+You can customize the list of allowed models by setting the `ALLOWED_MODELS` environment variable with a comma-separated list of model names. This is useful when new Claude models are released, allowing you to add support without rebuilding:
+
+```bash
+# Example: Setting custom allowed models
+export ALLOWED_MODELS="claude-3-5-haiku-20241022,claude-3-5-sonnet-20241022,claude-3-haiku-20240307"
+```
+
+The first model in the list will be used as the default model.
+
 ## Request Example
 ```bash
 curl http://127.0.0.1:6600/v1/chat/completions \
@@ -25,6 +34,54 @@ curl http://127.0.0.1:6600/v1/chat/completions \
   }'
 ```
 
+## Features
+
+### Image Support
+
+Claude2OpenAI supports images in the same format as OpenAI. You can include images in your messages using either base64-encoded images or URLs.
+
+```bash
+curl http://127.0.0.1:6600/v1/chat/completions \
+  -H "Content-Type: application/json" \
+  -H "Authorization: Bearer sk-ant-xxxxxxxxxxxxxxxx" \
+  -d '{
+    "model": "claude-3-5-sonnet-20241022",
+    "messages": [
+      {
+        "role": "user",
+        "content": [
+          {
+            "type": "text",
+            "text": "What's in this image?"
+          },
+          {
+            "type": "image_url",
+            "image_url": {
+              "url": "https://example.com/image.jpg"
+            }
+          }
+        ]
+      }
+    ]
+  }'
+```
+
+### Debug Mode
+
+You can enable debug mode to help troubleshoot issues:
+
+1. Using an environment variable:
+```bash
+DEBUG=true ./claude2openai
+```
+
+2. Using the command-line flag:
+```bash
+./claude2openai -debug
+```
+
+In debug mode, detailed information about requests and responses will be logged to help with troubleshooting.
+
 ## Usage
 ### Homebrew (MacOS)
 
@@ -46,6 +103,12 @@ docker run -d --restart always -p 6600:6600 ghcr.io/missuo/claude2openai:latest
 docker run -d --restart always -p 6600:6600 missuo/claude2openai:latest
 ```
 
+To set custom allowed models with Docker:
+
+```bash
+docker run -d --restart always -p 6600:6600 -e ALLOWED_MODELS="claude-3-5-haiku-20241022,claude-3-5-sonnet-20241022" ghcr.io/missuo/claude2openai:latest
+```
+
 ### Docker Compose
 It is recommended that you use docker version **26.0.0** or higher, otherwise you need to specify the version in the `compose.yaml` file.
 ```diff