@@ -8,33 +8,31 @@ Workspace Guard is a TypeScript library and CLI for reducing the risk of opening
88- Extension-host helpers for workspace detection and guarded actions
99- Telemetry hardening helpers with rollback support
1010
11- ## Project Layout
11+ ## TL;DR
1212
13- - ` src/core/pathPolicy.ts ` : path expansion, normalization, ` realpath ` , and risk classification
14- - ` src/core/escapeFolder.ts ` : escape-folder resolution and initialization
15- - ` src/cli/homeguardCode.ts ` : CLI planning and ` code ` process execution
16- - ` src/extension/homeguardExtension.ts ` : workspace detection and activation flow
17- - ` src/extension/workspaceSafetyGuard.ts ` : action-level guards for save/git/terminal/task/publish
18- - ` src/core/telemetry.ts ` : telemetry audit and hardening profile
19- - ` src/core/settingsBackup.ts ` : settings backup and rollback
13+ - Use ` homeguard-code ` to stop accidental ` ~ ` opens in VS Code
14+ - Use ` workspace-guard-scan ` to review ` .github ` automation risk before trusting a repo
15+ - Publish the extension through the GitHub ` Release Extension ` workflow with ` VSCE_PAT `
2016
21- ## Install
17+ ## Quick Start
2218
2319``` bash
2420npm install
25- ```
26-
27- ## Build
28-
29- ``` bash
3021npm run build
22+ npm test
23+ npx homeguard-code ~
24+ npx workspace-guard-scan .
3125```
3226
33- ## Test
27+ ## Project Layout
3428
35- ``` bash
36- npm test
37- ```
29+ - ` src/core/pathPolicy.ts ` : path expansion, normalization, ` realpath ` , and risk classification
30+ - ` src/core/escapeFolder.ts ` : escape-folder resolution and initialization
31+ - ` src/cli/homeguardCode.ts ` : CLI planning and ` code ` process execution
32+ - ` src/extension/homeguardExtension.ts ` : workspace detection and activation flow
33+ - ` src/extension/workspaceSafetyGuard.ts ` : action-level guards for save/git/terminal/task/publish
34+ - ` src/core/telemetry.ts ` : telemetry audit and hardening profile
35+ - ` src/core/settingsBackup.ts ` : settings backup and rollback
3836
3937## CI
4038
0 commit comments