commit 04530b9a86db9545a4865ad3e926d1468852f26d
parent c4dbb95926f1bc4d9b2312b5ad699561618fbf20
Author: Amit Dutta <amitdutta4255@gmail.com>
Date: Sun, 8 Feb 2026 20:14:15 +0530
CLI-v0.1.2, VSCE-v0.0.4
Diffstat:
11 files changed, 98 insertions(+), 40 deletions(-)
diff --git a/README.md b/README.md
@@ -1,17 +1,49 @@
# Githrun
-> The Swiss Army Knife for Remote Python Execution.
+Githrun is a versatile command-line tool and VS Code extension that enables you to execute, explore, and install Python scripts directly from GitHub and Gists. It streamlines remote execution by handling dependencies, private repositories, and local tool installation.
-## It is available as a VS Code extension. Check out: [marketplace.visualstudio.com](https://marketplace.visualstudio.com/items?itemName=notamitgamer.vscode-githrun)
+[](https://pypi.org/project/githrun/) [](https://pypi.org/project/githrun/) [](https://github.com/notamitgamer/githrun/blob/main/LICENSE) [](https://pepy.tech/project/githrun) [](https://github.com/notamitgamer/githrun/commits/main) [](https://github.com/notamitgamer/githrun/graphs/contributors)
-Githrun is a powerful CLI tool and Python library that lets you run, explore, and install Python code directly from GitHub and Gists. It handles dependencies, private repositories, and even turns remote scripts into local command-line tools.
+---
+
+# VS Code Extension
+
+## Extension Installation & Setup
+
+### 1. Install the Extension
+* **Marketplace:** Search for "Githrun" in the VS Code Extensions view and click Install.
+* **Manual:** If installing from a VSIX file, go to Extensions -> ... -> Install from VSIX.
+
+### 2. Install the Core CLI (Required)
+This extension acts as a bridge to the Githrun command-line tool. You **must** have the Githrun CLI installed on your system.
+
+Open your terminal and run:
+
+```bash
+pip install githrun
+```
+
+## Extension Features & Usage
+
+### CodeLens Integration
+The extension automatically scans Markdown, Python, and Text files for GitHub or Gist URLs.
+* **Action:** Look for the "Run with Githrun" link appearing above any detected URL.
+* **Click:** Clicking the link opens a terminal and executes the script immediately.
+
+### Context Menu
+* **Action:** Highlight any GitHub URL in your editor.
+* **Click:** Right-click the selection and choose **Githrun: Run Selected Text**.
-[](https://pypi.org/project/githrun/)
-[](https://pypi.org/project/githrun/)
-[](https://github.com/notamitgamer/githrun/blob/main/LICENSE)
-[](https://pepy.tech/project/githrun)
-[](https://github.com/notamitgamer/githrun/commits/main)
-[](https://github.com/notamitgamer/githrun/graphs/contributors)
+### Command Palette
+* **Action:** Press `Ctrl+Shift+P` (or `Cmd+Shift+P` on Mac).
+* **Command:** Type `Githrun: Run from URL...` and paste your target link into the input box.
+
+## Extension Settings
+The extension attempts to automatically detect your Githrun installation.
+* It first checks for `githrun` in your global PATH.
+* If not found, it tries `python -m githrun` (or `python3` on Mac/Linux).
+
+---
## Features
@@ -26,14 +58,6 @@ Githrun is a powerful CLI tool and Python library that lets you run, explore, an
---
-## Installation
-
-```bash
-pip install githrun
-```
-
----
-
## CLI Usage
### 1. Run Remote Code
@@ -151,6 +175,8 @@ githrun.download_folder("[https://github.com/user/repo/tree/main/src](https://gi
exit_code = githrun.execute_remote_code("[https://github.com/user/repo/blob/main/script.py](https://github.com/user/repo/blob/main/script.py)", args=["--verbose"])
```
+---
+
## Configuration
Githrun stores configuration and cache files in your home directory:
@@ -161,4 +187,4 @@ Githrun stores configuration and cache files in your home directory:
## License
-This project is licensed under the MIT License.
+This project is licensed under the MIT License.+
\ No newline at end of file
diff --git a/SECURITY.md b/SECURITY.md
@@ -6,8 +6,10 @@ Use this section to tell people about which versions of your project are current
| Version | Supported |
| ------- | ------------------ |
-| 1.0.x | :white_check_mark: |
-| < 1.0 | :x: |
+| 0.1.2 | :white_check_mark: |
+| 0.1.1 | :x: |
+| 0.1.0 | :x: |
+| < 0.1.0 | :x: |
## Reporting a Vulnerability
diff --git a/dist/githrun-0.1.1-py3-none-any.whl b/dist/githrun-0.1.1-py3-none-any.whl
Binary files differ.
diff --git a/dist/githrun-0.1.1.tar.gz b/dist/githrun-0.1.1.tar.gz
Binary files differ.
diff --git a/dist/githrun-0.1.2-py3-none-any.whl b/dist/githrun-0.1.2-py3-none-any.whl
Binary files differ.
diff --git a/dist/githrun-0.1.2.tar.gz b/dist/githrun-0.1.2.tar.gz
Binary files differ.
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
[tool.poetry]
name = "githrun"
-version = "0.1.1"
+version = "0.1.2"
description = "A CLI tool to run Python scripts directly from GitHub URLs"
authors = ["Amit Dutta <mail@amit.is-a.dev>"]
readme = "README.md"
diff --git a/src/githrun/__init__.py b/src/githrun/__init__.py
@@ -1,4 +1,4 @@
-__version__ = "0.1.1"
+__version__ = "0.1.2"
from .core import (
execute_remote_code,
diff --git a/vscode-githrun/README.md b/vscode-githrun/README.md
@@ -1,15 +1,49 @@
# Githrun
-> The Swiss Army Knife for Remote Python Execution.
+Githrun is a versatile command-line tool and VS Code extension that enables you to execute, explore, and install Python scripts directly from GitHub and Gists. It streamlines remote execution by handling dependencies, private repositories, and local tool installation.
-Githrun is a powerful CLI tool and Python library that lets you run, explore, and install Python code directly from GitHub and Gists. It handles dependencies, private repositories, and even turns remote scripts into local command-line tools.
+[](https://pypi.org/project/githrun/) [](https://pypi.org/project/githrun/) [](https://github.com/notamitgamer/githrun/blob/main/LICENSE) [](https://pepy.tech/project/githrun) [](https://github.com/notamitgamer/githrun/commits/main) [](https://github.com/notamitgamer/githrun/graphs/contributors)
-[](https://pypi.org/project/githrun/)
-[](https://pypi.org/project/githrun/)
-[](https://github.com/notamitgamer/githrun/blob/main/LICENSE)
-[](https://pepy.tech/project/githrun)
-[](https://github.com/notamitgamer/githrun/commits/main)
-[](https://github.com/notamitgamer/githrun/graphs/contributors)
+---
+
+# VS Code Extension
+
+## Extension Installation & Setup
+
+### 1. Install the Extension
+* **Marketplace:** Search for "Githrun" in the VS Code Extensions view and click Install.
+* **Manual:** If installing from a VSIX file, go to Extensions -> ... -> Install from VSIX.
+
+### 2. Install the Core CLI (Required)
+This extension acts as a bridge to the Githrun command-line tool. You **must** have the Githrun CLI installed on your system.
+
+Open your terminal and run:
+
+```bash
+pip install githrun
+```
+
+## Extension Features & Usage
+
+### CodeLens Integration
+The extension automatically scans Markdown, Python, and Text files for GitHub or Gist URLs.
+* **Action:** Look for the "Run with Githrun" link appearing above any detected URL.
+* **Click:** Clicking the link opens a terminal and executes the script immediately.
+
+### Context Menu
+* **Action:** Highlight any GitHub URL in your editor.
+* **Click:** Right-click the selection and choose **Githrun: Run Selected Text**.
+
+### Command Palette
+* **Action:** Press `Ctrl+Shift+P` (or `Cmd+Shift+P` on Mac).
+* **Command:** Type `Githrun: Run from URL...` and paste your target link into the input box.
+
+## Extension Settings
+The extension attempts to automatically detect your Githrun installation.
+* It first checks for `githrun` in your global PATH.
+* If not found, it tries `python -m githrun` (or `python3` on Mac/Linux).
+
+---
## Features
@@ -24,14 +58,6 @@ Githrun is a powerful CLI tool and Python library that lets you run, explore, an
---
-## Installation
-
-```bash
-pip install githrun
-```
-
----
-
## CLI Usage
### 1. Run Remote Code
@@ -149,6 +175,8 @@ githrun.download_folder("[https://github.com/user/repo/tree/main/src](https://gi
exit_code = githrun.execute_remote_code("[https://github.com/user/repo/blob/main/script.py](https://github.com/user/repo/blob/main/script.py)", args=["--verbose"])
```
+---
+
## Configuration
Githrun stores configuration and cache files in your home directory:
@@ -159,4 +187,4 @@ Githrun stores configuration and cache files in your home directory:
## License
-This project is licensed under the MIT License.
+This project is licensed under the MIT License.+
\ No newline at end of file
diff --git a/vscode-githrun/package.json b/vscode-githrun/package.json
@@ -2,7 +2,7 @@
"name": "vscode-githrun",
"displayName": "Githrun",
"description": "Instantly run Python scripts from GitHub URLs directly in VS Code.",
- "version": "0.0.3",
+ "version": "0.0.4",
"publisher": "notamitgamer",
"icon": "icon.png",
"engines": {
diff --git a/vscode-githrun/vscode-githrun-0.0.4.vsix b/vscode-githrun/vscode-githrun-0.0.4.vsix
Binary files differ.
