cli_buddy 0.0.6+5

A CLI tool to call any AI to ask, auto-complete, and generate code directly from any command line tool.

---

cli_buddy

Generated by the Very Good CLI 🤖

---

Call Any LLM from Your Terminal

• Lightweight (2MB) and Fast
• Supports over 100+ LLMs (GPT, Claude, Cohere, LLama 3, Gemini, Mistral, DeekSeek, and many other LLMs including all Open Source LLMs)
• Use your own API key (OpenRouter)
• Complete privacy - not a single analytic data is collected

Demo

Features

1. Code Generation: Ask for code and directly generate (or overwrite) a file with it.
   • Also available: option to copy to clipboard, ask for explanation, or chat with the context.
2. Shell Command Execution: Ask for a shell command and directly execute it in your terminal.
   • Also available: option to copy to clipboard or ask for explanation.
3. Continuous Chat: Chat with AI continuously in your terminal.
4. Session Management: Save chat history in JSON format locally and load it when starting a new session using -s <session_id>.
   • By default, saving chat history is disabled.
5. OpenRouter APIs: Even though it's made as a CLI tool, this package can also be used for any Dart/Flutter project to use OpenRouter APIs. This package exposes OpenRouter APIs and Models. Simply declare final openRouter = OpenRouterService(); and use it in your project. such as final result = await openRouter.invoke(session: ChatSession(), shouldSkipLog: true);

Getting Started 🚀

Installation

If Dart SDK is Already Installed

dart pub global activate cli_buddy

If Dart SDK is Not Installed

TODO: Add installation instructions using the binary executable and script.

Get API Key from OpenRouter

OpenRouter provides unified LLM APIs at (almost) the same cost as the original LLM API provider. Note: OpenRouter provides some free AI model with some limitations. You can try out for free using those models without payments Note: I am not affliated with OpenRouter and I do not receive any benefits from them for promotion or other reasons.

Add API Key or create secret.env

Easy way Or you can run:

buddy set -k <your openrouter key>

This will create secret.env and buddy.config files at the default path.

Or

Create a secret.env file in the any directory and add:

openrouter_key=YOUR_OPENROUTER_KEY

Then run:

buddy set -s <path/to/secret.env>

Example buddy.config

{
   "secret_env_path":"secret.env",
   "save_session":false,
   "max_messages":20,
   "default_model":"openai/gpt-3.5-turbo",
   "temperature":0.3,
   "max_tokens":null,
   "top_p":null,
   "top_k":null,
   "frequency_penalty":null,
   "presence_penalty":null,
   "repetition_penalty":null,
   "min_p":null,
   "top_a":null,
   "seed":null,
   "logit_bias":null,
   "logprobs":null,
   "top_logprobs":null,
   "response_format":null,
   "stop":null,
   "cmd_prompt":"If there is a lack of details, provide most logical solution.\nEnsure the output is a valid shell command.\nIf multiple steps required try to combine them together in one command.\nProvide only plain text without Markdown formatting.\nDo not provide markdown formatting such as ```.\n",
   "explain_prompt":"Provide short and concise explanation of your previous response about command or code.\nProvide only plain text without Markdown formatting.\nDo not provide markdown formatting such as ```\n",
   "code_prompt":"Provide only code as output without any description.\nProvide only code in plain text format without Markdown formatting.\nDo not include symbols such as ``` or ```python.\nIf there is a lack of details, provide most logical solution.\nYou are not allowed to ask for more details.\nFor example if the prompt is \"Hello world Python\", you should return \"print('Hello world')\".\n",
   "chat_prompt":"Provide concise response unless asked for more details.\nAvoid using any markdown formatting such as ```, *, #.\n"
}

Basic Usage

# Suggest command
$ buddy suggest how can I update homebrew

# If you want to use special characters, use quotes
$ buddy suggest "how can I update homebrew?"

# Coding
$ buddy code "Generate a random number between 1 and 10 in Dart"

# Chat
$ buddy chat "Tell me about the SSH protocol"

# Show CLI version
$ buddy --version

# Show usage help
$ buddy --help

Info Command

The info command allows you to search for AI models in OpenRouter. Below are the available options and flags:

• -q, --query: Search for AI models by name, provider, or model type (e.g., text, image).
• -o, --order: Specify the order in which the results should be displayed. Allowed values: name, context, prompt, completion, image.
• -f, --config: Display the current configuration file. If it does not exist, create a new one.
• -c, --credits: Display the credits available in OpenRouter.
• -l, --list: List all AI models available in OpenRouter.
• -p, --parameters: Query the parameters of a specific AI model.
• -s, --sessions: List saved chat histories in the default session folder or view a specific chat history.

Example Usage

# Search for AI models by name
$ buddy info -q "claude"

# Search for AI models by provider
$ buddy info -q "openai"

# List all available AI models
$ buddy info -l

# Display the current configuration
$ buddy info -f

# Display the credits used for your OpenRouter account
$ buddy info -c

# Query the parameters of a specific AI model
$ buddy info -p "model_id"

# List saved chat histories
$ buddy info -s list

# View a specific chat history by session ID
$ buddy info -s "session_id"

Roadmap

• Refactoring
• Support for RAG (Retrieval-Augmented Generation) using Object_Box
• Installation script for binary executable and setup
• Support for Google Vertex AI API
• Markdown support

Contributions

Contributions are welcome! Feel free to open issues or submit pull requests.

---