gitarsenal-cli 1.1.1 → 1.1.3

package/package.json

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

package/python/README.md

@@ -13,50 +13,51 @@ cd gitarsenal-cli/python
 pip install -r requirements.txt
 ```
 
-## Credentials Setup
+## First-Time Setup
 
-GitArsenal CLI requires several API keys and tokens to function properly:
+Before using GitArsenal CLI, you need to set up your credentials and authenticate with Modal:
 
-- **OpenAI API Key**: Used for debugging failed commands
-- **Modal Token**: Used to create cloud environments
-- **Hugging Face Token**: Used for accessing Hugging Face models
-- **Weights & Biases API Key**: Used for experiment tracking
-
-You can set up your credentials using the credentials manager:
+### 1. Install Modal
 
 ```bash
-python manage_credentials.py setup
+pip install modal
 ```
 
-This will guide you through setting up all required credentials, which will be stored securely in your home directory.
+### 2. Create a Modal Account and Get a Token
 
-### Managing Individual Credentials
+If you don't have a Modal account:
+1. Go to https://modal.com and create an account
+2. Run the following command to authenticate:
+   ```bash
+   modal token new
+   ```
+3. Follow the instructions to complete authentication
 
-You can also manage individual credentials:
+### 3. Set Up GitArsenal Credentials
 
 ```bash
-# Set a specific credential
-python manage_credentials.py set openai_api_key
+# Set up all required credentials
+./gitarsenal.py credentials setup
+```
 
-# View a credential (masked for security)
-python manage_credentials.py get modal_token
+This will guide you through setting up:
+- **Modal Token**: Required for creating cloud environments
+- **OpenAI API Key**: Used for debugging failed commands (optional)
+- **Hugging Face Token**: Used for accessing Hugging Face models (optional)
+- **Weights & Biases API Key**: Used for experiment tracking (optional)
 
-# Clear a specific credential
-python manage_credentials.py clear huggingface_token
+## Usage
 
-# Clear all credentials
-python manage_credentials.py clear
+### Creating a Modal Sandbox
 
-# List all saved credentials (without showing values)
-python manage_credentials.py list
+```bash
+./gitarsenal.py sandbox --gpu A10G --repo-url "https://github.com/username/repo.git"
 ```
 
-## Usage
-
-### Creating a Modal Sandbox
+### Creating an SSH Container
 
 ```bash
-python test_modalSandboxScript.py --gpu A10G --repo-url "https://github.com/username/repo.git"
+./gitarsenal.py ssh --gpu A10G --repo-url "https://github.com/username/repo.git"
 ```
 
 ### Options
@@ -66,30 +67,192 @@ python test_modalSandboxScript.py --gpu A10G --repo-url "https://github.com/user
 - `--repo-name`: Repository name override
 - `--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
+
+You can manage your credentials using the following commands:
+
+```bash
+# Set up all credentials
+./gitarsenal.py credentials setup
+
+# Set a specific credential
+./gitarsenal.py credentials set modal_token
+
+# View a credential (masked for security)
+./gitarsenal.py credentials get modal_token
+
+# Clear a specific credential
+./gitarsenal.py credentials clear huggingface_token
+
+# Clear all credentials
+./gitarsenal.py credentials clear
+
+# List all saved credentials (without showing values)
+./gitarsenal.py credentials list
+```
 
 ## Security
 
 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
 
-If you encounter authentication issues:
+### Modal Authentication Issues
 
-1. Check that your credentials are set up correctly:
+If you see errors like "Token missing" or "Could not authenticate client":
+
+1. Ensure Modal is installed:
    ```bash
-   python manage_credentials.py list
+   pip install modal
    ```
 
-2. If needed, clear and reset your credentials:
+2. Get a new Modal token:
    ```bash
-   python manage_credentials.py clear
-   python manage_credentials.py setup
+   modal token new
    ```
 
-3. Ensure Modal CLI is installed and authenticated:
+3. Save the token in GitArsenal:
    ```bash
-   pip install modal
-   modal token new
+   ./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.
+
+### Other Issues
+
+1. Check that your credentials are set up correctly:
+   ```bash
+   ./gitarsenal.py credentials list
+   ```
+
+2. If needed, clear and reset your credentials:
+   ```bash
+   ./gitarsenal.py credentials clear
+   ./gitarsenal.py credentials setup
    ```
 
 ## License