@snelusha/noto 1.0.0 → 1.0.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 +102 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
<h1 align="center">noto ✨</h1>
|
|
2
|
+
<p align="center"><sup>(/nōto/, <em>notebook</em> in Japanese)</sup></p>
|
|
3
|
+
<img src="https://github.com/snelusha/static/blob/main/noto/banner.png?raw=true" align="center"></img>
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- **Instant Commit Messages**: Generate clear, context-aware messages based on staged changes.
|
|
8
|
+
|
|
9
|
+
- **Seamless Git Integration**: Apply messages directly, skip the copy-paste.
|
|
10
|
+
|
|
11
|
+
- **Interactive Editing:** Easily refine your commit message with the new `--edit` flag.
|
|
12
|
+
|
|
13
|
+
- **Enhanced Configuration:** Manage your LLM model preferences with an improved configuration interface.
|
|
14
|
+
|
|
15
|
+
## Installation
|
|
16
|
+
|
|
17
|
+
Install noto globally using npm:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npm install -g @snelusha/noto
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
After installation, you can run `noto` from any terminal.
|
|
24
|
+
|
|
25
|
+
## Prerequisites
|
|
26
|
+
|
|
27
|
+
Before using noto, you must configure your [Google Generative API](https://aistudio.google.com/app/apikey) key. Run the following command to set it up:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
noto config key # or simply noto config key YOUR_API_KEY
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Optionally, if you wish to configure a different Gemini model (the default model will be used if not configured), run:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
noto config model
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Usage
|
|
40
|
+
|
|
41
|
+
Generate a new commit message:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
noto
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Apply the generated commit message to your current commit:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
noto --apply # or simply noto -a
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Copy the generated commit message to your clipboard:
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
noto --copy # or simply noto -c
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Specify the commit type for your commit message:
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
noto --type # or simply noto -t
|
|
63
|
+
|
|
64
|
+
noto --type chore # or simply noto -t chore
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Open an interactive editor to refine the generated commit message:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
noto --edit # or simply noto -e
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Combine all flags to specify the commit type, open the interactive editor, and apply the generated commit message in one go:
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
noto --edit --type feat --apply # or simply: noto -e -t feat -a
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
This command will generate a commit message for a "feat" commit, let you refine it interactively, and then apply it directly to your current commit.
|
|
80
|
+
|
|
81
|
+
Retrieve the previously generated commit message:
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
noto prev
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
Note: All of the flags shown above (`--apply`, `--copy`, `--type`, `--edit`) can also be used with the `noto prev` command to work with the previously generated commit message.
|
|
88
|
+
|
|
89
|
+
## Pro Tips
|
|
90
|
+
|
|
91
|
+
- 🚀 Get fast commits on the fly with `noto -e -a` to streamline your workflow!
|
|
92
|
+
|
|
93
|
+
## Contributing
|
|
94
|
+
|
|
95
|
+
We welcome contributions and suggestions! If you have ideas or improvements, feel free to reach out or open a pull request.
|
|
96
|
+
|
|
97
|
+
Thank you for using `noto`! If you have any feedback or suggestions, feel free to reach out or contribute to the project. ✨
|
|
98
|
+
|
|
99
|
+
## License
|
|
100
|
+
|
|
101
|
+
This project is licensed under the MIT License.
|
|
102
|
+
© 2024 [Sithija Nelusha Silva](https://github.com/snelusha)
|