architect-ai 1.1.0 → 1.1.1
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 +14 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
> **Your 24/7 Virtual Technical Lead.**
|
|
4
4
|
> High-performance CLI tool to automate code reviews, enforce architectural patterns, and maintain clean code at scale using Generative AI.
|
|
5
5
|
|
|
6
|
-
[](https://www.npmjs.com/)
|
|
7
|
-
[](https://github.com/minhnn/architect-ai)
|
|
6
|
+
[](https://www.npmjs.com/package/architect-ai)
|
|
7
|
+
[](https://github.com/peter-minhnn/architect-ai)
|
|
8
8
|
[](https://deepmind.google/technologies/gemini/)
|
|
9
9
|
[]()
|
|
10
10
|
|
|
@@ -27,18 +27,18 @@ Traditional tools like **ESLint** or **Prettier** are great for syntax and forma
|
|
|
27
27
|
|
|
28
28
|
```bash
|
|
29
29
|
# Run once without installing
|
|
30
|
-
npx
|
|
30
|
+
npx architect-ai
|
|
31
31
|
|
|
32
32
|
# Or install globally
|
|
33
|
-
npm install -g
|
|
33
|
+
npm install -g architect-ai
|
|
34
34
|
|
|
35
35
|
# Or add as dev dependency (recommended)
|
|
36
|
-
npm install -D
|
|
37
|
-
# pnpm add -D
|
|
38
|
-
# yarn add -D
|
|
36
|
+
npm install -D architect-ai
|
|
37
|
+
# pnpm add -D architect-ai
|
|
38
|
+
# yarn add -D architect-ai
|
|
39
39
|
```
|
|
40
40
|
|
|
41
|
-
##
|
|
41
|
+
## 🛠️ CLI Usage
|
|
42
42
|
|
|
43
43
|
```bash
|
|
44
44
|
# Default: Audit commit message + changed files
|
|
@@ -89,7 +89,7 @@ Create a `.architectrc.json` in your project root to customize rules and perform
|
|
|
89
89
|
}
|
|
90
90
|
```
|
|
91
91
|
|
|
92
|
-
###
|
|
92
|
+
### 🔑 Environment Variables
|
|
93
93
|
|
|
94
94
|
```bash
|
|
95
95
|
# Required: Get your key at https://aistudio.google.com/
|
|
@@ -106,7 +106,7 @@ TARGET_BRANCH=origin/main
|
|
|
106
106
|
ArchitectAI can be used as a library in your own Node.js scripts.
|
|
107
107
|
|
|
108
108
|
```typescript
|
|
109
|
-
import { auditFilesWithConcurrency, loadProjectConfig } from '
|
|
109
|
+
import { auditFilesWithConcurrency, loadProjectConfig } from 'architect-ai';
|
|
110
110
|
|
|
111
111
|
const config = await loadProjectConfig();
|
|
112
112
|
const results = await auditFilesWithConcurrency(
|
|
@@ -142,7 +142,8 @@ jobs:
|
|
|
142
142
|
env:
|
|
143
143
|
GEMINI_API_KEY: ${{ secrets.GEMINI_API_KEY }}
|
|
144
144
|
TARGET_BRANCH: origin/${{ github.base_ref }}
|
|
145
|
-
run: npx
|
|
145
|
+
run: npx architect-ai
|
|
146
|
+
```
|
|
146
147
|
|
|
147
148
|
### GitLab CI (`.gitlab-ci.yml`)
|
|
148
149
|
|
|
@@ -158,7 +159,7 @@ audit:
|
|
|
158
159
|
- git fetch origin main
|
|
159
160
|
script:
|
|
160
161
|
- export TARGET_BRANCH="origin/${CI_MERGE_REQUEST_TARGET_BRANCH_NAME:-main}"
|
|
161
|
-
- npx
|
|
162
|
+
- npx architect-ai --target-branch $TARGET_BRANCH
|
|
162
163
|
variables:
|
|
163
164
|
GEMINI_API_KEY: $GEMINI_API_KEY
|
|
164
165
|
rules:
|
|
@@ -178,5 +179,5 @@ audit:
|
|
|
178
179
|
---
|
|
179
180
|
|
|
180
181
|
## 🛡️ License
|
|
181
|
-
Copyright © 2026
|
|
182
|
+
Copyright © 2026 Nguyen Nhat Minh. All rights reserved.
|
|
182
183
|
Distributed under the MIT License.
|