Skip to content

Commit cfeb6c0

Browse files
committed
Update README for bundled git-crypt binary
Document that macOS/Linux ship with git-crypt included. Note Windows is unsupported. Mention the system PATH install command.
1 parent 7bf69dc commit cfeb6c0

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ VSCode's extension host process uses a minimal `PATH` that often excludes direct
1010

1111
## How It Works
1212

13-
The extension appends common installation directories (`/opt/homebrew/bin`, `/usr/local/bin`, `/usr/bin`) to `process.env.PATH` on the shared extension host. This makes `git-crypt` discoverable by all extensions, including the built-in git extension. Once the filter works, VSCode's native diff and staging operate correctly on git-crypt files.
13+
On macOS and Linux, the extension ships a bundled `git-crypt` binary. No separate installation needed -- the extension appends its binary to `PATH` so git's clean/smudge filters just work. If you already have git-crypt installed, your version takes precedence.
1414

1515
Git-crypt files are also decorated with a lock badge so you can identify them at a glance.
1616

@@ -20,9 +20,12 @@ With the extension installed, git-crypt files work like any other file in the So
2020

2121
## Requirements
2222

23-
- [git-crypt](https://github.com/AGWA/git-crypt) installed (`brew install git-crypt` or equivalent)
2423
- Repository must be unlocked (`git-crypt unlock`)
2524
- VSCode >= 1.85.0
25+
- **macOS and Linux:** git-crypt is included automatically
26+
- **Windows:** Not supported ([git-crypt has limited Windows support](https://github.com/AGWA/git-crypt/blob/master/INSTALL.md))
27+
28+
To install git-crypt system-wide (outside VSCode), run the **git-crypt: Install git-crypt to system PATH** command from the command palette.
2629

2730
## Install
2831

0 commit comments

Comments
 (0)