dotshield 0.1.0-beta.3 → 0.1.0-beta.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +93 -5
  2. package/checksums.json +18 -18
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1,12 +1,100 @@
1
1
  # dotshield
2
2
 
3
- Keeps secrets away from AI coding agents (Claude Code and Cursor): a free offline scanner, and a guard that stops agents from reading or printing secrets.
3
+ **Keeps secrets away from AI coding agents.** DotShield stops Claude Code and Cursor from reading or printing your secrets (API keys, tokens, `.env` files, private keys), and includes a free offline scanner that finds the secrets already sitting in your projects, your git history and your agents' transcripts.
4
+
5
+ > **Public beta.** This is `0.1.0-beta`. It works, it is tested, and we want your feedback. See [The beta](#the-beta) below for what we ask of testers.
6
+
7
+ ## What it does
8
+
9
+ - **Scan:** finds secrets in a folder, its git history and your AI agent files (Claude Code transcripts and settings, Cursor MCP config). Works offline and never prints a secret value.
10
+ - **Fix:** redacts secrets in agent transcripts (after a private backup), adds secret files to `.gitignore` and `.cursorignore`, adds Claude Code deny rules, and lists every secret you should rotate. It shows the plan and asks first.
11
+ - **Guard:** runs as Claude Code (or Cursor) hooks:
12
+ - denies reads of secret files;
13
+ - masks secrets in command output;
14
+ - stops prompts that contain a secret;
15
+ - masks secrets left in transcripts when a session ends.
16
+ - **Pre-commit:** stops git commits that contain secrets.
17
+
18
+ It starts in **watch mode**, which only logs what it would have done and blocks nothing, so you can see it work before you let it block.
19
+
20
+ ## Install
21
+
22
+ Needs macOS, Linux or Windows, on x64 or arm64.
4
23
 
5
24
  ```bash
6
- npx dotshield scan # find secrets in this folder, its git history and your agent files
7
- npx dotshield guard install # guard Claude Code, in watch mode first
25
+ npx dotshield@beta scan # try it without installing (Node 18 or later)
26
+ npm install -g dotshield@beta # or install the dotshield command
27
+ brew install dot-shield/dotshield/dotshield # or with Homebrew (macOS, Linux)
8
28
  ```
9
29
 
10
- This package is a small wrapper with no dependencies and no install script. On first use it downloads the `dotshield` binary for your system from the matching GitHub release, checks its SHA-256 against checksums taken from the release's signed `checksums.txt` and published in this package, and keeps it in `~/.dotshield/bin/`. Agent hooks call that binary directly.
30
+ ## Quick start
31
+
32
+ ```bash
33
+ dotshield scan # find secrets here, in git history and in agent files
34
+ dotshield fix # clean them up (shows the plan, asks first)
35
+ dotshield guard install # guard Claude Code (starts in watch mode)
36
+ dotshield guard install --agent cursor # or Cursor; --agent both for both
37
+ dotshield guard status # where it's installed, its mode, where it logs
38
+ dotshield guard report # what it did, or would have done
39
+ dotshield guard mode enforce # start blocking
40
+ ```
41
+
42
+ New Claude Code and Cursor sessions pick up the guard. Sessions that are already open don't.
43
+
44
+ ## Commands
45
+
46
+ | command | what it does |
47
+ | --- | --- |
48
+ | `dotshield scan [path]` | find secrets. `--json` or `--format sarif` for tools, `--no-history` to skip git history |
49
+ | `dotshield fix [path]` | redact agent transcripts, add ignore and deny rules, list secrets to rotate. `--dry-run` to only show the plan |
50
+ | `dotshield guard install` | add the guard hooks. `--agent cursor` or `--agent both` |
51
+ | `dotshield guard mode watch\|enforce` | log only, or block |
52
+ | `dotshield guard report` | sum up what the guard did. `--days 14 --json` for the beta report |
53
+ | `dotshield guard check` | show what the guard would do with a read or a command |
54
+ | `dotshield guard uninstall` | remove the hooks |
55
+ | `dotshield precommit install` | add a git pre-commit hook to the current repository |
56
+ | `dotshield allow fingerprint <fp>` | a finding isn't a secret: stop flagging it (the 12 characters DotShield prints) |
57
+ | `dotshield allow path <path>` | let agents read a file that looks secret but isn't, such as a test fixture |
58
+ | `dotshield allow list` | show the allowlist |
59
+ | `dotshield redact [file]` | print a file or stdin with its secrets masked |
60
+ | `dotshield version` | print the version |
61
+
62
+ Agents can't run `allow`, `guard mode` or `guard uninstall`: DotShield denies them, so an agent can't switch it off for you.
63
+
64
+ ## The beta
65
+
66
+ Thank you for trying it. The beta takes two weeks:
67
+
68
+ 1. **Week 1, watch.** Run `dotshield guard install` and work as usual. Now and then, run `dotshield guard report` to see what it would have blocked.
69
+ 2. **Week 2, enforce.** Run `dotshield guard mode enforce`. If it blocks something that isn't a secret, use `dotshield allow fingerprint <fp>` or `dotshield allow path <path>`. That is also how the beta counts false blocks. If it gets in your way, `dotshield guard mode watch` turns blocking off. Please tell us why.
70
+ 3. **At the end, send your report.**
71
+
72
+ ```bash
73
+ dotshield guard report --days 14 --json > dotshield-beta.json
74
+ ```
75
+
76
+ Read it first: it holds only counts, rule ids, dates and timings (how many calls were checked, DotShield's time per call, blocks, how many you allowlisted, when you changed mode). It never holds a file path, a file's contents or a secret value. **Don't send** the log behind it (`~/.dotshield/log/guard.jsonl`), because it contains file paths.
77
+
78
+ **Send it with the [beta report form](https://github.com/dot-shield/dotshield-releases/issues/new?template=beta-report.yml)**, along with anything that surprised you, got in your way or was missing. Reports are public GitHub issues, which is why the report holds nothing sensitive. Bugs and questions are welcome any time, [as an issue](https://github.com/dot-shield/dotshield-releases/issues).
79
+
80
+ ## Privacy
81
+
82
+ DotShield has no network code. Nothing you scan or guard leaves your machine, and the beta report goes out only when you send it yourself. The one network call is the first-run download of the binary, described below.
83
+
84
+ ## How the binary gets to you
85
+
86
+ This npm package is a small wrapper with no dependencies and no install script. On first use it downloads the `dotshield` binary for your system from [the GitHub release](https://github.com/dot-shield/dotshield-releases/releases) of the same version. It checks the binary's SHA-256 against checksums taken from the release's signed `checksums.txt` and published inside this package, and keeps it in `~/.dotshield/bin/`. It checks the binary again on every run. The agent hooks call the binary directly, so Node isn't on the hook path.
87
+
88
+ ## Uninstall
89
+
90
+ ```bash
91
+ dotshield guard uninstall # remove the hooks from Claude Code (--agent cursor or both)
92
+ npm uninstall -g dotshield # or: brew uninstall dotshield
93
+ rm -rf ~/.dotshield # optional: the binary, your allowlist and the local log
94
+ ```
95
+
96
+ ## Licence
97
+
98
+ Free to use, including at work, under the DotShield Free Use Licence (the `LICENSE` file in this package): no redistribution, modified copies, reverse engineering or competing products.
11
99
 
12
- Downloads and docs: https://github.com/dot-shield/dotshield-releases. Not affiliated with Anthropic or Cursor.
100
+ DotShield is not affiliated with or endorsed by Anthropic or Cursor.
package/checksums.json CHANGED
@@ -1,26 +1,26 @@
1
1
  {
2
- "dotshield_0.1.0-beta.3_darwin_arm64.tar.gz": {
3
- "archive": "764ed14e0f917107429b924940f950e23a3a9e441c5a29ae54e4bff33f7aca39",
4
- "binary": "b668ca0bb1e2c3e8d2f8480dfaffc5a7dddeefd8e9ed7ab9818adce473b1c98b"
2
+ "dotshield_0.1.0-beta.4_darwin_arm64.tar.gz": {
3
+ "archive": "2e17a5a68a084218cd3b87ffddf89c6f734fa64b70f8e38db5a802fbf6131f94",
4
+ "binary": "a3fac0d815996fb607609306990c37b28b149b64290fb74308d07c9e5c2db678"
5
5
  },
6
- "dotshield_0.1.0-beta.3_darwin_amd64.tar.gz": {
7
- "archive": "e116d51be22ee25bd553faef27af9b0bb0811ba6b15cb635b8ca7c87ed76d6a2",
8
- "binary": "0241eaad50923016a79bf1cf92f25e4b80128fc09cf2a2e45a32917c700d61a7"
6
+ "dotshield_0.1.0-beta.4_darwin_amd64.tar.gz": {
7
+ "archive": "b270eb971f83b1966a40983048b4c293f180295fd9f4c6e59a40d70b0d7248ab",
8
+ "binary": "87cb3d2fac44ed379ebaf10be0e16acbd5bec37097a032a122e97f0096941efc"
9
9
  },
10
- "dotshield_0.1.0-beta.3_linux_arm64.tar.gz": {
11
- "archive": "f68a309b2f8de864993c55535def65216eba57b6cae85d1ae7a47c80a6b96089",
12
- "binary": "6a13a9172d1be7b01d5f4fe91011ebde41a4ddc0784195a03b8e2eeefd852175"
10
+ "dotshield_0.1.0-beta.4_linux_arm64.tar.gz": {
11
+ "archive": "986e7dd06c5327b05082a403c0498abcbed3344123b638f9dbb64dec2ae2fca0",
12
+ "binary": "93be3d213349c154220f9252b2c93a20baf399fc2d31f9916ca5abd1cebb7f31"
13
13
  },
14
- "dotshield_0.1.0-beta.3_linux_amd64.tar.gz": {
15
- "archive": "575c6247f05b331f678a45badfd69e2a5750201d65ca402893c1056558d6f10f",
16
- "binary": "7e71b517c4ec9ae2c9a721a16fa25327fe960712978a430a6edd314af999c6c8"
14
+ "dotshield_0.1.0-beta.4_linux_amd64.tar.gz": {
15
+ "archive": "a639ba6266274d86c66484c79b71a746b9826b5e2013fb60921cbd5d2e38eb0c",
16
+ "binary": "f274762ba78adc7498bba6643be98e7f90570165a7d1b02d9efb286a48c7eba1"
17
17
  },
18
- "dotshield_0.1.0-beta.3_windows_arm64.zip": {
19
- "archive": "c969b468a093c38316c8faa653903d7d79e212aebe7f21dcf853b81ea05d50bc",
20
- "binary": "5061d13882de6e47e1a5c3835e7d06168e17df129e039f19f9cbcd8514773d2f"
18
+ "dotshield_0.1.0-beta.4_windows_arm64.zip": {
19
+ "archive": "496e23e1a976e59e990299cacd576d26492e651a3261d94333e8c3ec4cb8779d",
20
+ "binary": "e13dc52429c60c6f5ed91a01570655f2fed726e315f611b5057731edc8cc8359"
21
21
  },
22
- "dotshield_0.1.0-beta.3_windows_amd64.zip": {
23
- "archive": "18576cd86d9760e4de502a30ff69a69dafcfcbaf7f57a04243d6c995714bfbef",
24
- "binary": "9b3a577436a215509e8e59a09904463decf2fd53dc24fb13837f30602d43be55"
22
+ "dotshield_0.1.0-beta.4_windows_amd64.zip": {
23
+ "archive": "3fc6a95ed126e666cd1c5681b9cd686b801055ef4d2a8f0230a3ac2ab3b9dc31",
24
+ "binary": "ed5db8dfebfc55d946137ee3ec6bb5457fe45dd49ba083d0897f10b828604d8d"
25
25
  }
26
26
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "dotshield",
3
- "version": "0.1.0-beta.3",
3
+ "version": "0.1.0-beta.4",
4
4
  "description": "Keeps secrets away from AI coding agents. This package runs the signed dotshield binary.",
5
5
  "license": "SEE LICENSE IN LICENSE",
6
6
  "homepage": "https://github.com/dot-shield/dotshield-releases",