Skip to content

Commit 25140d5

Browse files
docs: improve onboarding with init command
1 parent bd9414d commit 25140d5

1 file changed

Lines changed: 13 additions & 3 deletions

File tree

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,14 @@ It detects direct and transitive architectural violations via dependency graph a
1313
Run without installing:
1414

1515
```bash
16+
npx truss-lint init
1617
npx truss-lint check
1718
```
1819

1920
Or install globally:
20-
2121
```bash
2222
npm install -g truss-lint
23+
truss-lint init
2324
truss-lint check
2425
```
2526

@@ -76,9 +77,18 @@ npx truss-lint check
7677

7778
---
7879

79-
### 2. Create a config file
80+
## 2. Initialize configuration
81+
82+
Create a starter configuration file in your project:
83+
84+
```bash
85+
npx truss-lint init
86+
```
87+
This will generate a truss.yml file in your project root.
88+
89+
## 3. Configure layers and rules
8090

81-
Add a `truss.yml` file to your project root:
91+
Edit the generated truss.yml to define your architecture:
8292

8393
```yaml
8494
version: "1"

0 commit comments

Comments
 (0)