RunMate - Shell Script Manager for VS Code

RunMate is a VS Code extension that automatically discovers and manages shell scripts in your workspace, providing a convenient sidebar panel for quick execution and management.

Features

Automatic Script Discovery: Finds all .sh files in your workspace
TreeView Panel: Organized display of scripts by directory
Quick Execution: Run scripts with a single click
Parameter Support: Input and remember script parameters
Real-time Updates: Automatically refreshes when scripts are added/removed
Security Checks: Detects dangerous commands and requires confirmation
Execution Status: Visual indicators for running/success/failed scripts
Concurrent Execution: Run multiple scripts simultaneously

Installation

Install dependencies: npm install
Compile TypeScript: npm run compile
Press F5 in VS Code to launch the Extension Development Host

Usage

Open a workspace containing shell scripts
The RunMate panel appears in the Activity Bar
Click on any script to execute it
Enter parameters when prompted (optional)
View output in the integrated terminal

Configuration

VS Code Settings

Configure RunMate through VS Code settings:

runmate.ignoreDirectories: Directories to exclude from scanning
runmate.defaultWorkingDirectory: Default execution directory
runmate.customSort: Custom script ordering
runmate.dangerousCommandsBlacklist: Commands requiring confirmation
runmate.confirmBeforeExecute: Show confirmation before execution
runmate.rememberLastParameters: Remember script parameters

Project Configuration

Create .vscode/run-mate.json for project-specific settings:

{
  "ignoreDirectories": ["node_modules", ".git"],
  "defaultWorkingDirectory": "./",
  "customSort": ["deploy.sh", "build.sh"],
  "dangerousCommandsWhitelist": ["rm -rf ./tmp"],
  "dangerousCommandsBlacklist": ["rm -rf /", "mkfs"]
}

Security

RunMate includes built-in security features:

Dangerous command detection
Execution confirmation dialogs
Automatic permission management
Parameter sanitization

Development

Build and Test

npm run compile    # Compile TypeScript
npm run watch      # Watch mode
npm run lint       # Run ESLint
npm run test       # Run tests
npm run package    # Create VSIX package

Project Structure

src/
├── extension.ts       # Extension entry point
├── scriptScanner.ts   # File discovery
├── scriptTreeView.ts  # UI components
├── executor.ts        # Script execution
├── config.ts          # Configuration management
└── security.ts        # Security checks

CI/CD

This project uses GitHub Actions for continuous integration and deployment:

Test Workflow: Runs on every push and pull request
- Linting with ESLint
- Multi-platform testing (Windows, macOS, Linux)
- Node.js version matrix (18, 20)
- Automatic VSIX packaging
Release Workflow: Triggered by version tags (v*)
- Automated GitHub release creation
- VSIX file upload to release assets
- Optional publishing to VS Marketplace and Open VSX

Publishing Setup

To enable automated publishing, configure these GitHub Secrets:

VS_MARKETPLACE_TOKEN (Optional)
- Create a Personal Access Token in Azure DevOps
- Go to https://dev.azure.com/your-organization/_usersSettings/tokens
- Create new token with "Marketplace > Manage" scope
- Add as GitHub repository secret
OPEN_VSX_TOKEN (Optional)
- Register at https://open-vsx.org/
- Generate access token from your profile
- Add as GitHub repository secret

Without these tokens, the release workflow will still create GitHub releases with VSIX files for manual distribution.

Requirements

VS Code 1.74.0 or higher
macOS or Linux (Windows not supported)
Node.js 16.x or higher

License

MIT

RunMate

kivi