The C++ Button README

August 31, 2025 · View on GitHub

🚀 The C++ Button is a simple VS Code extension that provides a quick way to compile and run all .cpp files, Python, and Java programs in your current workspace folder. Perfect for developers looking to speed up their workflow!

Features

  • Compile and Run C++ Files: With a single click or command, compile all .cpp files in the current workspace and run the main program, saving all files before compiling, which is configurable through settings.

  • Compile and Run Java Programs: Automatically detects the main Java class, compiles all .java files, and runs the main program, saving all files before compiling, which is configurable through settings. The compiled .class files will be stored in a "build" folder created in your workspace.

  • Compile and Run Python File: Execute the currently open Python file directly from the editor, saving the file before execution, which is configurable through settings.

  • Run TypeScript: Run npm run start for typescript projects.

  • Custom Button: Adds a custom button in the editor for .cpp and .java files, allowing fast access to compilation and execution.

  • Error Handling: Displays compilation and runtime errors directly in VS Code.

  • Running Time and Memory Usage: Displays the run time and memory usage after each compilation and run. This can be disabled in the settings (enabled by default).

  • Header Comment Generation: Easily add a standardized header comment to your code files, including fields for author name, creation date, file name, project name, and a description.

Usage

C++ Code

  1. Open one or multiple C++ files in your VS Code workspace.
  2. Use the Command Palette (Cmd+Shift+P or Ctrl+Shift+P) and search for 🚀 Run C++ 💻 to compile and run your C++ files.
  3. Alternatively, click the Run C++ button in the editor title when viewing a .cpp file.

Java Code

  1. Open one or multiple Java files in your VS Code workspace.
  2. Ensure one of your Java files contains the public static void main(String[] args) method.
  3. Use the Command Palette (Cmd+Shift+P or Ctrl+Shift+P) and search for 🚀 Run Java ☕ to compile and run your Java program.
  4. Alternatively, click the Run Java button in the editor title when viewing a .java file.

Python Code

  1. Open the Python file you want to execute in your VS Code workspace.
  2. Use the Command Palette (Cmd+Shift+P or Ctrl+Shift+P) and search for 🚀 Run Python 🐍 to execute the currently open Python file.
  3. Alternatively, click the Run Python button in the editor title when viewing a .py file.

Adding Header Comments

  1. Open the file you want to add a header comment to.
  2. Use the Command Palette (Cmd+Shift+P or Ctrl+Shift+P) and search for "📜 Generate Header" to insert a header comment at the top of your code file.
  3. You can customize the author name through the extension settings.

Customization

  • To change the author name for header comments, go to File > Preferences > Settings (or press Ctrl (Cmd) + ,), then search for "The C++ Button Configuration" and update the Author Name setting.

Requirements

  • C++: Ensure g++ is installed and available in your PATH. This extension uses g++ to compile C++ files.

  • Java: Ensure the Java Development Kit (JDK) is installed and available in your PATH. This extension requires the JDK to compile and run Java files.

  • Python: Install Python and ensure the python3 command is available in your system's PATH.

  • VS Code: Version 1.94.0 or higher.