Skip to content

coderbro0/open-gist

Repository files navigation

πŸ“‚ GistPilot β€” VS Code Extension

VS Code Marketplace
Installs
GitHub

πŸ“¦ Version: v0.0.4 – Now with Gist QR Sharing, ZIP Import/Export, AI Summarizer, Playground, Star/Fork and more!


✨ Features

βœ… Open a GitHub Gist as a folder, preserving nested structure using filenames
βœ… Create public or private Gists directly from any file
βœ… Add individual files or full folders to an existing Gist
βœ… Delete specific files or the entire Gist
βœ… Flatten folder paths using ... so Gist can simulate subfolders
βœ… Built-in GitHub token authentication with validation
βœ… Tokens are stored securely using VS Code's SecretStorage
βœ… Works behind firewalls and proxies (no browser dependency)


πŸ†• v0.0.4 β€” New Power Features

Feature Description
πŸ“€ Share via QR / Shortlink Generate a shareable QR code or shortlink for any Gist
🧳 Import / Export ZIP Export entire Gist as ZIP or import ZIP folder into Gist
πŸ€– AI Summarizer (OpenAI & Gemini) Choose between OpenAI or Google Gemini to summarize code (No keys are stored)
πŸ” Auto-Sync Toggle Enable or disable syncing Gist updates on save
⭐ Star / Unstar Gist Mark Gists as favorite and manage them
🍴 Fork Gist Instantly create a forked version of a Gist
🧷 Scratch Notes Create markdown notes directly saved to a personal Gist
πŸ–ΌοΈ Paste Image to Gist Paste image as file (markdown / base64 supported)
πŸ§ͺ Comment Threads Basic UI for commenting and viewing threads on files
🌍 Follow GitHub Users Follow and browse public Gists from other GitHub users
🧩 Code Playground Advanced CodeSwing-style environment for experimenting with code live

πŸ” Setting Up Your GitHub Token

Creating or editing Gists requires authentication. Follow these steps to create and add your GitHub Personal Access Token:

πŸ”‘ How to Create a GitHub Token

  1. Go to https://github.com/settings/tokens
  2. Click "Fine-grained tokens" β†’ then "Generate new token"
  3. Name your token (e.g., VS Code Gist)
  4. Set:
    • Expiration: Choose 30 days or "No expiration"
    • Repository access: Doesn't matter for Gists
    • Permissions:
      • Under Gists, check βœ… Read and write
  5. Click Generate token
  6. Copy the token β€” you won’t see it again!

πŸš€ Adding Token to Extension

  1. In VS Code, press F1
  2. Run GistPilot: Set GitHub Token
  3. Paste the token you created

πŸ” Your token is securely saved via VS Code’s SecretStorage.

To remove it:
F1 β†’ GistPilot: Clear GitHub Token


πŸ› οΈ Usage Guide

πŸ“‚ Open Gist by ID

  • Run: GistPilot: Open Gist by ID
  • Paste your Gist ID (e.g., abcd12345)
  • It will open as a folder in VS Code

➑️ Supports folder-like files: src...main.cpp β†’ src/main.cpp


✏️ Create a New Gist

  • Open any file
  • Run: GistPilot: Create New Gist
  • Enter description + choose Public/Private
  • Gist is created and ID is copied to your clipboard

πŸ“ Upload a Folder to a Gist

  • Run: GistPilot: Upload Folder to Gist
  • Select a folder from your system
  • Enter the target Gist ID
  • All files will be uploaded using ... to simulate folder paths

βž• Add File to Gist

  • Run: GistPilot: Add File to Gist
  • Select file β†’ Enter Gist ID β†’ Done!

βž– Remove File from Gist

  • Run: GistPilot: Remove File from Gist
  • Enter Gist ID and file name (e.g., src...index.js)

πŸ—‘οΈ Delete a Gist

  • Run: GistPilot: Delete Gist
  • Enter Gist ID β†’ Gist is permanently deleted

πŸ€– AI Summarizer (OpenAI & Gemini)

  • Run: GistPilot: Summarize Gist with AI
  • Select your AI provider (OpenAI or Gemini)
  • The extension uses these optional settings:
    • open-gist.aiProvider (default: openai)
    • open-gist.openaiApiKey (OpenAI users)
    • open-gist.geminiApiKey (Gemini users)

πŸ’‘ Your API key is never saved to disk. For security, it’s used only in memory for the session.


πŸ” How to Get Your API Key

🧠 OpenAI

  1. Visit: https://platform.openai.com/account/api-keys
  2. Log in with your OpenAI account
  3. Click β€œCreate new secret key”
  4. Copy the key (starts with sk-...) and paste it when prompted in VS Code

πŸͺ„ Gemini (Google AI Studio)

  1. Visit: https://makersuite.google.com/app/apikey
  2. Log in with your Google account
  3. Click β€œGet API key”
  4. Copy the key (starts with AIza...) and paste it when prompted in VS Code

πŸ›‘οΈ For privacy and security, your API keys are only used during the current session β€” they are never saved to disk.


πŸ” Toggle Auto-Sync

  • Run: GistPilot: Toggle Auto Gist Sync
  • This toggles setting: open-gist.autoSync in user preferences

⭐ Star / 🍴 Fork Gist

  • Run: GistPilot: Star/Unstar Gist
  • In Gist Explorer, right-click a Gist
  • Select Star Gist, Unstar Gist, or Fork Gist
  • Forked Gist opens in a new workspace window

🧷 Scratch Notes

  • Run: GistPilot: Create Scratch Note
  • Generates a markdown note with timestamp in your scratch Gist

πŸ–ΌοΈ Paste Image into Gist File

  • Copy any image (Ctrl+C)
  • Focus on a file inside Gist in editor, press Ctrl+V
  • Uploads as:
    • File with markdown reference
    • OR embedded base64 block, based on config

πŸ§ͺ Gist Comment Threads

  • Open a Gist file
  • Threads are shown below file
  • Click to expand, reply, or hide comment threads

🌍 Follow GitHub Users

  • Run: GistPilot: Follow GitHub User
  • Explore public Gists from followed users in Gist Explorer

🧩 Code Playground (Live Preview)

  • Run: GistPilot: Create Code Playground
  • Opens an HTML/CSS/JS/Markdown preview with instant updates
  • Ideal for quick experiments and sharing via Gists

πŸ“€ Share Gist via QR Code / Shortlink

  • Run: GistPilot: Share Gist as QR
  • Paste your Gist ID or select an active file
  • A QR image will be shown in the panel and shortlink copied to clipboard

πŸ’‘ Great for presentations, mobile scanning, quick sharing.


🧳 Import / Export Gist as ZIP

  • Run: GistPilot: Export Gist to ZIP β†’ Select Gist ID β†’ ZIP saved to disk
  • Run: GistPilot: Import Gist from ZIP β†’ Select ZIP file β†’ Files extracted and pushed to GitHub
  • For Import Feature Github Token is required so first set your github token. πŸ“ Folder structure is preserved using ... convention. Automatically maps filenames.

🎬 Tutorials (Coming Soon)

  • πŸ“Ή How to create and set a GitHub token
  • πŸ“Ή How to upload a folder to a Gist
  • πŸ“Ή How to use the AI summarizer and auto-sync

πŸ“Ί Video links will appear here once available


Open Gist Logo

πŸ‘¨β€πŸ’» Maintained by @coderbro

  • 🧠 Love the tool? Star it on GitHub!
  • πŸ’¬ Issues, suggestions, or feature requests welcome.

πŸ“„ License

Apache License 2.0 Β© coderbro


πŸ“Œ Tags & Topics











🧩 Related Tags (Plain)

#gist #github #gist-explorer #vscode-extension #auto-sync
#openai #code-summary #cloud-snippets #code-sharing #developer-tools
#open-gist #code-manager #ai-powered #vscode-gist #gist-manager
#gist-sync #upload-to-gist #gist-folder #file-sync #vscode-integrations

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published