shelp 0.1.0 → 0.2.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.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +19 -11
  3. data/bin/shelp +3 -0
  4. data/lib/shelp/version.rb +1 -1
  5. metadata +5 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5ba623ebc99c85369960fcffb8efb8c2a3cb223b1fca5f93ccfe3ecf098bdd8d
4
- data.tar.gz: 885278d5298b8081a0f2b8f32bbe5cb79e69e19525699814f107dcaae2875c23
3
+ metadata.gz: 4566e255c97ff2606291fbf877add02cb0f855261982a5ac591cc02e96d1d6a4
4
+ data.tar.gz: 0a4ea42c7d441334569db98c1a75a053d116206e3a7f854aadd96cc86ed52f38
5
5
  SHA512:
6
- metadata.gz: 8034f49d04d28af1f42a8aa193c1566e62c44977f1bd134c7adad584661e6e2107ad17fff9391ace30174bddf8901aeb96ea7a2c365f307481af1bb846940dbb
7
- data.tar.gz: 192ba9e7229cc02add4d343bc7d03d37dde31899855e1109e5a930f9d72812fbc126445f08b5d07256fb31f540d8a07d7a13887784c463a54b90d775a033f10f
6
+ metadata.gz: 969b1e2992546c9896844bebac566b901863f3a9e28b56b4fae174c45ae78acb5e48399bd59f9210de7ef9c83923673fc7683ca0779353703976b8f7d4a75e75
7
+ data.tar.gz: ad6f6124ff96adc6f2df1f575062799c0486146bba90cff46f34a0c166bd6e7156b4f7fe662007c2d0e8c1dc1e82bc17fcc13d1696b333954ce0b5681f21794c
data/README.md CHANGED
@@ -1,24 +1,32 @@
1
1
  # Shelp
2
2
 
3
- TODO: Delete this and the text below, and describe your gem
3
+ A command line tool that translates natural language into shell commands, using OpenAI's GPT models.
4
4
 
5
- Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/shelp`. To experiment with that code, run `bin/console` for an interactive prompt.
5
+ DISCLAIMER: This is work in progress and might be rough around the edges. Please be patient and report any issues you encounter.
6
6
 
7
7
  ## Installation
8
8
 
9
- TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
9
+ Install the gem by executing:
10
10
 
11
- Install the gem and add to the application's Gemfile by executing:
11
+ ```bash
12
+ gem install shelp
13
+ ```
12
14
 
13
- $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
15
+ ## Usage
14
16
 
15
- If bundler is not being used to manage dependencies, install the gem by executing:
17
+ To use the tool, you need to have an OpenAI API key. You can get one by signing up at [OpenAI](https://platform.openai.com/signup).
16
18
 
17
- $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
19
+ Once you have your API key, you can set it as an environment variable:
18
20
 
19
- ## Usage
21
+ ```bash
22
+ export OPENAI_API_KEY=your-api-key
23
+ ```
24
+
25
+ Then you can run the CLI by executing:
20
26
 
21
- TODO: Write usage instructions here
27
+ ```bash
28
+ shelp ask "How do I list files in a directory?"
29
+ ```
22
30
 
23
31
  ## Development
24
32
 
@@ -28,7 +36,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
28
36
 
29
37
  ## Contributing
30
38
 
31
- Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/shelp. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/shelp/blob/main/CODE_OF_CONDUCT.md).
39
+ Bug reports and pull requests are welcome on GitHub at <https://github.com/zackbraksa/shelp>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/zackbraksa/shelp/blob/main/CODE_OF_CONDUCT.md).
32
40
 
33
41
  ## License
34
42
 
@@ -36,4 +44,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
36
44
 
37
45
  ## Code of Conduct
38
46
 
39
- Everyone interacting in the Shelp project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/shelp/blob/main/CODE_OF_CONDUCT.md).
47
+ Everyone interacting in the Shelp project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/zackbraksa/shelp/blob/main/CODE_OF_CONDUCT.md).
data/bin/shelp ADDED
@@ -0,0 +1,3 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require_relative '../lib/shelp.rb'
data/lib/shelp/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Shelp
4
- VERSION = "0.1.0"
4
+ VERSION = "0.2.1"
5
5
  end
metadata CHANGED
@@ -1,12 +1,12 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: shelp
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.2.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Zack Braksa
8
8
  autorequire:
9
- bindir: exe
9
+ bindir: bin
10
10
  cert_chain: []
11
11
  date: 2024-05-05 00:00:00.000000000 Z
12
12
  dependencies: []
@@ -14,7 +14,8 @@ description: A command-line tool that translates natural language to shell comma
14
14
  using OpenAI's GPT model.
15
15
  email:
16
16
  - zakaria.braksa@gmail.com
17
- executables: []
17
+ executables:
18
+ - shelp
18
19
  extensions: []
19
20
  extra_rdoc_files: []
20
21
  files:
@@ -26,6 +27,7 @@ files:
26
27
  - LICENSE.txt
27
28
  - README.md
28
29
  - Rakefile
30
+ - bin/shelp
29
31
  - lib/shelp.rb
30
32
  - lib/shelp/version.rb
31
33
  - sig/shelp.rbs