gitarsenal-cli 1.5.3 → 1.5.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +86 -41
  2. package/package.json +1 -1
  3. package/python/__pycache__/fetch_modal_tokens.cpython-313.pyc +0 -0
package/README.md CHANGED
@@ -1,74 +1,119 @@
1
1
  # GitArsenal CLI
2
2
 
3
- A tool for creating and managing GPU-accelerated development environments using Modal.
3
+ **Run any GitHub repository instantly with pre-configured GPU environments.**
4
4
 
5
- ## Features
5
+ GitArsenal CLI makes it incredibly easy to run any GitHub repository without worrying about setup, dependencies, or environment configuration. Just point it at a repository and start coding with GPU acceleration.
6
6
 
7
- - Create Modal containers with GPU support
8
- - Clone repositories and run setup commands
9
- - Persistent storage with Modal volumes
10
- - SSH access to containers
11
- - API key management for various services
7
+ ## Why GitArsenal CLI?
12
8
 
13
- ## API Key Management
9
+ - **Zero Setup**: No need to install dependencies, configure environments, or manage GPU drivers
10
+ - **GPU Ready**: Every environment comes with GPU acceleration (A10G, A100, H100)
11
+ - **Persistent Storage**: Your work and data persist between sessions
12
+ - **SSH Access**: Connect directly to your running environment
13
+ - **API Key Management**: Securely store and auto-inject API keys for services like OpenAI, Weights & Biases, and Hugging Face
14
14
 
15
- The CLI now supports secure storage of API keys for various services. Keys are stored in `~/.gitarsenal/keys/` with proper permissions (only readable by the current user).
15
+ ## Quick Start
16
16
 
17
- ### Supported Services
17
+ ### Run any GitHub repository
18
18
 
19
- - `openai` - OpenAI API keys for debugging and assistance
20
- - `wandb` - Weights & Biases API keys for experiment tracking
21
- - `huggingface` - Hugging Face tokens for model access
19
+ ```bash
20
+ # Basic usage - clone and run any repo
21
+ gitarsenal container --repo-url https://github.com/username/awesome-project.git
22
+
23
+ # With GPU acceleration
24
+ gitarsenal container --gpu A10G --repo-url https://github.com/username/awesome-project.git
22
25
 
23
- ### Managing API Keys
26
+ # With custom setup commands
27
+ gitarsenal container --gpu A100 --repo-url https://github.com/username/awesome-project.git --setup-commands "pip install -r requirements.txt" "python setup.py install"
28
+ ```
24
29
 
25
- #### Adding a new API key
30
+ ### Examples
26
31
 
27
32
  ```bash
28
- # Add a key interactively (will prompt for the key)
29
- python test_modalSandboxScript.py keys add --service openai
33
+ # Run a machine learning project
34
+ gitarsenal container --gpu A100 --repo-url https://github.com/username/transformer-project.git --setup-commands "pip install torch transformers" "wandb login"
30
35
 
31
- # Add a key directly (not recommended for security)
32
- python test_modalSandboxScript.py keys add --service wandb --key YOUR_API_KEY
36
+ # Run a web development project
37
+ gitarsenal container --repo-url https://github.com/username/react-app.git --setup-commands "npm install" "npm start"
38
+
39
+ # Run a data science project with persistent storage
40
+ gitarsenal container --gpu A10G --repo-url https://github.com/username/data-analysis.git --volume-name my-data --setup-commands "pip install pandas numpy matplotlib"
33
41
  ```
34
42
 
35
- #### Listing saved API keys
43
+ ## API Key Management
44
+
45
+ Store your API keys once and use them across all projects:
36
46
 
37
47
  ```bash
38
- python test_modalSandboxScript.py keys list
39
- ```
48
+ # Add API keys for seamless integration
49
+ gitarsenal keys add --service openai
50
+ gitarsenal keys add --service wandb
51
+ gitarsenal keys add --service huggingface
40
52
 
41
- #### Viewing a specific API key (masked)
53
+ # View your saved keys
54
+ gitarsenal keys list
42
55
 
43
- ```bash
44
- python test_modalSandboxScript.py keys view --service huggingface
56
+ # Remove a key
57
+ gitarsenal keys delete --service openai
45
58
  ```
46
59
 
47
- #### Deleting an API key
60
+ ### Supported Services
61
+
62
+ - **OpenAI** - For debugging and AI assistance
63
+ - **Weights & Biases** - For experiment tracking
64
+ - **Hugging Face** - For model access and downloads
65
+
66
+ ## Features
67
+
68
+ ### Automatic Environment Setup
69
+ The CLI automatically:
70
+ - Clones your repository
71
+ - Installs dependencies based on your setup commands
72
+ - Configures GPU acceleration
73
+ - Sets up persistent storage
74
+ - Injects your saved API keys
75
+
76
+ ### Persistent Storage
77
+ Keep your work safe with persistent volumes:
48
78
 
49
79
  ```bash
50
- python test_modalSandboxScript.py keys delete --service openai
80
+ # Create a persistent environment
81
+ gitarsenal container --repo-url https://github.com/username/project.git --volume-name my-work
82
+
83
+ # Your data, models, and work will persist between sessions
51
84
  ```
52
85
 
53
- ## Creating a Modal Container
86
+ ### SSH Access
87
+ Connect directly to your running environment:
54
88
 
55
89
  ```bash
56
- # Basic container creation
57
- python test_modalSandboxScript.py container --gpu A10G --repo-url https://github.com/username/repo.git
58
-
59
- # With setup commands
60
- python test_modalSandboxScript.py container --gpu A100 --repo-url https://github.com/username/repo.git --setup-commands "pip install -r requirements.txt" "python setup.py install"
90
+ # Get SSH connection details
91
+ gitarsenal container --repo-url https://github.com/username/project.git --ssh
61
92
 
62
- # With volume for persistent storage
63
- python test_modalSandboxScript.py container --gpu A10G --repo-url https://github.com/username/repo.git --volume-name my-persistent-volume
93
+ # Connect via SSH to your environment
94
+ ssh user@your-environment-ip
64
95
  ```
65
96
 
66
- ## Automatic API Key Usage
97
+ ## Workflow
98
+
99
+ 1. **Choose a repository** - Any GitHub repo you want to work with
100
+ 2. **Run the command** - Specify GPU, setup commands, and storage
101
+ 3. **Start coding** - Your environment is ready with all dependencies installed
102
+ 4. **Save your work** - Use persistent volumes to keep your progress
103
+
104
+ ## Perfect For
105
+
106
+ - **Machine Learning Projects** - GPU-accelerated training with pre-configured environments
107
+ - **Data Science** - Jupyter notebooks with all dependencies ready
108
+ - **Web Development** - Full-stack projects with development servers
109
+ - **Research** - Reproducible environments for academic work
110
+ - **Hackathons** - Quick setup for rapid prototyping
67
111
 
68
- When using commands that require API keys (like `wandb login` or `huggingface-cli login`), the system will:
112
+ ## Getting Started
69
113
 
70
- 1. Check if a saved API key exists for the service
71
- 2. If found, use the saved key automatically
72
- 3. If not found, prompt for the key and offer to save it for future use
114
+ 1. Install the CLI (see installation instructions)
115
+ 2. Add your API keys: `gitarsenal keys add --service openai`
116
+ 3. Run any repository: `gitarsenal container --repo-url https://github.com/username/project.git`
117
+ 4. Start coding!
73
118
 
74
- This makes it easy to work with multiple projects that require the same API keys without having to re-enter them each time.
119
+ No more "works on my machine" - every environment is identical and ready to go.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "gitarsenal-cli",
3
- "version": "1.5.3",
3
+ "version": "1.5.4",
4
4
  "description": "CLI tool for creating Modal sandboxes with GitHub repositories",
5
5
  "main": "index.js",
6
6
  "bin": {