commentme 1.0.4 → 1.0.6
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 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,37 +3,56 @@
|
|
|
3
3
|
An Open Source CLI tool connected with its own website to manage and store your cluttered-code comments and give the codebase a clean look. Extract comments from your code files, store them in a database, visit commentme platform for UI-friendly seek and restore your comments line-wise later.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
|
-
|
|
6
|
+
```bash
|
|
7
7
|
npm install -g commentme
|
|
8
|
+
```
|
|
8
9
|
|
|
9
10
|
## Usage
|
|
10
11
|
|
|
11
12
|
### Show help
|
|
13
|
+
```bash
|
|
12
14
|
commentme --help
|
|
15
|
+
```
|
|
13
16
|
|
|
14
17
|
### Signup
|
|
18
|
+
```bash
|
|
15
19
|
commentme --signup
|
|
20
|
+
```
|
|
16
21
|
|
|
17
22
|
### Login
|
|
23
|
+
```bash
|
|
18
24
|
commentme --login
|
|
25
|
+
```
|
|
19
26
|
|
|
20
27
|
### Get all comments
|
|
28
|
+
```bash
|
|
21
29
|
commentme --get lines "file-name"
|
|
30
|
+
```
|
|
22
31
|
|
|
23
32
|
### Get a specific comment
|
|
33
|
+
```bash
|
|
24
34
|
commentme --get line-7-7 "file-name"
|
|
35
|
+
```
|
|
25
36
|
|
|
26
37
|
### Edit a comment
|
|
38
|
+
```bash
|
|
27
39
|
commentme --edit line-7-7 "file-name"
|
|
40
|
+
```
|
|
28
41
|
|
|
29
42
|
### Delete a comment
|
|
43
|
+
```bash
|
|
30
44
|
commentme --delete line-7-7 "file-name"
|
|
45
|
+
```
|
|
31
46
|
|
|
32
47
|
### Redact comments from a file
|
|
48
|
+
```bash
|
|
33
49
|
commentme --skim "file-name"
|
|
50
|
+
```
|
|
34
51
|
|
|
35
52
|
### Restore comments to a file
|
|
53
|
+
```bash
|
|
36
54
|
commentme --unskim "file-name"
|
|
55
|
+
```
|
|
37
56
|
|
|
38
57
|
### AI Generation
|
|
39
58
|
Generate AI comments and JSDoc-style documentation for your code.
|
|
@@ -59,19 +78,21 @@ commentme --clear-key
|
|
|
59
78
|
```
|
|
60
79
|
|
|
61
80
|
### Logout
|
|
81
|
+
```bash
|
|
62
82
|
commentme --logout
|
|
83
|
+
```
|
|
63
84
|
|
|
64
85
|
## Features
|
|
65
86
|
|
|
66
|
-
- Clutter-free and smooth codebase
|
|
67
|
-
- Redact comments from files while keeping references
|
|
68
|
-
- Restore comments back to files whenever required
|
|
87
|
+
- **Clutter-free and smooth codebase**
|
|
88
|
+
- **Redact comments from files while keeping references**
|
|
89
|
+
- **Restore comments back to files whenever required**
|
|
69
90
|
- **AI-powered documentation generation (Function/Class/Line level)**
|
|
70
91
|
- **Full code explanation generator (Markdown output)**
|
|
71
92
|
- **Secure API Key management for custom AI models**
|
|
72
|
-
- User authentication and session management
|
|
73
|
-
- Per-codebase comment organization
|
|
74
|
-
- Dedicated website for more UI friendly & AI edits on comments
|
|
93
|
+
- **User authentication and session management**
|
|
94
|
+
- **Per-codebase comment organization**
|
|
95
|
+
- **Dedicated website for more UI friendly & AI edits on comments**
|
|
75
96
|
|
|
76
97
|
## Requirements
|
|
77
98
|
|