aicli 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 38ddbde1455388bed7ee62cff84c0aaa5cbc7329b0210fb88aacdf9fe39a0e13
+  data.tar.gz: 645ca62e82b191c88951293c8b04263428c7d5c3e4dfa7e6481db6ff59771a1c
+SHA512:
+  metadata.gz: a36e4429798ec0261b2d65b39d038e6276d7680ed87d042d8b8a20b5ede788b5ba5010303103d36c87f25b69ebdcd520ed651f4668110d0ad3d341fb6d0852bf
+  data.tar.gz: 68d9f6c8c3789eca4c5b9ff4e65e31d3598ab5f917985293dab89048c3651ba20ba7761fa46c06f04b06f247b0316adb785c0d0cb611955ae1db032a42f6a85c

data/CHANGELOG.md

@@ -0,0 +1,151 @@
+## 1.0.12
+
+- Bug fixes
+- Default to gpt-4o-mini instead of gpt-3.5-turbo
+
+## 1.0.8
+
+- Fix a bug causing completions to not display in some cases
+- Allow hitting "q" or "esc" to stop the streaming output
+
+## 1.0.7
+
+- Fix a bug causing completions to not display in some cases
+
+## 1.0.6
+
+- Fix for streaming data including the shell command name erroneously, causing the command to fail
+
+## 1.0.5
+
+- Fix using the configured model in all cases
+
+## 1.0.4
+
+- Improve `--help` menu descriptions
+
+## 1.0.3
+
+- Fix choosing custom models
+
+## 1.0.2
+
+- Add Turkish language support
+- Improve config UX (correctly `await` on setting configs)
+
+## 1.0.1
+
+- Fix a typo ("to to" -> "to") [#78](https://github.com/BuilderIO/ai-shell/pull/78)
+
+## 1.0.0
+
+- Overdue major version bump to signify the stability of this CLI
+- Add Indonesian language support
+
+## 0.1.23
+
+- Add support for Android [#75](https://github.com/BuilderIO/ai-shell/pull/75)
+
+## 0.1.22
+
+- Fix a crash on linux [#64](https://github.com/BuilderIO/ai-shell/issues/64)
+
+## 0.1.21
+
+- Fix a bug preventing initial configuration [#69](https://github.com/BuilderIO/ai-shell/issues/69)
+
+## 0.1.20
+
+- Multi language support [#62](https://github.com/BuilderIO/ai-shell/pull/62)
+
+## 0.1.19
+
+- Support Azure keys
+
+## 0.1.18
+
+- Option to copy the generated script to the clipboard
+
+## 0.1.15
+
+- Fix chat mode to support chat history
+
+## 0.1.14
+
+- Adds chat mode
+- Fixes "ai update" to not eagerly capture
+- Improve operating system identification
+
+## 0.1.13
+
+- Fix for using cloudflare proxy (fix streaming logic to handle partial chunks)
+
+## 0.1.12
+
+- Support custom API endpoints
+
+## 0.1.11
+
+- `ai update` command
+- Minor UX improvements and fixes
+
+## 0.1.10
+
+- Obfuscate API key from config UI
+
+## 0.1.9
+
+- Visual config UI (from `ai config ui`)
+
+## 0.1.8
+
+- Better error handling (handle streams and non streams, JSON and strings)
+
+## 0.1.7
+
+- Option to edit script before running
+- Fix error with String.prototype.replaceAll not existing
+
+## 0.1.6
+
+- Silent mode (skip explanation)
+
+## 0.1.5
+
+- Improve error messaging UX, again x3
+
+## 0.1.4
+
+- Improve error messaging, again again
+
+## 0.1.3
+
+- Improve error messaging, again
+
+## 0.1.2
+
+- Improve error messaging
+
+## 0.1.1
+
+- Minor UX improvement ("AI Shell" vs "ai-shell")
+
+## 0.1.0
+
+- Minor error message improvements
+
+## 0.0.18
+
+- Better error handling
+
+## 0.0.17
+
+- Minor improvements to the UX of the revision flow
+
+## 0.0.16
+
+- Take the current operating system into account
+
+## 0.0.15
+
+- Stream responses

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 Antonio Molinari
+Copyright (c) 2023 Builder.io (original Node.js implementation)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,176 @@
+<h2 align="center">
+   <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://cdn.builder.io/api/v1/image/assets%2FYJIGb4i01jvw0SRdL5Bt%2Fb5b9997cec2c4fffb3e5c5e9bb4fed7d">
+      <img width="300" alt="aicli logo" src="https://cdn.builder.io/api/v1/image/assets%2FYJIGb4i01jvw0SRdL5Bt%2Fb7f9d2d9911a4199a9d26f8ba210b3f8">
+    </picture>
+</h2>
+
+<h4 align="center">
+   A CLI that converts natural language to shell commands.
+</h4>
+
+<p align="center">
+   Inspired by the <a href="https://githubnext.com/projects/copilot-cli">GitHub Copilot X CLI</a>, but open source for everyone.
+</p>
+
+<br>
+
+# aicli
+
+Ruby port by [Antonio Molinari](https://github.com/magnum), inspired by the original [BuilderIO/ai-shell](https://github.com/BuilderIO/ai-shell) CLI.
+
+## Setup
+
+> Requires Ruby 3.0+
+
+1. Install _aicli_:
+
+   ```sh
+   gem install aicli
+   ```
+
+   Or from this repository:
+
+   ```sh
+   bundle install
+   bundle exec rake install
+   # or
+   gem build aicli.gemspec && gem install ./aicli-*.gem
+   ```
+
+2. Retrieve your API key from [OpenAI](https://platform.openai.com/account/api-keys)
+
+   > Note: If you haven't already, you'll have to create an account and set up billing.
+
+3. Set the key so aicli can use it:
+
+   ```sh
+   aicli config set OPENAI_KEY=<your token>
+   ```
+
+   This will create a `.aicli` file in your home directory.
+
+## Usage
+
+```bash
+aicli <prompt>
+```
+
+For example:
+
+```bash
+aicli list all log files
+```
+
+Then you will get an output where you can choose to run the suggested command, revise it via a prompt, edit it, copy it, or cancel.
+
+The short alias `ai` is also available.
+
+### Special characters
+
+Some shells handle characters like `?` or `*` specially. Wrap the prompt in quotes if needed:
+
+```bash
+aicli 'what is my ip address'
+```
+
+### Chat mode
+
+```bash
+aicli chat
+```
+
+Engage in a conversation with the AI directly through the CLI.
+
+### Silent mode (skip explanations)
+
+```bash
+aicli -s list all log files
+```
+
+Or save the preference:
+
+```bash
+aicli config set SILENT_MODE=true
+```
+
+### Custom API endpoint
+
+```sh
+aicli config set OPENAI_API_ENDPOINT=<your proxy endpoint>
+```
+
+Default: `https://api.openai.com/v1`
+
+### Set Language
+
+| Language            | Key     |
+| ------------------- | ------- |
+| English             | en      |
+| Simplified Chinese  | zh-Hans |
+| Traditional Chinese | zh-Hant |
+| Spanish             | es      |
+| Japanese            | jp      |
+| Korean              | ko      |
+| French              | fr      |
+| German              | de      |
+| Russian             | ru      |
+| Ukrainian           | uk      |
+| Vietnamese          | vi      |
+| Arabic              | ar      |
+| Portuguese          | pt      |
+| Turkish             | tr      |
+| Indonesian          | id      |
+| Italian             | it      |
+
+```sh
+aicli config set LANGUAGE=zh-Hans
+```
+
+### Config UI
+
+```bash
+aicli config
+```
+
+### Upgrading
+
+```bash
+aicli --version
+gem update aicli
+```
+
+Or:
+
+```bash
+aicli update
+```
+
+## Development
+
+```sh
+bundle install
+bundle exec bin/aicli --help
+bundle exec bin/aicli config set OPENAI_KEY=<your token>
+bundle exec bin/aicli list all log files
+```
+
+## Common Issues
+
+### 429 error
+
+This is due to incorrect billing setup or excessive quota usage. Please follow [this guide](https://help.openai.com/en/articles/6891831-error-code-429-you-exceeded-your-current-quota-please-check-your-plan-and-billing-details) to fix it.
+
+You can activate billing at [this link](https://platform.openai.com/account/billing/overview).
+
+## Motivation
+
+I am not a bash wizard, and am dying for access to the copilot CLI, and got impatient.
+
+## Credit
+
+- Ruby port by [Antonio Molinari](https://github.com/magnum)
+- Inspired by [BuilderIO/ai-shell](https://github.com/BuilderIO/ai-shell)
+- Thanks to GitHub Copilot for their amazing tools and the idea for this
+- Thanks to Hassan and his work on [aicommits](https://github.com/Nutlope/aicommits), which inspired the workflow and some parts of the code and flows
+- Original Node.js implementation by [Builder.io](https://www.builder.io)

data/bin/ai

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/aicli'
+
+AiCli::CLI.start(ARGV)

data/bin/aicli

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/aicli'
+
+AiCli::CLI.start(ARGV)

data/lib/aicli/cli.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'pastel'
+
+module AiCli
+  class CLI < Thor
+    KNOWN_COMMANDS = %w[config chat update help version tree].freeze
+
+    def self.exit_on_failure?
+      true
+    end
+
+    def self.start(given_args = ARGV, config = {})
+      args = given_args.dup
+
+      # Extract global flags that may appear before the prompt text
+      silent = args.delete('--silent') || args.delete('-s')
+      version_flag = args.delete('--version') || args.delete('-v')
+      help_flag = args.delete('--help') || args.delete('-h')
+
+      if version_flag
+        puts AiCli::VERSION
+        return
+      end
+
+      if help_flag && (args.empty? || !KNOWN_COMMANDS.include?(args.first))
+        new.help
+        return
+      end
+
+      # Prompt flag: -p / --prompt
+      prompt_from_flag = nil
+      if (idx = args.index('-p') || args.index('--prompt'))
+        prompt_from_flag = args[idx + 1]
+        args.slice!(idx, 2)
+      end
+
+      first = args.first
+
+      if first.nil? || !KNOWN_COMMANDS.include?(first)
+        # Treat remaining args as the natural-language prompt
+        prompt_text = prompt_from_flag || args.join(' ')
+        invoke_prompt(prompt_text, silent: !silent.nil?)
+        return
+      end
+
+      # Rebuild argv for Thor subcommands, preserving silent if relevant
+      thor_args = args
+      thor_args = ['--silent'] + thor_args if silent && first == 'chat'
+      super(thor_args, config)
+    end
+
+    def self.invoke_prompt(prompt_text, silent: false)
+      pastel = Pastel.new
+
+      begin
+        config = Helpers::Config.get
+        Helpers::I18n.set_language(config['LANGUAGE'])
+      rescue StandardError
+        Helpers::I18n.set_language('en')
+      end
+
+      Prompt.run(use_prompt: prompt_text, silent_mode: silent)
+    rescue Helpers::KnownError, StandardError => e
+      puts "\n#{pastel.red('✖')} #{e.message}"
+      Helpers::Error.handle_cli_error(e)
+      exit 1
+    end
+
+    desc 'config [MODE] [KEY=VALUE...]', 'Configure the CLI'
+    def config(mode = nil, *key_values)
+      init_i18n
+      Commands::Config.run(mode, *key_values)
+    end
+
+    desc 'chat', 'Start a new chat session'
+    def chat
+      init_i18n
+      Commands::Chat.run
+    end
+
+    desc 'update', 'Update aicli to the latest version'
+    def update
+      init_i18n
+      Commands::Update.run
+    end
+
+    map %w[--version -v] => :__print_version
+    desc 'version', 'Print version'
+    def __print_version
+      puts AiCli::VERSION
+    end
+
+    private
+
+    def init_i18n
+      config = Helpers::Config.get
+      Helpers::I18n.set_language(config['LANGUAGE'])
+    rescue StandardError
+      Helpers::I18n.set_language('en')
+    end
+  end
+end

data/lib/aicli/commands/chat.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'pastel'
+require 'tty-prompt'
+require 'tty-spinner'
+
+module AiCli
+  module Commands
+    module Chat
+      module_function
+
+      def run
+        config = Helpers::Config.get
+        key = config['OPENAI_KEY']
+        model = config['MODEL']
+        api_endpoint = config['OPENAI_API_ENDPOINT']
+        chat_history = []
+
+        pastel = Pastel.new
+        prompt = TTY::Prompt.new(interrupt: :exit)
+
+        puts ''
+        puts "┌  #{Helpers::I18n.t('Starting new conversation')}"
+
+        loop do
+          user_prompt = prompt.ask(pastel.cyan("#{Helpers::I18n.t('You')}:")) do |q|
+            q.required true
+            q.validate(/.+/, Helpers::I18n.t('Please enter a prompt.'))
+          end
+
+          if user_prompt.nil? || user_prompt == 'exit'
+            puts "└  #{Helpers::I18n.t('Goodbye!')}"
+            exit 0
+          end
+
+          spinner = TTY::Spinner.new("[:spinner] #{Helpers::I18n.t('THINKING...')}", format: :dots)
+          spinner.auto_spin
+
+          chat_history << { 'role' => 'user', 'content' => user_prompt }
+
+          stream_lines = Helpers::Completion.generate_completion(
+            prompt: chat_history,
+            key: key,
+            model: model,
+            api_endpoint: api_endpoint
+          )
+          enumerator = stream_lines.each
+          read_response = Helpers::Completion.read_data(enumerator)
+
+          spinner.success(pastel.green('aicli:'))
+          puts ''
+          full_response = read_response.call(->(chunk) { print chunk })
+          chat_history << { 'role' => 'assistant', 'content' => full_response }
+          puts ''
+          puts ''
+        end
+      end
+    end
+  end
+end

data/lib/aicli/commands/config.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'pastel'
+
+module AiCli
+  module Commands
+    module Config
+      module_function
+
+      def run(mode = nil, *key_values)
+        pastel = Pastel.new
+
+        if mode.nil? || mode == 'ui'
+          Helpers::Config.show_config_ui
+          return
+        end
+
+        if key_values.empty?
+          puts "#{Helpers::I18n.t('Error')}: #{Helpers::I18n.t('Missing required parameter')} \"key=value\"\n"
+          exit 1
+        end
+
+        case mode
+        when 'get'
+          config = Helpers::Config.get
+          key_values.each do |key|
+            if Helpers::Config.has_own?(config, key)
+              puts "#{key}=#{config[key]}"
+            else
+              raise Helpers::KnownError, "#{Helpers::I18n.t('Invalid config property')}: #{key}"
+            end
+          end
+        when 'set'
+          pairs = key_values.map do |kv|
+            k, v = kv.split('=', 2)
+            [k, v]
+          end
+          Helpers::Config.set(pairs)
+        else
+          raise Helpers::KnownError, "#{Helpers::I18n.t('Invalid mode')}: #{mode}"
+        end
+      rescue Helpers::KnownError, StandardError => e
+        puts "\n#{pastel.red('✖')} #{e.message}"
+        Helpers::Error.handle_cli_error(e)
+        exit 1
+      end
+    end
+  end
+end

data/lib/aicli/commands/update.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'pastel'
+
+module AiCli
+  module Commands
+    module Update
+      module_function
+
+      def run
+        pastel = Pastel.new
+        puts ''
+        command = 'gem update aicli'
+        puts pastel.dim("#{Helpers::I18n.t('Running')}: #{command}")
+        puts ''
+        system(command)
+        puts ''
+      end
+    end
+  end
+end