rulesync-cli 0.1.3 → 0.1.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.
- package/README.md +44 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# rulesync-cli
|
|
2
|
+
|
|
3
|
+
CLI to sync `CLAUDE.md` files across repos via [RuleSync](https://rulesync.dev).
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g rulesync-cli
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
rulesync-cli <command>
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
If no command is given, `pull` is run by default.
|
|
18
|
+
|
|
19
|
+
### Commands
|
|
20
|
+
|
|
21
|
+
| Command | Description |
|
|
22
|
+
| -------- | ------------------------------------------------ |
|
|
23
|
+
| `login` | Authenticate with your RuleSync API key |
|
|
24
|
+
| `init` | Initialize `.rulesync.json` in the current project |
|
|
25
|
+
| `pull` | Fetch rulesets and write the rules file |
|
|
26
|
+
| `push` | Upload local rules file as a new ruleset version |
|
|
27
|
+
| `status` | Show current config and auth status |
|
|
28
|
+
|
|
29
|
+
## Quick Start
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
# 1. Authenticate
|
|
33
|
+
rulesync-cli login
|
|
34
|
+
|
|
35
|
+
# 2. Initialize a project
|
|
36
|
+
rulesync-cli init
|
|
37
|
+
|
|
38
|
+
# 3. Pull rulesets into your project
|
|
39
|
+
rulesync-cli pull
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## License
|
|
43
|
+
|
|
44
|
+
MIT
|