aicli 0.2.7 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c38b286746d1ffdef26b15f61a628e2a5ef9dcc774f5fc7b3b925d2b76df1a45
-  data.tar.gz: 2c0a48abc6fbe2f279ca644d69f3de61e4df895d9950b209268996f4f66fc7b5
+  metadata.gz: f0ecf3b2378a31b6986dd9758fa346b3bd1aeef95547e60f57a16ae990358c3b
+  data.tar.gz: baaf14692eaba18db2ecf54dd77912f5d138153d4698500e519b62496f1455bb
 SHA512:
-  metadata.gz: dc70046850d2544dd0f3c4c4af1827bc40c1fe04a5b24e88b36e873115f7f9adcc1e89c5565e79f9d6205bd65effb3ad3e0365a003cfcac99566f58d5395b50a
-  data.tar.gz: 274a2632ce615915704e9aec158a82fcddbdc2ee589a3d2fbb194a39fc053f376e10f5cbed4375c019ce784461b534d9d357c735a4cd2b856a8ae78485ce5ff0
+  metadata.gz: 49266f502dca2be1094fcaa23cf084b8863e2cecfcfe1e45c281b0e1935c86f0ed597ecfe461deee228a7c97036a5d141ec0505bfa245249f987908318b98779
+  data.tar.gz: fc2e6d276064e9ac15a4cb44e708556a21cb1a6d02f4ac8be6d14fa81b29d81b0d6b45ba5dddac10d51f9a8e0708612c0c975ba45893d6228331b6068ac3090b

data/README.md

@@ -1,29 +1,16 @@
-<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">
-   Natural language to live shell commands — OpenAI &amp; Anthropic.
-</h4>
+# aicli
 
-<p align="center">
-   Chat with the model and run suggested commands in your shell in one seamless flow.
-</p>
+Natural language to live shell commands — OpenAI & Anthropic.
 
-<br>
+Chat with the model and run suggested commands in your shell in one seamless flow.
 
-# aicli
-
-CLI by [Antonio Molinari](https://github.com/magnum). Converts prompts into shell commands, with optional chat mode that can execute them live.
+The gem is named **aicli**; the shell command is **`ai`** (also available as `aicli`).
 
 ## Setup
 
 > Requires Ruby 3.0+
 
-1. Install _aicli_:
+1. Install the gem:
 
    ```sh
    gem install aicli
@@ -43,18 +30,18 @@ CLI by [Antonio Molinari](https://github.com/magnum). Converts prompts into shel
    **OpenAI** (default) — key from [OpenAI](https://platform.openai.com/account/api-keys):
 
    ```sh
-   aicli config set PROVIDER=openai
-   aicli config set OPENAI_KEY=<your token>
+   ai config set PROVIDER=openai
+   ai config set OPENAI_KEY=<your token>
    ```
 
    **Anthropic** — key from [Anthropic](https://console.anthropic.com/settings/keys):
 
    ```sh
-   aicli config set PROVIDER=anthropic
-   aicli config set ANTHROPIC_KEY=<your token>
+   ai config set PROVIDER=anthropic
+   ai config set ANTHROPIC_KEY=<your token>
    ```
 
-   Or use the interactive UI (`aicli config`) to pick provider, key, and model.
+   Or use the interactive UI (`ai config`) to pick provider, key, and model.
    Model lists come from the [RubyLLM](https://rubyllm.com/models/) registry.
 
    Config lives in `~/.aicli/config`. Chat/prompt history is stored in `~/.aicli/context` (last 40 messages) and reloaded on the next run.
@@ -62,31 +49,29 @@ CLI by [Antonio Molinari](https://github.com/magnum). Converts prompts into shel
 ## Usage
 
 ```bash
-aicli <prompt>
+ai <prompt>
 ```
 
 For example:
 
 ```bash
-aicli list all log files
+ai 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'
+ai 'what is my ip address'
 ```
 
 ### Chat mode
 
 ```bash
-aicli chat
+ai chat
 ```
 
 Ask for shell commands in a multi-turn conversation. When the assistant suggests a command in a code fence, you are asked whether to run it; after it runs (or you decline), chat continues. Press `Ctrl+d` to quit.
@@ -94,20 +79,20 @@ Ask for shell commands in a multi-turn conversation. When the assistant suggests
 ### Silent mode (skip explanations)
 
 ```bash
-aicli -s list all log files
+ai -s list all log files
 ```
 
 Or save the preference:
 
 ```bash
-aicli config set SILENT_MODE=true
+ai config set SILENT_MODE=true
 ```
 
 ### Provider and model
 
 ```sh
-aicli config set PROVIDER=openai      # or anthropic
-aicli config set MODEL=gpt-4o-mini    # provider-specific model id
+ai config set PROVIDER=openai      # or anthropic
+ai config set MODEL=gpt-4o-mini    # provider-specific model id
 ```
 
 Defaults: `gpt-4o-mini` (OpenAI), `claude-sonnet-4-6` (Anthropic).
@@ -119,7 +104,7 @@ LLM calls go through [RubyLLM](https://rubyllm.com/), so chat streaming and mode
 Useful for OpenAI-compatible proxies (ignored for Anthropic):
 
 ```sh
-aicli config set OPENAI_API_ENDPOINT=<your proxy endpoint>
+ai config set OPENAI_API_ENDPOINT=<your proxy endpoint>
 ```
 
 Default: `https://api.openai.com/v1`
@@ -146,26 +131,21 @@ Default: `https://api.openai.com/v1`
 | Italian             | it      |
 
 ```sh
-aicli config set LANGUAGE=zh-Hans
+ai config set LANGUAGE=zh-Hans
 ```
 
 ### Config UI
 
 ```bash
-aicli config
+ai config
 ```
 
 ### Upgrading
 
 ```bash
-aicli --version
-gem update aicli
-```
-
-Or:
-
-```bash
-aicli update
+ai --version
+ai update
+# or: gem update aicli
 ```
 
 ## Development
@@ -181,7 +161,7 @@ bundle exec bin/ai chat
 bundle exec bin/ai list all log files
 ```
 
-`bin/aicli` is equivalent to `bin/ai`. `bundle exec` loads dependencies from the Gemfile and code from `lib/`.
+`bundle exec` loads dependencies from the Gemfile and code from `lib/`. `bin/aicli` is an alias of `bin/ai`.
 
 Example config for local testing:
 
@@ -203,4 +183,4 @@ I am not a bash wizard, and am dying for access to the copilot CLI, and got impa
 
 ## Credit
 
-- [Antonio Molinari](https://github.com/magnum)
+Started from [BuilderIO/ai-shell](https://github.com/BuilderIO/ai-shell) (MIT; copyright Builder.io 2023).

data/lib/aicli/cli.rb

@@ -80,7 +80,7 @@ module AiCli
       Commands::Chat.run
     end
 
-    desc 'update', 'Update aicli to the latest version'
+    desc 'update', 'Update the aicli gem to the latest version'
     def update
       init_i18n
       Commands::Update.run

data/lib/aicli/commands/chat.rb

@@ -51,7 +51,7 @@ module AiCli
               user_prompt,
               writer: lambda { |chunk|
                 unless started
-                  spinner.success(pastel.green('aicli:'))
+                  spinner.success(pastel.green('ai:'))
                   puts ''
                   started = true
                 end
@@ -60,7 +60,7 @@ module AiCli
             )
 
             unless started
-              spinner.success(pastel.green('aicli:'))
+              spinner.success(pastel.green('ai:'))
               puts ''
             end
             puts ''

data/lib/aicli/helpers/completion.rb

@@ -40,7 +40,7 @@ module AiCli
         end
       end
 
-      # Multi-turn chat helper used by `aicli chat`.
+      # Multi-turn chat helper used by `ai chat`.
       def start_chat(config)
         chat = Llm.build_chat(config)
         chat.with_instructions(chat_system_prompt)
@@ -49,7 +49,7 @@ module AiCli
 
       def chat_system_prompt
         <<~PROMPT
-          You are aicli, a terminal assistant. The user is asking for shell commands.
+          You are ai, a terminal assistant. The user is asking for shell commands.
 
           Target OS: #{OsDetect.operating_system_name}
           Target shell: #{OsDetect.detect_shell}

data/lib/aicli/helpers/constants.rb

@@ -3,7 +3,7 @@
 module AiCli
   module Helpers
     module Constants
-      COMMAND_NAME = 'aicli'
+      COMMAND_NAME = 'ai'
       PROJECT_NAME = 'aicli'
       REPO_URL = 'https://github.com/magnum/aicli'
     end

data/lib/aicli/helpers/error.rb

@@ -19,7 +19,7 @@ module AiCli
           puts pastel.dim(error.backtrace.join("\n"))
         end
 
-        puts "\n#{indent}#{pastel.dim("aicli v#{AiCli::VERSION}")}"
+        puts "\n#{indent}#{pastel.dim("ai v#{AiCli::VERSION}")}"
         puts "\n#{indent}#{I18n.t('Please open a Bug report with the information above')}:"
         puts "#{indent}https://github.com/magnum/aicli/issues/new"
       end

data/lib/aicli/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AiCli
-  VERSION = '0.2.7'
+  VERSION = '0.2.9'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aicli
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.9
 platform: ruby
 authors:
 - Antonio Molinari
@@ -93,9 +93,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: aicli turns natural language into runnable shell commands using OpenAI
-  or Anthropic. Chat with the model and execute suggested commands live in your shell
-  in one seamless flow.
+description: ai turns natural language into runnable shell commands using OpenAI or
+  Anthropic. Chat with the model and execute suggested commands live in your shell
+  in one seamless flow. Install the aicli gem, then run the ai command.
 email:
 - antoniomolinari@me.com
 executables: