gitarsenal-cli 1.1.2 → 1.1.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gitarsenal-cli",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "description": "CLI tool for creating Modal sandboxes with GitHub repositories",
   "main": "index.js",
   "bin": {

package/python/MODAL_PROXY_README.md

@@ -0,0 +1,126 @@
+# Modal Proxy Service for GitArsenal CLI
+
+This document explains how to set up and use the Modal proxy service with GitArsenal CLI.
+
+## What is the Modal Proxy Service?
+
+The Modal proxy service allows users to access Modal services (like GPU-accelerated containers) without exposing the owner's Modal token. The service runs on a server and provides API endpoints for creating sandboxes and SSH containers, using API key authentication.
+
+## Server-Side Setup
+
+1. **Install Requirements**:
+   ```bash
+   pip install flask flask-cors modal python-dotenv
+   ```
+
+2. **Set Environment Variables**:
+   Create a `.env` file in the same directory as `modal_proxy_service.py`:
+   ```
+   MODAL_TOKEN=your_modal_token_here
+   ADMIN_KEY=your_admin_key_here
+   API_KEYS=optional_comma_separated_list_of_api_keys
+   ```
+
+3. **Start the Service**:
+   ```bash
+   python modal_proxy_service.py
+   ```
+   
+   The service will start on port 5001 by default.
+
+4. **Create an API Key** (if not pre-configured in `.env`):
+   ```bash
+   curl -X POST http://localhost:5001/api/create-api-key \
+        -H "X-Admin-Key: your_admin_key_here"
+   ```
+   
+   This will return a JSON response with a new API key:
+   ```json
+   {"api_key": "generated_api_key_here"}
+   ```
+
+5. **Optional: Use ngrok to expose the service publicly**:
+   ```bash
+   ngrok http 5001
+   ```
+   
+   This will provide you with a public URL that you can share with users.
+   
+   Current ngrok URL: `https://e74889c63199.ngrok-free.app`
+
+## Client-Side Setup
+
+1. **Configure the proxy client**:
+   ```bash
+   ./gitarsenal.py proxy configure
+   ```
+   
+   You'll be prompted to enter:
+   - The proxy URL (the default is now set to `https://e74889c63199.ngrok-free.app`)
+   - Your API key
+
+2. **Check proxy service status**:
+   ```bash
+   ./gitarsenal.py proxy status
+   ```
+
+## Using the Proxy Service
+
+### Create an SSH Container
+
+```bash
+# Using the proxy command
+./gitarsenal.py proxy ssh --gpu A10G --repo-url https://github.com/username/repo.git --wait
+
+# Or using the standard ssh command with --use-proxy flag
+./gitarsenal.py ssh --use-proxy --gpu A10G --repo-url https://github.com/username/repo.git
+```
+
+### Create a Sandbox
+
+```bash
+# Using the proxy command
+./gitarsenal.py proxy sandbox --gpu A10G --repo-url https://github.com/username/repo.git --wait
+
+# Or using the standard sandbox command with --use-proxy flag
+./gitarsenal.py sandbox --use-proxy --gpu A10G --repo-url https://github.com/username/repo.git
+```
+
+## Troubleshooting
+
+### "Token missing" Error
+
+If you see a "Token missing" error when creating containers through the proxy service:
+
+1. **Check that the MODAL_TOKEN is set on the server**:
+   - Verify the `.env` file has a valid MODAL_TOKEN
+   - Restart the proxy service after updating the token
+
+2. **Check that the proxy service is running**:
+   - Use `./gitarsenal.py proxy status` to check connectivity
+   - Verify the ngrok tunnel is active and the URL is correct
+
+3. **Check API key authentication**:
+   - Make sure your client is configured with a valid API key
+   - If needed, reconfigure with `./gitarsenal.py proxy configure`
+
+4. **Check server logs**:
+   - Look at `modal_proxy.log` on the server for detailed error messages
+
+### "Unauthorized" Error
+
+If you see an "Unauthorized" error:
+
+1. **When creating an API key**:
+   - Make sure you're including the correct admin key in the request header
+   - Example: `-H "X-Admin-Key: your_admin_key_here"`
+
+2. **When using the API**:
+   - Make sure your client is configured with a valid API key
+   - Reconfigure with `./gitarsenal.py proxy configure`
+
+## Security Considerations
+
+- Keep your admin key and API keys secure
+- Use HTTPS if exposing the service publicly (ngrok provides this automatically)
+- Consider implementing additional authentication mechanisms for production use 

package/python/README.md

@@ -68,6 +68,101 @@ This will guide you through setting up:
 - `--setup-commands`: Setup commands to run
 - `--volume-name`: Name of the Modal volume for persistent storage
 - `--timeout`: Container timeout in minutes (SSH mode only, default: 60)
+- `--use-proxy`: Use Modal proxy service instead of direct Modal access
+
+## Using the Modal Proxy Service
+
+GitArsenal CLI now supports using a Modal proxy service, which allows you to use Modal services without having your own Modal token. This is useful for teams or organizations where a single Modal account is shared.
+
+### Setting Up the Proxy Service
+
+#### 1. Create an Environment File
+
+Copy the example environment file and edit it:
+
+```bash
+cp .env.example .env
+```
+
+Edit the `.env` file to add your Modal token:
+
+```
+MODAL_TOKEN=your_modal_token_here
+```
+
+#### 2. Run the Proxy Service
+
+```bash
+# Start the proxy service
+python modal_proxy_service.py
+```
+
+The service will start on port 5001 by default (to avoid conflicts with macOS AirPlay on port 5000).
+
+#### 3. Create an API Key for Clients
+
+When the service starts for the first time, it will generate an admin key. Use this key to create API keys for clients:
+
+```bash
+# Create a new API key
+curl -X POST -H "X-Admin-Key: your_admin_key" http://localhost:5001/api/create-api-key
+```
+
+#### 4. Using ngrok for Public Access (Optional)
+
+If you want to make your proxy service accessible from outside your network:
+
+```bash
+# Install ngrok if you haven't already
+brew install ngrok  # On macOS
+
+# Start ngrok to expose your proxy service
+ngrok http 5001
+```
+
+Use the ngrok URL when configuring clients.
+
+### Configuring the Client
+
+```bash
+# Configure the proxy service
+./gitarsenal.py proxy configure
+```
+
+This will prompt you for the proxy service URL and API key.
+
+### Checking Proxy Service Status
+
+```bash
+# Check if the proxy service is running
+./gitarsenal.py proxy status
+```
+
+### Creating a Sandbox through the Proxy
+
+```bash
+# Create a sandbox through the proxy service
+./gitarsenal.py proxy sandbox --gpu A10G --repo-url "https://github.com/username/repo.git" --wait
+```
+
+### Creating an SSH Container through the Proxy
+
+```bash
+# Create an SSH container through the proxy service
+./gitarsenal.py proxy ssh --gpu A10G --repo-url "https://github.com/username/repo.git" --wait
+```
+
+### Using the Proxy with Standard Commands
+
+You can also use the proxy service with the standard `sandbox` and `ssh` commands by adding the `--use-proxy` flag:
+
+```bash
+# Create a sandbox using the proxy service
+./gitarsenal.py sandbox --gpu A10G --repo-url "https://github.com/username/repo.git" --use-proxy
+
+# Create an SSH container using the proxy service
+./gitarsenal.py ssh --gpu A10G --repo-url "https://github.com/username/repo.git" --use-proxy
+```
 
 ## Managing Credentials
 
@@ -97,6 +192,8 @@ You can manage your credentials using the following commands:
 
 Your credentials are stored securely in `~/.gitarsenal/credentials.json` with restrictive file permissions. The file is only readable by your user account.
 
+Proxy configuration is stored in `~/.gitarsenal/proxy_config.json` with similar security measures.
+
 ## Troubleshooting
 
 ### Modal Authentication Issues
@@ -118,6 +215,29 @@ If you see errors like "Token missing" or "Could not authenticate client":
    ./gitarsenal.py credentials set modal_token
    ```
 
+### Proxy Service Issues
+
+If you're having issues with the proxy service:
+
+1. Check if the proxy service is running:
+   ```bash
+   ./gitarsenal.py proxy status
+   ```
+
+2. Reconfigure the proxy service:
+   ```bash
+   ./gitarsenal.py proxy configure
+   ```
+
+3. Make sure you have a valid API key for the proxy service.
+
+4. Check the proxy service logs:
+   ```bash
+   cat modal_proxy.log
+   ```
+
+5. If using ngrok, make sure the tunnel is active and use the correct URL.
+
 ### API Timeout Issues
 
 If the GitArsenal API times out when analyzing repositories, the tool will automatically use fallback setup commands based on the detected programming language and technologies.