@keeper-security/rules-darwin-arm64 1.5.0 → 1.5.2
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.
- package/README.md +35 -17
- package/bin/keeper-rules +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,34 +1,52 @@
|
|
|
1
|
-
|
|
1
|
+
<div align="center">
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Centralized AI assistant rules for Keeper Security.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
One command to sync rules across Claude Code, Cursor, GitHub Copilot, and other AI tools.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Built on top of [rulesync](https://github.com/dyoshikawa/rulesync), inspired by [skills.sh](https://github.com/vercel-labs/skills).
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
</div>
|
|
10
|
+
|
|
11
|
+
## Quick Start
|
|
12
|
+
|
|
13
|
+
**Recommended:** Use `npx -y @keeper-security/rules` to run without installing.
|
|
14
|
+
|
|
15
|
+
You can also `npm install -g @keeper-security/rules` to get the `keeper-rules` binary globally.
|
|
16
|
+
|
|
17
|
+
First, clone this repository as it serves as your source of truth:
|
|
10
18
|
|
|
11
19
|
```bash
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
20
|
+
git clone https://github.com/Keeper-Security/keeper-rules.git
|
|
21
|
+
cd keeper-rules
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
### Add Product
|
|
25
|
+
|
|
26
|
+
Run `add-product` to create a new product rules directory:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
npx -y @keeper-security/rules add-product <name>
|
|
16
30
|
```
|
|
17
31
|
|
|
18
|
-
|
|
32
|
+
### Sync
|
|
33
|
+
|
|
34
|
+
After your changes land in `main`, run `sync` in another repo to pull rules down:
|
|
19
35
|
|
|
20
36
|
```bash
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
37
|
+
npx -y @keeper-security/rules sync <name>
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Commands
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
npx -y @keeper-security/rules sync <name> # Sync rules to project
|
|
44
|
+
npx -y @keeper-security/rules add-product <name> # Create new product
|
|
45
|
+
npx -y @keeper-security/rules list # List products
|
|
24
46
|
```
|
|
25
47
|
|
|
26
48
|
## Docker
|
|
27
49
|
|
|
28
50
|
```bash
|
|
29
|
-
cd cli && task docker
|
|
30
|
-
docker run --rm keepersecurityinc/rules list
|
|
31
|
-
docker run -v ~/.gitconfig:/root/.gitconfig keepersecurityinc/rules sync default
|
|
32
|
-
# Sync into project:
|
|
33
51
|
docker run -v ~/.gitconfig:/root/.gitconfig -v $(pwd):/app -w /app keepersecurityinc/rules sync default
|
|
34
52
|
```
|
package/bin/keeper-rules
CHANGED
|
Binary file
|