KittX Run Button

Professional project runner and task manager for VS Code, built by Kittxdev Technologies Private Limited.

KittX Run Button streamlines your development workflow by managing run configurations and automating environment setup for Python and Node.js projects. Stop typing repetitive commands and let the extension handle the heavy lifting.

Key Features

• Project-Specific Configurations: Share run commands with your team using .run.json.
• One-Click Execution: Run and stop projects directly from the VS Code status bar.
• Python Automation:
  • Auto-detects .venv virtual environments.
  • Auto-creates the environment if it's missing.
  • Auto-installs requirements.txt.
  • Auto-adds .venv to .gitignore.
• Node.js Automation:
  • Supports npm, pnpm, yarn, and bun.
  • Auto-installs node_modules if missing.
  • Auto-adds node_modules to .gitignore.
  • Validates Node.js versions.
• Visual Configuration Editor: Easy-to-use UI to manage your run commands.

Getting Started

1. Installation

Install the extension from the VS Code Marketplace.

2. Initialize Configuration

Open your project folder and click the $(gear) Init Config button in the status bar (or run the command KittX Run Button: Initialize). This creates a .run.json file in your project root.

3. Configure Your Project

Click the $(gear) icon or run KittX Run Button: Configure to open the visual editor.

Python Projects

Select Python as the type.

• Command: python app.py (or your entry point).
• Automation: The extension will automatically look for .venv. If it doesn't exist, it will create it and install requirements.txt.
• Requirements: You can specify a minimum Python version (e.g., >=3.9).

Node.js Projects

Select Node.js as the type.

• Command: npm start, node server.js, etc.
• Package Manager: Choose between npm, pnpm, yarn, or bun.
• Automation: If node_modules is missing, the extension will run install automatically.

Shell / General

Select Shell for generic scripts.

• Command: Any shell command (e.g., ./deploy.sh, echo "Hello World").
• Flexibility: Useful for build scripts, deployment tasks, or languages without specific automation support.

Configuration File (.run.json)

You can also edit the .run.json file manually. It supports IntelliSense.

{
    "configurations": [
        {
            "name": "Django Server",
            "type": "python",
            "command": "python manage.py runserver",
            "python": {
                "envPath": ".venv",
                "autoCreate": true,
                "installRequirements": true
            },
            "requirements": {
                "python": ">=3.10"
            }
        },
        {
            "name": "React Frontend",
            "type": "node",
            "command": "npm start",
            "stopCommand": "npm stop",
            "cwd": "frontend",
            "node": {
                "packageManager": "npm",
                "installDependencies": true
            }
        }
    ]
}

Extension Settings

This extension contributes the following settings:

• runButton.commands: Global configurations that are available across all workspaces (though .run.json is recommended for project-specific tasks).

Support & Feedback

If you encounter any issues or have feature requests, please file an issue on our Bitbucket Repository.

Publisher: Kittxdev Technologies Private Limited
License: MIT