gpt_helpr 0.2.1 → 0.2.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +60 -53
- data/lib/gpt_helpr/version.rb +1 -1
- metadata +29 -25
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: cfabf37973f5cac3d009a1779db5952d907078952a84327e97f888ba5a9f5aad
|
4
|
+
data.tar.gz: 89e3a7625633e972ef758cd6da93d2e9cf9ab67972fffe464c844f6287b7f064
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: dffda688f7d9092f86ad498913694f950206c2fd952286bde125575166cc6a0032672657cb674c64f19f15a3ac94ef2eb94606160ef58a445e54ada53d9478c3
|
7
|
+
data.tar.gz: 11ac421b0b6eb0c77dd57b62556c079b92b4c48d9d68d91f97b150486fa127dcc6752c8e5e537165b9ec8f7f825892a289e1eebfde0dd442347087fc0b31b825
|
data/README.md
CHANGED
@@ -1,15 +1,17 @@
|
|
1
|
-
|
1
|
+
## == 🏴☠️ GptHelpr == Helping to dig your codebase and cook GPT-XX instructions
|
2
2
|
|
3
|
-
|
3
|
+
### What is GptHelpr?
|
4
4
|
|
5
|
-
|
5
|
+
It is sometime necessary to provide context and explanations for your code. Instead of manually copying and formatting code snippets, GPT-Helpr automates the process with an interactive cli, generating a well-structured Markdown output, which can be copied to your clipboard or printed to file.
|
6
|
+
|
7
|
+
### Features
|
6
8
|
|
7
9
|
- **Interactive Mode**: Easily specify file paths and ranges interactively.
|
8
10
|
- **Line Numbers**: Option to include line numbers in the output.
|
9
11
|
- **Completion Support**: Supports tab completion for file paths.
|
10
12
|
- **Output to File**: Option to write the generated output to a file.
|
11
13
|
|
12
|
-
|
14
|
+
### Installation
|
13
15
|
|
14
16
|
1. **Add the Gem to Your Gemfile**
|
15
17
|
```ruby
|
@@ -26,23 +28,23 @@ GPT_Helpr is a Ruby gem that provides a command-line tool for generating formatt
|
|
26
28
|
gem install gpt_helpr
|
27
29
|
```
|
28
30
|
|
29
|
-
|
31
|
+
### Usage
|
30
32
|
|
31
|
-
|
33
|
+
#### Basic Usage
|
32
34
|
|
33
35
|
Run the tool in interactive mode:
|
34
36
|
```sh
|
35
|
-
gpt_helpr
|
37
|
+
gpt_helpr -i -ln
|
36
38
|
```
|
37
39
|
|
38
|
-
|
40
|
+
#### Command-Line Arguments
|
39
41
|
|
40
42
|
You can also provide file paths and instructions directly via command-line arguments:
|
41
43
|
```sh
|
42
|
-
gpt_helpr <file1> <
|
44
|
+
gpt_helpr <file1> <instructions> / <file2> <instructions>
|
43
45
|
```
|
44
46
|
|
45
|
-
|
47
|
+
#### Options
|
46
48
|
|
47
49
|
- `--interactive` or `-i`: Run the tool in interactive mode.
|
48
50
|
- `--file` or `-f`: Write the output to a file.
|
@@ -52,41 +54,56 @@ gpt_helpr <file1> <re: instructions> / <file2> <re: instructions>
|
|
52
54
|
|
53
55
|
#### Interactive Mode
|
54
56
|
|
55
|
-
1. Run the tool:
|
56
|
-
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
|
57
|
+
1. Run the tool in interactive mode:
|
58
|
+
```sh
|
59
|
+
# note lmk is an alias for gpt_helpr -i -ln
|
60
|
+
$ lmk
|
61
|
+
== 🏴☠️ GptHelpr 0.2.2 == Helping to dig your codebase and cook GPT-XX instructions [current directory /Users/etozzato/WorkSpace/_AINZ/pizzatarians.com]
|
62
|
+
|
63
|
+
File Path (optional :start:end): TAB ->
|
64
|
+
favicon.ico hey.md js random-acts-of-pizza.md
|
65
|
+
_config.yml _site draft fonts
|
66
|
+
images kneading-baking-academy.md _exe academy
|
67
|
+
favicon.gif hands-in-dough.md index.md parties-and-events.md
|
68
|
+
|
69
|
+
File Path (optional :start:end): hey.md 1:22
|
70
|
+
Instructions: can you improve this text? Do you see any issues with the template?
|
71
|
+
File Path (optional :start:end):
|
72
|
+
|
73
|
+
# this is the generated output (also copied to the clipboard)
|
74
|
+
==== file source `hey.md 1:22`
|
75
|
+
|
76
|
+
1: ---
|
77
|
+
2: title: Hey, hello!
|
78
|
+
3: layout: default
|
79
|
+
4: ---
|
80
|
+
5:
|
81
|
+
6: # {{ page.title }}
|
82
|
+
7: ----
|
83
|
+
8:
|
84
|
+
9: <div class="row">
|
85
|
+
10: <div class="col-md-12">
|
86
|
+
11: <p class='justin'>
|
87
|
+
12: Nice to meet you, I am *Mek*!
|
88
|
+
13: </p>
|
89
|
+
14: <p class='listo'>
|
90
|
+
15: I am a self-proclaimed pizza guru and I am here to teach & learn. Originally from Venice, Italy you can find me in San Diego, CA.
|
91
|
+
16: </p>
|
92
|
+
17: <p class='listo'>
|
93
|
+
18: In my spare time, I write code @ PlayStation!
|
94
|
+
19: </p>
|
95
|
+
20: </div>
|
96
|
+
21: </div>
|
97
|
+
22:
|
98
|
+
|
99
|
+
can you improve this text? Do you see any issues with the template?
|
100
|
+
|
101
|
+
==== end of `hey.md`
|
102
|
+
```
|
84
103
|
|
85
|
-
|
86
|
-
```
|
87
|
-
3. You can add more files and instructions in the same way.
|
104
|
+
2. You can add more files and instructions in the same way.
|
88
105
|
|
89
|
-
|
106
|
+
3. Profit!
|
90
107
|
|
91
108
|
#### Command-Line Mode
|
92
109
|
|
@@ -100,16 +117,6 @@ File path (optional :start:end):
|
|
100
117
|
gpt_helpr app/controllers/pos_controller.rb:10:20 "Describe the controller logic" / app/views/pos/index.html.erb "Explain the view template" --file
|
101
118
|
```
|
102
119
|
|
103
|
-
## Why GPT_Helpr?
|
104
|
-
|
105
|
-
GPT_Helpr is designed to save time and effort when sharing code snippets. It's often necessary to provide context and explanations for the code. Instead of manually copying and formatting code snippets, GPT_Helpr automates the process, generating well-structured Markdown output.
|
106
|
-
|
107
|
-
This can be useful for:
|
108
|
-
|
109
|
-
- **Creating Documentation**: Quickly generate descriptions of code segments for documentation.
|
110
|
-
- **Sharing Code**: Share specific parts of your codebase with clear descriptions.
|
111
|
-
- **Teaching and Learning**: Provide examples and explanations of code in a consistent format.
|
112
|
-
|
113
120
|
## Contributing
|
114
121
|
|
115
122
|
Contributions are welcome! If you have suggestions for improvements or find any issues, please open an issue or create a pull request.
|
data/lib/gpt_helpr/version.rb
CHANGED
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: gpt_helpr
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.2.
|
4
|
+
version: 0.2.3
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Emanuele Tozzato
|
@@ -24,27 +24,30 @@ dependencies:
|
|
24
24
|
- - "~>"
|
25
25
|
- !ruby/object:Gem::Version
|
26
26
|
version: 0.0.3
|
27
|
-
description: "
|
28
|
-
code. Instead of manually copying and formatting code
|
29
|
-
the process with an interactive cli, generating a
|
30
|
-
which can be copied to your clipboard or printed
|
31
|
-
lmk is an alias for gpt_helpr -i -ln\n
|
32
|
-
Helping to dig your codebase and cook
|
33
|
-
|
34
|
-
\
|
35
|
-
\
|
36
|
-
\
|
37
|
-
\
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
#
|
42
|
-
\
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
27
|
+
description: "=== What is GptHelpr?\n\nIt is sometime necessary to provide context
|
28
|
+
and explanations for your code. Instead of manually copying and formatting code
|
29
|
+
snippets, GPT-Helpr automates the process with an interactive cli, generating a
|
30
|
+
well-structured Markdown output, which can be copied to your clipboard or printed
|
31
|
+
to file.\n\n=== Example Usage\n\n # note lmk is an alias for gpt_helpr -i -ln\n
|
32
|
+
\ $ lmk\n == \U0001F3F4☠️ GptHelpr 0.2.3 == Helping to dig your codebase and cook
|
33
|
+
GPT-XX instructions [current directory /Users/etozzato/WorkSpace/_AINZ/pizzatarians.com]\n\n
|
34
|
+
\ File Path (optional :start:end): TAB ->\n favicon.ico hey.md
|
35
|
+
\ js random-acts-of-pizza.md\n _config.yml
|
36
|
+
\ _site draft fonts\n
|
37
|
+
\ images kneading-baking-academy.md _exe academy\n
|
38
|
+
\ favicon.gif hands-in-dough.md index.md parties-and-events.md\n\n
|
39
|
+
\ File Path (optional :start:end): hey.md 1:22\n Instructions: can you improve
|
40
|
+
this text? Do you see any issues with the template?\n File Path (optional :start:end):\n\n
|
41
|
+
\ # this is the generated output (also copied to the clipboard)\n ==== file source
|
42
|
+
\ `hey.md 1:22`\n\n 1: ---\n 2: title: Hey, hello!\n 3: layout: default\n 4:
|
43
|
+
---\n 5:\n 6: # {{ page.title }}\n 7: ----\n 8:\n 9: <div class=\"row\">\n
|
44
|
+
\ 10: <div class=\"col-md-12\">\n 11: <p class='justin'>\n 12: Nice
|
45
|
+
to meet you, I am *Mek*!\n 13: </p>\n 14: <p class='listo'>\n 15: I
|
46
|
+
am a self-proclaimed pizza guru and I am here to teach & learn. Originally from
|
47
|
+
Venice, Italy you can find me in San Diego, CA.\n 16: </p>\n 17: <p class='listo'>\n
|
48
|
+
\ 18: In my spare time, I write code @ PlayStation!\n 19: </p>\n 20:
|
49
|
+
\ </div>\n 21: </div>\n 22:\n\n can you improve this text? Do you see any issues
|
50
|
+
with the template?\n\n ==== end of `hey.md`\n\n"
|
48
51
|
email:
|
49
52
|
- etozzato@gmail.com
|
50
53
|
executables:
|
@@ -61,13 +64,14 @@ files:
|
|
61
64
|
- lib/gpt_helpr.rb
|
62
65
|
- lib/gpt_helpr/cli.rb
|
63
66
|
- lib/gpt_helpr/version.rb
|
64
|
-
homepage: https://etozzato.com
|
67
|
+
homepage: https://www.etozzato.com
|
65
68
|
licenses:
|
66
69
|
- MIT
|
67
70
|
metadata:
|
68
|
-
homepage_uri: https://etozzato.com
|
71
|
+
homepage_uri: https://www.etozzato.com
|
69
72
|
source_code_uri: https://github.com/etozzato/gpt-helpr
|
70
73
|
changelog_uri: https://github.com/etozzato/gpt-helpr/blob/main/CHANGELOG.md
|
74
|
+
rubygems_mfa_required: 'true'
|
71
75
|
post_install_message:
|
72
76
|
rdoc_options: []
|
73
77
|
require_paths:
|
@@ -86,6 +90,6 @@ requirements: []
|
|
86
90
|
rubygems_version: 3.5.14
|
87
91
|
signing_key:
|
88
92
|
specification_version: 4
|
89
|
-
summary: "== \U0001F3F4☠️ GptHelpr 0.2.
|
93
|
+
summary: "== \U0001F3F4☠️ GptHelpr 0.2.3 == Helping to dig your codebase and cook
|
90
94
|
GPT-XX instructions"
|
91
95
|
test_files: []
|