dev-doc 0.2.12 → 0.2.13
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 +28 -4
- package/dist/cli.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -49,17 +49,30 @@ You'll see a confirmation with your quota and usage information.
|
|
|
49
49
|
|
|
50
50
|
### Step 4: Analyze Your Codebase
|
|
51
51
|
|
|
52
|
+
```bash
|
|
53
|
+
dev-doc
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Or analyze a specific directory:
|
|
57
|
+
|
|
52
58
|
```bash
|
|
53
59
|
dev-doc ./src
|
|
54
60
|
```
|
|
55
61
|
|
|
56
62
|
That's it! Your analysis will be processed in the background and saved to your dashboard. The CLI will exit immediately after queuing the analysis.
|
|
57
63
|
|
|
64
|
+
**Note:** Running `dev-doc` without arguments analyzes the current directory, making it perfect for running from your project root.
|
|
65
|
+
|
|
58
66
|
## 📖 Usage
|
|
59
67
|
|
|
60
68
|
### Basic Commands
|
|
61
69
|
|
|
62
|
-
**Analyze
|
|
70
|
+
**Analyze current directory:**
|
|
71
|
+
```bash
|
|
72
|
+
dev-doc
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
**Analyze a specific directory:**
|
|
63
76
|
```bash
|
|
64
77
|
dev-doc ./src
|
|
65
78
|
```
|
|
@@ -92,21 +105,32 @@ dev-doc ./src --ignore node_modules,dist,tests,.next
|
|
|
92
105
|
|
|
93
106
|
## 📋 Examples
|
|
94
107
|
|
|
95
|
-
### Analyze
|
|
108
|
+
### Analyze current directory (most common)
|
|
96
109
|
|
|
97
110
|
```bash
|
|
98
|
-
dev-doc
|
|
111
|
+
dev-doc
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
This analyzes the current directory - perfect when you're in your project root!
|
|
115
|
+
|
|
116
|
+
### Analyze a specific directory
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
dev-doc ./src
|
|
120
|
+
dev-doc ./backend
|
|
99
121
|
```
|
|
100
122
|
|
|
101
|
-
### Analyze
|
|
123
|
+
### Analyze with custom project name
|
|
102
124
|
|
|
103
125
|
```bash
|
|
126
|
+
dev-doc --project-name "api-backend"
|
|
104
127
|
dev-doc ./src --project-name "api-backend"
|
|
105
128
|
```
|
|
106
129
|
|
|
107
130
|
### Exclude test files and build directories
|
|
108
131
|
|
|
109
132
|
```bash
|
|
133
|
+
dev-doc --ignore tests,coverage,build,.next
|
|
110
134
|
dev-doc ./src --ignore tests,coverage,build,.next
|
|
111
135
|
```
|
|
112
136
|
|
package/dist/cli.js
CHANGED
|
@@ -47,7 +47,7 @@ const API_URL = "https://dev-doc-726dc734499e.herokuapp.com"; // TODO: Update to
|
|
|
47
47
|
program
|
|
48
48
|
.name("dev-doc")
|
|
49
49
|
.description("AI-powered codebase analyzer AI")
|
|
50
|
-
.version("0.2.
|
|
50
|
+
.version("0.2.13");
|
|
51
51
|
// Add API key command
|
|
52
52
|
program
|
|
53
53
|
.command("add-key")
|