n2b 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36e89a27c564ad37f194815b57e41bd78179b3ddf50158006c52d779e90e5fc4
-  data.tar.gz: 77a5f7e26fca5b0a69e8e8f84fe479e850fda943d020aa68f6e3e10e1fa19e13
+  metadata.gz: '00568c10ff4e0c1684ef83fe6579d40ac1d89623fbd704db4810b3b031fffb40'
+  data.tar.gz: e6f22194fadffcf43ed553bb37693607a49b2a9fe2a614748d9b3ae8e415eb30
 SHA512:
-  metadata.gz: adcf95ef2faf2c5d8671ac86ece4144955c8f970c02162f093bfe751bbc72f47d30d38d4805ce7ea97d0b0ce14ba576651d031f966b981290fcd52d74cb4590d
-  data.tar.gz: d4095cf87fe1e423898be331fba7a639abfe44ff3431a005b7c16e0a5789d4c8b8de74beac618935c4af5d2501b5e32a0c85b359bd7bbf2480d8b234d4c515ab
+  metadata.gz: f40a0f2829fc6b2cfcdf512c08bf2a754d41e3fed6bdbbfbe6d63cfde7aa9318b6f8256dea2655e0dfea5485e5bfc358faaae3ee643905ed1c873d2770e62c21
+  data.tar.gz: 054066fa79caf2cdc0077017abf6e01d4b06ed361199d0d9471549a232c77af63adf613642056f12aceb300894329ed832c607a4dcf4e537ba5dfa9a4d0fc6fb

data/README.md

@@ -11,6 +11,26 @@ N2B (Natural to Bash) is a Ruby gem that converts natural language instructions
 - Shell history integration
 - Command history tracking for improved context
 
+## Quick Example
+
+```
+n2b init a new github repo called abc, add local files, transmit
+```
+
+results in 
+```
+Translated /bin/zsh Commands:
+------------------------
+git init
+git remote add origin https://github.com/yourusername/abc.git
+git add .
+git commit -m 'Initial commit'
+git push -u origin main
+------------------------
+Explanation:
+These commands initialize a new Git repository, add a remote GitHub repository named 'abc', stage all local files, create an initial commit, and push the changes to GitHub. Replace 'yourusername' with your actual GitHub username. Note that you'll need to create the repository on GitHub first before running these commands. Also, ensure you have Git installed and configured with your GitHub credentials.
+```
+------------------------
 ## Installation
 
 Install the gem by running:
@@ -44,15 +64,15 @@ Examples:
 
 1. Generate commands without executing:
 
-n2b list all PDF files in the current directory
+```n2b list all PDF files in the current directory ```
 
 2. Generate and execute commands:
 
-n2b -x create a new directory named 'project' and initialize a git repository in it
+```n2b -x create a new directory named 'project' and initialize a git repository in it ```
 
 3. Reconfigure the tool:
 
-n2b -c 
+```n2b -c  ```
 
 ## How It Works
 
@@ -65,12 +85,18 @@ n2b -c
 ## Privacy
 
 N2B allows you to configure what information is sent to the Claude API:
-- Shell history
-- Past n2b requests and responses
-- Current working directory
+- Shell history / probably not needed, I added the option to give the llm more context
+- Past n2b requests and responses / probably not needed, I added the option to give the llm more context
+- Current working directory / recommended
 
 You can adjust these settings during configuration.
 
+Always sent to llm
+- prompt
+- shell type 
+- operating system
+
+
 ## Limitations
 
 - The quality of generated commands depends on the Claude AI model's capabilities.

data/lib/n2b/version.rb

@@ -1,4 +1,4 @@
 # lib/n2b/version.rb
 module N2B
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/n2b.rb

@@ -109,7 +109,7 @@ module N2B
     
     def read_llm_history_file
       history = File.read(HISTORY_FILE) if File.exist?(HISTORY_FILE)
-      history || ''
+      history ||= ''
       # limit to 20 most recent commands
       history.split("\n").last(20).join("\n")
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: n2b
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Stefan Nothegger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-08 00:00:00.000000000 Z
+date: 2024-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json