Git Commands Cheatsheet

An interactive cheatsheet for common Git commands displayed in a beautiful webview panel within VS Code. Similar to the CSS Flexbox Cheatsheet, this extension provides a quick reference guide for essential Git commands.

Features

• 📋 Interactive Cheatsheet: View all your commonly used Git commands in one place
• 🎨 Beautiful UI: Modern, clean interface that adapts to your VS Code theme
• ⚡ Quick Access: Open the cheatsheet with a simple command
• 📚 Organized Categories: Commands grouped by functionality (Setup, Repository, Branching, Merging, etc.)
• 💡 Examples & Tips: Practical examples and helpful tips included
• 🔧 Easy Customization: All commands stored in a simple commands.md file - edit it to add your own commands!
• 🖱️ Click to Use: Click any command to send it to the terminal

Installation

From VSIX File (Current)

1. Download the git-commands-extension-1.0.0.vsix file
2. Open VS Code
3. Go to Extensions view (Ctrl+Shift+X or Cmd+Shift+X on Mac)
4. Click the "..." menu at the top of the Extensions view
5. Select "Install from VSIX..."
6. Choose the downloaded .vsix file

From VS Code Marketplace (Coming Soon)

Search for "Git Commands Cheatsheet" in the Extensions view and click Install.

Usage

1. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P on Mac)
2. Type "Git: Show Commands Cheatsheet"
3. Press Enter to open the cheatsheet panel

The cheatsheet will open in a new panel showing all your Git commands organized by category.

Customizing Commands

To add or modify Git commands:

1. Navigate to the extension installation folder
2. Edit the commands.md file
3. Follow the existing markdown format:
   • Use ## Emoji Title for section headers
   • Use - \command` → description` for command items
   • Use ### Example: Title followed by a code block for examples
   • Use > **TIP:** text for helpful tips
4. Reopen the cheatsheet to see your changes

Example format:

## 🚀 My Custom Section

- \`git custom-command\` → Description of the command
- \`git another-command <arg>\` → Another command description

### Example: Using Custom Commands

\`\`\`
git custom-command
git another-command value
\`\`\`

> **TIP:** This is a helpful tip!

Commands

This extension contributes the following command:

• Git: Show Commands Cheatsheet - Opens the Git commands cheatsheet panel

Requirements

No special requirements or dependencies needed. Works out of the box!

Extension Settings

This extension does not add any VS Code settings at this time.

Release Notes

1.0.0 - Production Release 🚀

The extension is now out of test mode and ready for production use!

• Version bumped to 1.0.0
• Added publisher information for VS Code Marketplace
• Added repository links and issue tracking
• Improved categorization and keywords for better discoverability
• Production build with optimizations
• Ready for distribution

0.0.2

• Commands now loaded from external commands.md file
• Easy customization - just edit the markdown file
• Click commands to send them to the terminal
• Improved parsing and rendering

0.0.1

Initial release of Git Commands Cheatsheet:

• Display common Git commands in an interactive webview
• Organized categories for various Git operations
• Examples and tips for advanced usage
• Theme-aware styling

Enjoy your Git Commands Cheatsheet! 🚀

Following extension guidelines

Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.

• Extension Guidelines

Working with Markdown

You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

• Split the editor (Cmd+\ on macOS or Ctrl+\ on Windows and Linux).
• Toggle preview (Shift+Cmd+V on macOS or Shift+Ctrl+V on Windows and Linux).
• Press Ctrl+Space (Windows, Linux, macOS) to see a list of Markdown snippets.

For more information

• Visual Studio Code's Markdown Support
• Markdown Syntax Reference

Enjoy!