ai-rulez 3.3.2 → 3.4.0

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 (2) hide show
  1. package/README.md +27 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -431,6 +431,33 @@ includes:
431
431
  - `merge_strategy`: How to handle conflicts (`local-override`, `remote-override`)
432
432
  - `ref`: Branch, tag, or commit SHA
433
433
 
434
+ **Authenticating to Private Repositories:**
435
+
436
+ When including rules from private Git repositories, you can provide an access token for authentication:
437
+
438
+ ```bash
439
+ # Using environment variable (recommended for CI/CD)
440
+ export AI_RULEZ_GIT_TOKEN="ghp_your_github_token_here"
441
+ ai-rulez generate
442
+
443
+ # Using CLI flag
444
+ ai-rulez generate --token "ghp_your_github_token_here"
445
+ ```
446
+
447
+ How to create access tokens:
448
+
449
+ - **GitHub**: Settings → Developer settings → Personal access tokens → Generate new token (classic)
450
+ - Required scope: `repo` (for private repositories)
451
+ - **GitLab**: Settings → Access Tokens → Add new token
452
+ - Required scope: `read_repository`
453
+
454
+ **Security best practices:**
455
+ - Never commit tokens to your repository
456
+ - Use environment variables in CI/CD pipelines
457
+ - Store tokens in secure secret management systems
458
+ - Rotate tokens regularly
459
+ - Use tokens with minimal required permissions
460
+
434
461
  See the [Includes documentation](https://goldziher.github.io/ai-rulez/includes/) for more details.
435
462
 
436
463
  </details>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ai-rulez",
3
- "version": "3.3.2",
3
+ "version": "3.4.0",
4
4
  "description": "⚡ One config to rule them all. Centralized AI assistant configuration management - generate rules for Claude, Cursor, Copilot, Windsurf and more from a single YAML file.",
5
5
  "keywords": [
6
6
  "ai",