https://github.com/staciax/vscode-streamer-mode-x

A Visual Studio Code extension that protects sensitive files
https://github.com/staciax/vscode-streamer-mode-x

bun environment-variables streamer typescript vscode vscode-extension

Last synced: 2 months ago
JSON representation

A Visual Studio Code extension that protects sensitive files

• Host: GitHub
• URL: https://github.com/staciax/vscode-streamer-mode-x
• Owner: staciax
• License: mit
• Created: 2025-03-20T14:46:21.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2025-03-20T15:48:03.000Z (over 1 year ago)
• Last Synced: 2025-03-20T16:32:07.194Z (over 1 year ago)
• Topics: bun, environment-variables, streamer, typescript, vscode, vscode-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=staciax.vscode-streamer-mode-x
• Size: 26.4 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# vscode-streamer-mode-x

A Visual Studio Code extension that protects sensitive files like `.env`, especially useful while streaming your screen.

![Preview](docs/demo.gif)

## Installation

The extension for VS Code is available on the **Visual Studio Marketplace**

- [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=staciax.vscode-streamer-mode-x)

## Features

- **Easy to Use** – The warning disappears once you confirm the action.

- **Supports Many File Types** – Protects `.env`, `.pem`, `.key`, `.crt`, `.pfx`, and more.

- **Perfect for Streamers** – Prevent accidental exposure of sensitive information during live streams.

- **Status Bar Control** – Visual indicator shows current mode (enabled/disabled) and allows toggling.

## Usage

### Protected File Types

The extension automatically protects the following file types:

- Environment files (`.env`)

- Certificate and key files (`.pem`, `.key`, `.cer`, `.crt`)

- Certificate stores (`.p12`, `.pfx`)

### Toggling Streamer Mode

You can enable/disable the protection in two ways:

1. **Status Bar**: Click on the "Streamer Mode" indicator in the status bar

2. **Command Palette**: 

   - Open the command palette (Ctrl+Shift+P / Cmd+Shift+P)

   - Type "Toggle Streamer Mode"

   - Select to enable/disable

When disabled, protected files will open normally without the warning screen.

## Runtime Environment

> [!WARNING]  

> This project currently uses [Bun](https://bun.sh/) instead of [Node.js](https://nodejs.org/) as a runtime environment. While it's working in the current state, there are some limitations I've encountered. If you fork or clone this repository, you might face compatibility issues. This is an experimental setup as I explore Bun's capabilities compared to Node.js.

## License

This project is licensed under the GNUv3 License - see the [LICENSE](LICENSE.md) file for details.