README.en.md

VSCode Private Notes

中文版本

An extension that focuses on privacy, auto encrypts or decrypts files in virtual workspace.

Usage

Open a folder, then use Encrypt: Setup Workspace command to transform the current workspace into an encrypted workspace.

Then use Encrypt: Set or change password to set a password.

Change password

Use Encrypt: Set or change password to set or change the password.

Clear encryption

Use Encrypt: Decrypt all files to clear the password and decrypt all files.

Configuration

Configuration file location: ./encrypt.json.

Please refer UserConfiguration to see all options.

example:

Do not auto encrypt or decrypt jpg/png file.

{
  "exclude": ["**/*.jpg", "**/*.png"]
}

Limitation

You can only use a part of extensions because of virtual workspace limitation.

Core concept

use vscode FileSystemProvider API, delegate all read/write action, use aes-256-gcm to decrypt when read file and encrypt when write file.