commentme 1.0.3 → 1.0.5
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 +26 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -35,6 +35,29 @@ commentme --skim "file-name"
|
|
|
35
35
|
### Restore comments to a file
|
|
36
36
|
commentme --unskim "file-name"
|
|
37
37
|
|
|
38
|
+
### AI Generation
|
|
39
|
+
Generate AI comments and JSDoc-style documentation for your code.
|
|
40
|
+
```bash
|
|
41
|
+
commentme --generate "file-name"
|
|
42
|
+
```
|
|
43
|
+
You can choose to generate comments per function, per class, or per line.
|
|
44
|
+
|
|
45
|
+
### AI Explanation
|
|
46
|
+
Generate a full markdown explanation of a code file.
|
|
47
|
+
```bash
|
|
48
|
+
commentme --explain "file-name"
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### API Key Management
|
|
52
|
+
Set your own OpenRouter API key to use the AI features.
|
|
53
|
+
```bash
|
|
54
|
+
# Set your API key
|
|
55
|
+
commentme --set-key
|
|
56
|
+
|
|
57
|
+
# Clear your saved API key
|
|
58
|
+
commentme --clear-key
|
|
59
|
+
```
|
|
60
|
+
|
|
38
61
|
### Logout
|
|
39
62
|
commentme --logout
|
|
40
63
|
|
|
@@ -43,6 +66,9 @@ commentme --logout
|
|
|
43
66
|
- Clutter-free and smooth codebase
|
|
44
67
|
- Redact comments from files while keeping references
|
|
45
68
|
- Restore comments back to files whenever required
|
|
69
|
+
- **AI-powered documentation generation (Function/Class/Line level)**
|
|
70
|
+
- **Full code explanation generator (Markdown output)**
|
|
71
|
+
- **Secure API Key management for custom AI models**
|
|
46
72
|
- User authentication and session management
|
|
47
73
|
- Per-codebase comment organization
|
|
48
74
|
- Dedicated website for more UI friendly & AI edits on comments
|