gpterm 0.4.2 → 0.6.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.
- checksums.yaml +4 -4
- data/README.md +18 -3
- data/config/prompts.yml +113 -0
- data/lib/client.rb +43 -115
- data/lib/gpterm.rb +67 -32
- metadata +17 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: eefadbe4a618d7d95cef501fcf44e42db0487adb79d8e8461cd22cc6eefd655b
|
|
4
|
+
data.tar.gz: 523ac93f6e14d5298931aba6d93209cf179ad54f5af295846670ebcd1b2932fe
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: baff99e03558c78a074a43df8be57ea460be0852aea9e48fdc9eb11a5594bde329e92789f7de9d4158e85f06b26c2f13eff303aa9e484b2eef98c1c2361399c3
|
|
7
|
+
data.tar.gz: bf12e985975db7eef7bb533bae732a0a992d68d97d8af69257eb9b73f3ca71fc159f083138c56539a0fb84351e37acb3573d16e269b00b0f55ce2d1b5bbbb161
|
data/README.md
CHANGED
|
@@ -1,7 +1,9 @@
|
|
|
1
|
-
# gpterm
|
|
1
|
+
# gpterm: a natural language interface for your terminal
|
|
2
2
|
|
|
3
3
|
**WARNING:** `gpterm` has very few guardrails. If used indiscriminately, it can wipe your entire system or leak information.
|
|
4
4
|
|
|
5
|
+
|
|
6
|
+
|
|
5
7
|
`gpterm` is a powerful, flexible and dangerous command-line tool designed to help you generate commands for your terminal using OpenAI's Chat Completions. It will not execute commands without your consent, but please do check which commands it is presenting before you let it execute them. Like so:
|
|
6
8
|
|
|
7
9
|
```bash
|
|
@@ -42,6 +44,15 @@ On first run, you'll be prompted to enter your OpenAI API key. This is required
|
|
|
42
44
|
You can save and reuse preset prompts for common or repeated tasks. To create a preset, use the `-s` option followed by a name and the prompt, separated by a comma.
|
|
43
45
|
To use a preset, simply pass its name as an argument when starting gpterm.
|
|
44
46
|
|
|
47
|
+
### Example Presets
|
|
48
|
+
|
|
49
|
+
I have been using the following presets while developing `gpterm` and have found them to be quite helpful.
|
|
50
|
+
|
|
51
|
+
- `gc`: **Makes and pushes a commit describing the most recent changes.**
|
|
52
|
+
- Prompt: `"Commit all the latest changes to main, describing specifically what the changes are in the commit message. Please determine what the changes are before you write the commit message. You should use git diff and git status for information gathering"`
|
|
53
|
+
- `minorv`: **Does all the steps necessary in publishing a new version of this gem, including updating the changelog.**
|
|
54
|
+
- Prompt: `"Bump to a new minor version of this gem (change the y and reset z in version number x.y.z). That means you need to add a new section to the changelog with 1-5 bullet points summarising the changes (check git logs since the most recent git tag), then commit that, then create a new git tag, pushing the tag to the remote, update the gemspec, build the gem and publish it to rubygems. DO NOT try to add or commit any .gemspec files to the repo, or any other files which are listed in .gitignore"`
|
|
55
|
+
|
|
45
56
|
## Contributing
|
|
46
57
|
|
|
47
58
|
Contributions are welcome! Feel free to open an issue or pull request.
|
|
@@ -50,6 +61,10 @@ Contributions are welcome! Feel free to open an issue or pull request.
|
|
|
50
61
|
|
|
51
62
|
gpterm is open-source software licensed under the MIT license.
|
|
52
63
|
|
|
53
|
-
##
|
|
64
|
+
## Credit
|
|
65
|
+
|
|
66
|
+
[Dan Hough](https://danhough.com)/@basicallydan built this application.
|
|
67
|
+
|
|
68
|
+
[Alex Rudall](https://github.com/alexrudall)/@alexrudall developed [ruby-openai](https://github.com/alexrudall/ruby-openai) around which this application was built.
|
|
54
69
|
|
|
55
|
-
[
|
|
70
|
+
[OpenAI](https://openai.com/)/@openai built a powerful API full of great AI models upon which this whole concept relies.
|
data/config/prompts.yml
ADDED
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
system: |
|
|
2
|
+
You are an AI running in a command-line application being executed inside of a directory on a user's computer. You are executed by running `gpterm` in the terminal or shell. You are an expert in POSIX-compliant command-line tools and utilities, and you are able to run any command that this system can run. You are also able to understand the output of those commands.
|
|
3
|
+
|
|
4
|
+
You are executed by running `gpterm` in the shell, and you are provided with a GOAL PROMPT.
|
|
5
|
+
|
|
6
|
+
The user's GOAL PROMPT will be a natural-language string which describes a goal that the user would like you to help them achieve by running some commands in their shell.
|
|
7
|
+
|
|
8
|
+
As part of the conversation, you will be given COMMAND PROMPTS and QUESTION PROMPTS. You must respond to each of these with the appropriate type of response.
|
|
9
|
+
|
|
10
|
+
# COMMAND PROMPTS
|
|
11
|
+
|
|
12
|
+
When you are given a prompt ending with "COMMANDS:", you MUST respond with either:
|
|
13
|
+
- One or more commands which can be executed on the shell
|
|
14
|
+
- An INSTRUCTION CODE which indicates to the application that no commands can be generated or are necessary
|
|
15
|
+
|
|
16
|
+
When responding with commands:
|
|
17
|
+
- The response MUST be a string containing one or more shell commands, separated by newlines, and nothing else
|
|
18
|
+
- The response MUST NOT contain any comments or extraneous information
|
|
19
|
+
- The response MUST NOT start with backticks, or end with backticks
|
|
20
|
+
- The response MUST keep in mind that each line of the response will be executed in the shell in a subshell, and the output of each command will be captured
|
|
21
|
+
- The commands MUST NOT contain any placeholders which the user is expected to replace with their own values
|
|
22
|
+
- If a command needs to be run in another directory, the command to change directory MUST be part of that command. To execute a command in a different directory, you must chain the cd command with the command you want to run, like so: `cd /path/to/directory && command`. You will need to do the same for any command that requires a different working directory, even if you have used cd in a previous command
|
|
23
|
+
|
|
24
|
+
When responding with an INSTRUCTION CODE indicating that no commands can be generated or are necessary:
|
|
25
|
+
- The response MUST start with $$ and end with $$, and be a single line with only alphanumeric characters and underscores
|
|
26
|
+
- The response MUST match one of the codes provided in the prompt
|
|
27
|
+
|
|
28
|
+
# QUESTION PROMPTS
|
|
29
|
+
|
|
30
|
+
When you are given a prompt ending with "QUESTION:", you MUST respond with either:
|
|
31
|
+
- A string which contains a question that the user can answer to provide you with some information you need to generate the commands to accomplish the goal
|
|
32
|
+
- An INSTRUCTION CODE which indicates to the application that no question can be generated or is necessary
|
|
33
|
+
|
|
34
|
+
When responding with a question:
|
|
35
|
+
- The response MUST be a string containing a question that gathers ONE piece of information. If you need multiple pieces of information, you can ask a follow-up question after the user responds to the one you are currently asking
|
|
36
|
+
|
|
37
|
+
When responding with an INSTRUCTION CODE indicating that no question can be generated or is necessary:
|
|
38
|
+
- The response MUST start with $$ and end with $$, and be a single line with only alphanumeric characters and underscores
|
|
39
|
+
- The response MUST match one of the codes provided in the prompt
|
|
40
|
+
info_gathering: |
|
|
41
|
+
Your FIRST response should be a list of commands that will be automatically executed to gather more information about the user's system. For this response, additonal formatting rules apply:
|
|
42
|
+
- The response MUST NOT contain any plain language instructions, and must not start with or end with backticks to indicate code.
|
|
43
|
+
- The commands MUST NOT make any changes to the user's system.
|
|
44
|
+
- The commands MUST NOT make any changes to any files on the user's system.
|
|
45
|
+
- The commands MUST NOT write to any files using the > or >> operators.
|
|
46
|
+
- The commands MUST NOT use the touch command.
|
|
47
|
+
- The commands MUST NOT use echo or any other command to write into files using the > or >> operators.
|
|
48
|
+
- The commands MUST NOT send any data to any external servers.
|
|
49
|
+
- The commands MAY gather information about the user's system, such as the version of a software package, or the contents of a file.
|
|
50
|
+
- The commands CAN pipe their output into other commands.
|
|
51
|
+
- The commands SHOULD tend to gather more verbose information INSTEAD OF more concise information.
|
|
52
|
+
|
|
53
|
+
This will help you to provide a more accurate response to the user's goal.
|
|
54
|
+
|
|
55
|
+
VALID example response. These commands are examples of commands which CAN be included in your FIRST response:
|
|
56
|
+
|
|
57
|
+
for file in *; do cat "$file"; done
|
|
58
|
+
which ls
|
|
59
|
+
which git
|
|
60
|
+
which brew
|
|
61
|
+
git diff
|
|
62
|
+
git status
|
|
63
|
+
|
|
64
|
+
INVALID example response. These commands are examples of commands which MUST NOT be included in your FIRST response:
|
|
65
|
+
|
|
66
|
+
touch file.txt
|
|
67
|
+
git add .
|
|
68
|
+
git push
|
|
69
|
+
|
|
70
|
+
Alternatively for this response, you may respond with one of the following INSTRUCTION CODES and NO OTHER INSTRUCTIONS CODES:
|
|
71
|
+
- $$cannot_compute$$ - You cannot create a VALID response to this prompt. The user will be asked to provide a new prompt.
|
|
72
|
+
- $$no_gathering_needed$$ - You do not need to gather more information. The next step will be executed.
|
|
73
|
+
|
|
74
|
+
Please note that in many cases, you will need to gather information by running commands.
|
|
75
|
+
|
|
76
|
+
If you need to gather information directly from the user, you will be able to do so in the next step by asking questions.
|
|
77
|
+
user_question: |
|
|
78
|
+
Before you provide the user with the next command, you have the opportunity to ask the user to provide more information so you can better tailor your response to their needs.
|
|
79
|
+
|
|
80
|
+
If you would like to ask the user for more information, please provide a prompt that asks the user for the information you need.
|
|
81
|
+
|
|
82
|
+
Alternatively for this response, you may respond with one of the following INSTRUCTION CODES and NO OTHER INSTRUCTIONS CODES:
|
|
83
|
+
- $$no_more_information_needed$$ - You do not need to gather any further information. The next step will be executed.
|
|
84
|
+
|
|
85
|
+
QUESTION:
|
|
86
|
+
goal_commands: |
|
|
87
|
+
Your NEXT response should be a list of commands that will be automatically executed to fulfill the user's goal. For this response, additonal formatting rules apply:
|
|
88
|
+
- The commands ARE ALLOWED to make changes to the user's system.
|
|
89
|
+
- The commands ARE ALLOWED to install new software using package managers like Homebrew
|
|
90
|
+
|
|
91
|
+
The following commands are FORBIDDEN in this response. Outputting ANY of these commands will result in a rejection of your response:
|
|
92
|
+
- rm -rf /
|
|
93
|
+
- sudo rm -rf /
|
|
94
|
+
- dd if=/dev/random of=/dev/sda
|
|
95
|
+
- :(){ :|: & };:
|
|
96
|
+
- chmod -R 777 /
|
|
97
|
+
- mkfs.ext4 /dev/sda1
|
|
98
|
+
- dd if=/dev/zero of=/dev/sda bs=1M count=1
|
|
99
|
+
- mv / /dev/null
|
|
100
|
+
- cat /etc/shadow
|
|
101
|
+
- echo "malicious_code" > ~/.bash_profile
|
|
102
|
+
|
|
103
|
+
VALID example response. These commands are examples of commands which CAN be included in your FINAL response:
|
|
104
|
+
|
|
105
|
+
ls
|
|
106
|
+
mkdir new_directory
|
|
107
|
+
brew install git
|
|
108
|
+
git commit -m "This is a great commit message"
|
|
109
|
+
|
|
110
|
+
Alternatively, you may respond with the following INSTRUCTION CODES:
|
|
111
|
+
- $$cannot_compute$$ - You cannot create a VALID response to this prompt. The user will be asked to provide a new prompt.
|
|
112
|
+
|
|
113
|
+
COMMANDS:
|
data/lib/client.rb
CHANGED
|
@@ -1,159 +1,87 @@
|
|
|
1
1
|
require "openai"
|
|
2
|
+
require 'yaml'
|
|
2
3
|
|
|
3
4
|
class Client
|
|
4
|
-
attr_reader :
|
|
5
|
+
attr_reader :openai_client
|
|
5
6
|
attr_reader :config
|
|
6
7
|
|
|
7
8
|
def initialize(config)
|
|
8
9
|
@config = config
|
|
9
|
-
@
|
|
10
|
+
@openai_client = OpenAI::Client.new(access_token: config["openapi_key"])
|
|
11
|
+
@prompts = YAML.load_file(File.join(__dir__, '..', 'config', 'prompts.yml'))
|
|
10
12
|
end
|
|
11
13
|
|
|
12
|
-
def first_prompt(
|
|
13
|
-
system_prompt =
|
|
14
|
-
You are a command-line application being executed inside of a directory in a macOS environment, on the user's terminal command line.
|
|
15
|
-
|
|
16
|
-
You are executed by running `gpterm` in the terminal, and you are provided with a prompt to respond to with the -p flag.
|
|
17
|
-
|
|
18
|
-
Users can add a preset prompt by running `gpterm -s <name>,<prompt>`.
|
|
19
|
-
|
|
20
|
-
The eventual output to the user would be a list of commands that they can run in their terminal to accomplish a task.
|
|
21
|
-
|
|
22
|
-
You have the ability to run any command that this system can run, and you can read the output of those commands.
|
|
23
|
-
|
|
24
|
-
However, any command which would ordinarily change the directory, such as cd, will not change the location of the directory in which you are running. To execute a command in a different directory, you must chain the cd command with the command you want to run, like so: `cd /path/to/directory && command`. You will need to do the same for any command that requires a different working directory, even if you have used cd in a previous command.
|
|
25
|
-
|
|
26
|
-
The user is trying to accomplish a task using the terminal, but they are not sure how to do it.
|
|
27
|
-
PROMPT
|
|
14
|
+
def first_prompt(user_goal_prompt)
|
|
15
|
+
system_prompt = @prompts["system"]
|
|
28
16
|
|
|
29
17
|
if @config["send_path"]
|
|
30
18
|
system_prompt += <<~PROMPT
|
|
19
|
+
# ADDITIONAL CONTEXT:
|
|
20
|
+
|
|
31
21
|
The user's PATH environment variable is:
|
|
32
22
|
#{ENV["PATH"]}
|
|
33
23
|
PROMPT
|
|
34
24
|
end
|
|
35
25
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
- The commands MUST NOT contain any placeholders in angle brackets like <this>.
|
|
46
|
-
- The commands MAY gather information about the user's system, such as the version of a software package, or the contents of a file.
|
|
47
|
-
- The commands CAN pipe their output into other commands.
|
|
48
|
-
- The commands SHOULD tend to gather more verbose information INSTEAD OF more concise information.
|
|
49
|
-
This will help you to provide a more accurate response to the user's goal.
|
|
50
|
-
Therefore your FIRST response MUST contain ONLY a list of commands and nothing else.
|
|
51
|
-
|
|
52
|
-
VALID example response. These commands are examples of commands which CAN be included in your FIRST response:
|
|
53
|
-
|
|
54
|
-
for file in *; do cat "$file"; done
|
|
55
|
-
which ls
|
|
56
|
-
which git
|
|
57
|
-
which brew
|
|
58
|
-
git diff
|
|
59
|
-
git status
|
|
60
|
-
|
|
61
|
-
INVALID example response. These commands are examples of commands which MUST NOT be included in your FIRST response:
|
|
62
|
-
|
|
63
|
-
touch file.txt
|
|
64
|
-
git add .
|
|
65
|
-
git push
|
|
66
|
-
|
|
67
|
-
If you cannot create a VALID response, simply return the string "$$cannot_compute$$" and the user will be asked to provide a new prompt.
|
|
68
|
-
If you do not need to gather more information, simply return the string "$$no_gathering_needed$$" and the next step will be executed.
|
|
69
|
-
You probably will need to gather information.
|
|
70
|
-
If you need to gather information directly from the user, you will be able to do so in the next step.
|
|
71
|
-
|
|
72
|
-
The user's goal prompt is:
|
|
73
|
-
"#{prompt}"
|
|
74
|
-
Commands to execute to gather more information about the user's system before providing the response which will accomplish the user's goal:
|
|
26
|
+
user_prompt = @prompts["info_gathering"]
|
|
27
|
+
user_prompt += <<~PROMPT
|
|
28
|
+
The user's GOAL PROMPT is:
|
|
29
|
+
|
|
30
|
+
"#{user_goal_prompt}"
|
|
31
|
+
|
|
32
|
+
Please respond with one or more commands to execute to gather more information about the user's system before providing the response which will accomplish the user's goal.
|
|
33
|
+
|
|
34
|
+
COMMANDS:
|
|
75
35
|
PROMPT
|
|
76
36
|
|
|
77
37
|
@messages = [
|
|
78
|
-
{ role: "system", content: system_prompt }
|
|
79
|
-
{ role: "user", content: full_prompt }
|
|
38
|
+
{ role: "system", content: system_prompt }
|
|
80
39
|
]
|
|
81
40
|
|
|
82
|
-
|
|
83
|
-
parameters: {
|
|
84
|
-
model: "gpt-4-turbo-preview",
|
|
85
|
-
messages: @messages,
|
|
86
|
-
temperature: 0.6,
|
|
87
|
-
}
|
|
88
|
-
)
|
|
89
|
-
content = response.dig("choices", 0, "message", "content")
|
|
90
|
-
|
|
91
|
-
@messages << { role: "assistant", content: content }
|
|
92
|
-
|
|
93
|
-
content
|
|
41
|
+
continue_conversation(user_prompt)
|
|
94
42
|
end
|
|
95
43
|
|
|
96
|
-
def offer_information_prompt(
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
#{prompt}
|
|
101
|
-
|
|
102
|
-
Before you provide the user with the next command, you have the opportunity to ask the user to provide more information so you can better tailor your response to their needs.
|
|
103
|
-
|
|
104
|
-
If you would like to ask the user for more information, please provide a prompt that asks the user for the information you need.
|
|
105
|
-
- Your prompt MUST ONLY contain one question. You will be able to ask another question in the next step.
|
|
106
|
-
If you have all the information you need, simply return the string "$$no_more_information_needed$$" and the next step will be executed.
|
|
107
|
-
PROMPT
|
|
44
|
+
def offer_information_prompt(previous_output, previous_output_type = :question_response)
|
|
45
|
+
question_prompt = if previous_output_type == :question_response
|
|
46
|
+
<<~PROMPT
|
|
47
|
+
This is the output of the question you asked the user in the previous step.
|
|
108
48
|
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
messages: @messages,
|
|
115
|
-
temperature: 0.6,
|
|
116
|
-
}
|
|
117
|
-
)
|
|
49
|
+
#{previous_output}
|
|
50
|
+
PROMPT
|
|
51
|
+
else
|
|
52
|
+
<<~PROMPT
|
|
53
|
+
This is the output of the command you provided to the user in the previous step.
|
|
118
54
|
|
|
119
|
-
|
|
55
|
+
#{previous_output}
|
|
56
|
+
PROMPT
|
|
57
|
+
end
|
|
120
58
|
|
|
121
|
-
|
|
59
|
+
question_prompt += @prompts["user_question"]
|
|
122
60
|
|
|
123
|
-
|
|
61
|
+
continue_conversation(question_prompt)
|
|
124
62
|
end
|
|
125
63
|
|
|
126
64
|
def final_prompt(prompt)
|
|
127
|
-
|
|
65
|
+
goal_commands_prompt = <<~PROMPT
|
|
128
66
|
This is the output of the command you provided to the user in the previous step.
|
|
129
67
|
|
|
130
68
|
#{prompt}
|
|
131
69
|
|
|
132
|
-
|
|
133
|
-
- The commands may make changes to the user's system.
|
|
134
|
-
- The commands may install new software using package managers like Homebrew
|
|
135
|
-
- The commands MUST all start with a valid command that you would run in the terminal
|
|
136
|
-
- The commands MUST NOT contain any placeholders in angle brackets like <this>.
|
|
137
|
-
- The response MUST NOT contain any plain language instructions, or backticks indicating where the commands begin or end.
|
|
138
|
-
- THe response MUST NOT start or end with backticks.
|
|
139
|
-
- The response MUST NOT end with a newline character.
|
|
140
|
-
Therefore your NEXT response MUST contain ONLY a list of commands and nothing else.
|
|
70
|
+
PROMPT
|
|
141
71
|
|
|
142
|
-
|
|
72
|
+
goal_commands_prompt += @prompts["goal_commands"]
|
|
143
73
|
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
brew install git
|
|
147
|
-
git commit -m "This is a great commit message"
|
|
74
|
+
continue_conversation(goal_commands_prompt)
|
|
75
|
+
end
|
|
148
76
|
|
|
149
|
-
|
|
150
|
-
PROMPT
|
|
77
|
+
private
|
|
151
78
|
|
|
152
|
-
|
|
79
|
+
def continue_conversation(prompt)
|
|
80
|
+
@messages << { role: "user", content: prompt }
|
|
153
81
|
|
|
154
|
-
response =
|
|
82
|
+
response = openai_client.chat(
|
|
155
83
|
parameters: {
|
|
156
|
-
model: "gpt-4-turbo-preview",
|
|
84
|
+
model: @config["model"] || "gpt-4-turbo-preview",
|
|
157
85
|
messages: @messages,
|
|
158
86
|
temperature: 0.6,
|
|
159
87
|
}
|
data/lib/gpterm.rb
CHANGED
|
@@ -24,36 +24,66 @@ class GPTerm
|
|
|
24
24
|
name = @options[:preset_prompt][0]
|
|
25
25
|
prompt = @options[:preset_prompt][1]
|
|
26
26
|
AppConfig.add_preset(@config, name, prompt)
|
|
27
|
-
|
|
28
|
-
exit
|
|
27
|
+
exit_with_message("Preset prompt '#{name}' saved with prompt '#{prompt}'", :green)
|
|
29
28
|
elsif @options[:prompt]
|
|
30
|
-
|
|
29
|
+
start_conversation(@options[:prompt])
|
|
31
30
|
end
|
|
32
31
|
end
|
|
33
32
|
|
|
34
33
|
private
|
|
35
34
|
|
|
36
|
-
def
|
|
35
|
+
def execute_shell_command(command)
|
|
37
36
|
stdout, stderr, status = Open3.capture3(command)
|
|
38
37
|
[stdout, stderr, status.exitstatus]
|
|
39
38
|
end
|
|
40
39
|
|
|
41
|
-
def
|
|
40
|
+
def exit_with_message(message, color = nil)
|
|
41
|
+
if color
|
|
42
|
+
puts message.colorize(color)
|
|
43
|
+
else
|
|
44
|
+
puts message
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
exit
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
# Ensures the user enters "y" or "n"
|
|
51
|
+
def get_yes_or_no
|
|
52
|
+
input = STDIN.gets.chomp.downcase
|
|
53
|
+
while ['y', 'n'].include?(input) == false
|
|
54
|
+
puts 'Please enter "y/Y" or "n/N":'.colorize(:yellow)
|
|
55
|
+
input = STDIN.gets.chomp.downcase
|
|
56
|
+
end
|
|
57
|
+
input
|
|
58
|
+
end
|
|
59
|
+
|
|
60
|
+
# Ensures the user enters a non-empty value
|
|
61
|
+
def get_non_empty_input
|
|
62
|
+
input = STDIN.gets.chomp.strip
|
|
63
|
+
while input.length == 0
|
|
64
|
+
puts 'Please enter a non-empty value:'.colorize(:yellow)
|
|
65
|
+
input = STDIN.gets.chomp.strip
|
|
66
|
+
end
|
|
67
|
+
input
|
|
68
|
+
end
|
|
69
|
+
|
|
70
|
+
def start_conversation(prompt)
|
|
42
71
|
message = @client.first_prompt(prompt)
|
|
43
72
|
|
|
44
73
|
if message.downcase == '$$cannot_compute$$'
|
|
45
|
-
|
|
46
|
-
exit
|
|
74
|
+
exit_with_message('Sorry, a command could not be generated for that prompt. Try another.', :red)
|
|
47
75
|
end
|
|
48
76
|
|
|
49
77
|
if message.downcase == '$$no_gathering_needed$$'
|
|
50
78
|
puts 'No information gathering needed'.colorize(:magenta)
|
|
51
79
|
output = "No information gathering was needed."
|
|
80
|
+
elsif message.downcase == '$$cannot_compute$$'
|
|
81
|
+
exit_with_message('Sorry, a command could not be generated for that prompt. Try another.', :red)
|
|
52
82
|
else
|
|
53
83
|
puts 'Information gathering command:'.colorize(:magenta)
|
|
54
84
|
puts message.gsub(/^/, "#{" $".colorize(:blue)} ")
|
|
55
|
-
puts 'Do you want to execute this command? (Y/n)'.colorize(:yellow)
|
|
56
|
-
continue =
|
|
85
|
+
puts 'Do you want to execute this command? (Y/n then hit return)'.colorize(:yellow)
|
|
86
|
+
continue = get_yes_or_no
|
|
57
87
|
|
|
58
88
|
unless continue.downcase == 'y'
|
|
59
89
|
exit
|
|
@@ -68,19 +98,19 @@ class GPTerm
|
|
|
68
98
|
end
|
|
69
99
|
end
|
|
70
100
|
|
|
71
|
-
output =
|
|
101
|
+
output = @client.offer_information_prompt(output, :shell_output_response)
|
|
72
102
|
|
|
73
103
|
while output.downcase != '$$no_more_information_needed$$'
|
|
74
104
|
puts "You have been asked to provide more information with this command:".colorize(:magenta)
|
|
75
105
|
puts output.gsub(/^/, "#{" >".colorize(:blue)} ")
|
|
76
106
|
puts "What is your response? (Type 'skip' to skip this step and force the final command to be generated)".colorize(:yellow)
|
|
77
107
|
|
|
78
|
-
response =
|
|
108
|
+
response = get_non_empty_input
|
|
79
109
|
|
|
80
110
|
if response.downcase == 'skip'
|
|
81
111
|
output = '$$no_more_information_needed$$'
|
|
82
112
|
else
|
|
83
|
-
output =
|
|
113
|
+
output = @client.offer_information_prompt(response, :question_response)
|
|
84
114
|
end
|
|
85
115
|
end
|
|
86
116
|
|
|
@@ -88,12 +118,16 @@ class GPTerm
|
|
|
88
118
|
|
|
89
119
|
message = @client.final_prompt(output)
|
|
90
120
|
|
|
121
|
+
if message.downcase == '$$cannot_compute$$'
|
|
122
|
+
exit_with_message('Sorry, a command could not be generated for that prompt. Try another.', :red)
|
|
123
|
+
end
|
|
124
|
+
|
|
91
125
|
puts 'Generated command to accomplish your goal:'.colorize(:magenta)
|
|
92
126
|
puts message.gsub(/^/, "#{" $".colorize(:green)} ")
|
|
93
127
|
|
|
94
|
-
puts 'Do you want to execute this command? (Y/n)'.colorize(:yellow)
|
|
128
|
+
puts 'Do you want to execute this command? (Y/n then hit return)'.colorize(:yellow)
|
|
95
129
|
|
|
96
|
-
continue =
|
|
130
|
+
continue = get_yes_or_no
|
|
97
131
|
|
|
98
132
|
unless continue.downcase == 'y'
|
|
99
133
|
exit
|
|
@@ -102,12 +136,11 @@ class GPTerm
|
|
|
102
136
|
commands = message.split("\n")
|
|
103
137
|
|
|
104
138
|
commands.each do |command|
|
|
105
|
-
stdout, stderr, exit_status =
|
|
139
|
+
stdout, stderr, exit_status = execute_shell_command(command)
|
|
106
140
|
if exit_status != 0
|
|
107
141
|
puts "#{command} failed with the following output:".colorize(:red)
|
|
108
142
|
puts "#{stderr.gsub(/^/, " ")}".colorize(:red) if stderr.length > 0
|
|
109
|
-
|
|
110
|
-
exit
|
|
143
|
+
exit_with_message(" Exit status: #{exit_status}", :red)
|
|
111
144
|
end
|
|
112
145
|
puts stdout if stdout.length > 0
|
|
113
146
|
# I'm doing this here because git for some reason always returns the output of a push to stderr,
|
|
@@ -123,20 +156,29 @@ class GPTerm
|
|
|
123
156
|
new_config = {}
|
|
124
157
|
puts "Before we get started, we need to configure the application. All the info you provide will be saved in #{AppConfig::CONFIG_FILE}.".colorize(:magenta)
|
|
125
158
|
|
|
126
|
-
puts "Enter your OpenAI API key's \"SECRET KEY\" value: ".colorize(:yellow)
|
|
127
|
-
new_config['openapi_key'] =
|
|
159
|
+
puts "Enter your OpenAI API key's \"SECRET KEY\" value then hit return: ".colorize(:yellow)
|
|
160
|
+
new_config['openapi_key'] = get_non_empty_input
|
|
128
161
|
|
|
129
162
|
puts "Your PATH environment variable is: #{ENV['PATH']}".colorize(:magenta)
|
|
130
|
-
puts 'Are you happy for your PATH to be sent to OpenAI to help with command generation? (Y/n) '.colorize(:yellow)
|
|
163
|
+
puts 'Are you happy for your PATH to be sent to OpenAI to help with command generation? (Y/n then hit return) '.colorize(:yellow)
|
|
164
|
+
|
|
165
|
+
input = get_yes_or_no
|
|
131
166
|
|
|
132
|
-
if
|
|
167
|
+
if input == 'y'
|
|
133
168
|
new_config['send_path'] = true
|
|
134
169
|
else
|
|
135
170
|
new_config['send_path'] = false
|
|
136
171
|
end
|
|
137
172
|
|
|
173
|
+
default_model = 'gpt-4-turbo-preview'
|
|
174
|
+
|
|
175
|
+
puts "The default model is #{default_model}. If you would like to change it please enter the name of your preferred model:".colorize(:yellow)
|
|
176
|
+
new_config['model'] = STDIN.gets.chomp.strip || default_model
|
|
177
|
+
|
|
138
178
|
AppConfig.save_config(new_config)
|
|
139
179
|
|
|
180
|
+
puts "Configuration saved to #{AppConfig::CONFIG_FILE}".colorize(:green)
|
|
181
|
+
|
|
140
182
|
new_config
|
|
141
183
|
else
|
|
142
184
|
AppConfig.load_config
|
|
@@ -163,14 +205,12 @@ class GPTerm
|
|
|
163
205
|
opts.banner = "gpterm config [--openapi_key <value>|--send_path <true|false>]"
|
|
164
206
|
opts.on("--openapi_key VALUE", "Set the OpenAI API key") do |v|
|
|
165
207
|
AppConfig.add_openapi_key(@config, v)
|
|
166
|
-
|
|
167
|
-
exit
|
|
208
|
+
exit_with_message("OpenAI API key saved")
|
|
168
209
|
end
|
|
169
210
|
opts.on("--send_path", "Send the PATH environment variable to OpenAI") do
|
|
170
211
|
@config['send_path'] = true
|
|
171
212
|
AppConfig.save_config(@config)
|
|
172
|
-
|
|
173
|
-
exit
|
|
213
|
+
exit_with_message("Your PATH environment variable will be sent to OpenAI to help with command generation")
|
|
174
214
|
end
|
|
175
215
|
end
|
|
176
216
|
}
|
|
@@ -196,19 +236,14 @@ class GPTerm
|
|
|
196
236
|
subcommands[command][:option_parser].parse!
|
|
197
237
|
subcommands[command][:argument_parser].call(ARGV) if subcommands[command][:argument_parser]
|
|
198
238
|
elsif command == 'help'
|
|
199
|
-
|
|
200
|
-
exit
|
|
239
|
+
exit_with_message(main)
|
|
201
240
|
elsif command
|
|
202
241
|
options[:prompt] = command
|
|
203
242
|
else
|
|
204
243
|
puts 'Enter a prompt to generate text from:'.colorize(:yellow)
|
|
205
|
-
options[:prompt] =
|
|
244
|
+
options[:prompt] = get_non_empty_input
|
|
206
245
|
end
|
|
207
246
|
|
|
208
247
|
options
|
|
209
248
|
end
|
|
210
|
-
|
|
211
|
-
def offer_more_information(output)
|
|
212
|
-
output = @client.offer_information_prompt(output)
|
|
213
|
-
end
|
|
214
249
|
end
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: gpterm
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.6.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Dan Hough
|
|
@@ -24,6 +24,20 @@ dependencies:
|
|
|
24
24
|
- - "<"
|
|
25
25
|
- !ruby/object:Gem::Version
|
|
26
26
|
version: '7'
|
|
27
|
+
- !ruby/object:Gem::Dependency
|
|
28
|
+
name: colorize
|
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
|
30
|
+
requirements:
|
|
31
|
+
- - ">="
|
|
32
|
+
- !ruby/object:Gem::Version
|
|
33
|
+
version: '0'
|
|
34
|
+
type: :runtime
|
|
35
|
+
prerelease: false
|
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
37
|
+
requirements:
|
|
38
|
+
- - ">="
|
|
39
|
+
- !ruby/object:Gem::Version
|
|
40
|
+
version: '0'
|
|
27
41
|
description: gpterm is a powerful, flexible and dangerous command-line tool designed
|
|
28
42
|
to help you generate commands for your terminal using OpenAI's Chat Completions
|
|
29
43
|
email:
|
|
@@ -36,6 +50,7 @@ files:
|
|
|
36
50
|
- LICENSE
|
|
37
51
|
- README.md
|
|
38
52
|
- bin/gpterm
|
|
53
|
+
- config/prompts.yml
|
|
39
54
|
- lib/client.rb
|
|
40
55
|
- lib/config.rb
|
|
41
56
|
- lib/gpterm.rb
|
|
@@ -53,7 +68,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
53
68
|
requirements:
|
|
54
69
|
- - ">="
|
|
55
70
|
- !ruby/object:Gem::Version
|
|
56
|
-
version:
|
|
71
|
+
version: 2.6.0
|
|
57
72
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
58
73
|
requirements:
|
|
59
74
|
- - ">="
|