| Name | yaicli JSON |
| Version |
0.0.11
JSON |
| download |
| home_page | None |
| Summary | A simple CLI tool to interact with LLM |
| upload_time | 2025-04-07 14:14:01 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. |
| keywords |
ai
chatgpt
cli
gpt
interact
interact with chatgpt
interact with gpt
interact with llm
interact with llms
interact with openai
interactive
llm
llms
openai
terminal
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# YAICLI - Your AI Interface in Command Line
[](https://pypi.org/project/yaicli/)
YAICLI is a compact yet potent command-line AI assistant, allowing you to engage with Large Language Models (LLMs) such as ChatGPT's gpt-4o directly via your terminal. It offers multiple operation modes for everyday conversations, generating and executing shell commands, and one-shot quick queries.
Support regular and deep thinking models.
> [!WARNING]
> This is a work in progress, some features could change or be removed in the future.
## Features
- **Multiple Operation Modes**:
- **Chat Mode (💬)**: Interactive conversation with the AI assistant
- **Execute Mode (🚀)**: Generate and execute shell commands specific to your OS and shell
- **Temp Mode**: Quick queries without entering interactive mode
- **Smart Environment Detection**:
- Automatically detects your operating system and shell
- Customizes responses and commands for your specific environment
- **Rich Terminal Interface**:
- Markdown rendering for formatted responses
- Streaming responses for real-time feedback
- Color-coded output for better readability
- **Configurable**:
- Customizable API endpoints
- Support for different LLM providers
- Adjustable response parameters
- **Keyboard Shortcuts**:
- Tab to switch between Chat and Execute modes
- **History**:
- Save and recall previous queries
## Installation
### Prerequisites
- Python 3.9 or higher
### Install from PyPI
```bash
# Install by pip
pip install yaicli
# Install by pipx
pipx install yaicli
# Install by uv
uv tool install yaicli
```
### Install from Source
```bash
git clone https://github.com/yourusername/yaicli.git
cd yaicli
pip install .
```
## Configuration
On first run, YAICLI will create a default configuration file at `~/.config/yaicli/config.ini`. You'll need to edit this file to add your API key and customize other settings.
Just run `ai`, and it will create the config file for you. Then you can edit it to add your api key.
### Configuration File
The default configuration file is located at `~/.config/yaicli/config.ini`. Look at the example below:
```ini
[core]
PROVIDER=OPENAI
BASE_URL=https://api.openai.com/v1
API_KEY=your_api_key_here
MODEL=gpt-4o
# auto detect shell and os
SHELL_NAME=auto
OS_NAME=auto
# if you want to use custom completions path, you can set it here
COMPLETION_PATH=/chat/completions
# if you want to use custom answer path, you can set it here
ANSWER_PATH=choices[0].message.content
# true: streaming response
# false: non-streaming response
STREAM=true
TEMPERATURE=0.7
TOP_P=1.0
MAX_TOKENS=1024
```
### Configuration Options
Below are the available configuration options and override environment variables:
- **BASE_URL**: API endpoint URL (default: OpenAI API), env: AI_BASE_URL
- **API_KEY**: Your API key for the LLM provider, env: AI_API_KEY
- **MODEL**: The model to use (e.g., gpt-4o, gpt-3.5-turbo), default: gpt-4o, env: AI_MODEL
- **SHELL_NAME**: Shell to use (auto for automatic detection), default: auto, env: AI_SHELL_NAME
- **OS_NAME**: OS to use (auto for automatic detection), default: auto, env: AI_OS_NAME
- **COMPLETION_PATH**: Path for completions endpoint, default: /chat/completions, env: AI_COMPLETION_PATH
- **ANSWER_PATH**: Json path expression to extract answer from response, default: choices[0].message.content, env: AI_ANSWER_PATH
- **STREAM**: Enable/disable streaming responses, default: true, env: AI_STREAM
Default config of `COMPLETION_PATH` and `ANSWER_PATH` is OpenAI compatible. If you are using OpenAI or other OpenAI compatible LLM provider, you can use the default config.
If you wish to use other providers that are not compatible with the openai interface, you can use the following config:
- claude:
- BASE_URL: https://api.anthropic.com/v1
- COMPLETION_PATH: /messages
- ANSWER_PATH: content.0.text
- cohere:
- BASE_URL: https://api.cohere.com/v2
- COMPLETION_PATH: /chat
- ANSWER_PATH: message.content.[0].text
- google:
- BASE_URL: https://generativelanguage.googleapis.com/v1beta/openai
- COMPLETION_PATH: /chat/completions
- ANSWER_PATH: choices[0].message.content
You can use google OpenAI complete endpoint and leave `COMPLETION_PATH` and `ANSWER_PATH` as default. BASE_URL: https://generativelanguage.googleapis.com/v1beta/openai. See https://ai.google.dev/gemini-api/docs/openai
Claude also has a testable OpenAI-compatible interface, you can just use Calude endpoint and leave `COMPLETION_PATH` and `ANSWER_PATH` as default. See: https://docs.anthropic.com/en/api/openai-sdk
If you not sure how to config `COMPLETION_PATH` and `ANSWER_PATH`, here is a guide:
1. **Find the API Endpoint**:
- Visit the documentation of the LLM provider you want to use.
- Find the API endpoint for the completion task. This is usually under the "API Reference" or "Developer Documentation" section.
2. **Identify the Response Structure**:
- Look for the structure of the response. This typically includes fields like `choices`, `completion`, etc.
3. **Identify the Path Expression**:
Forexample, claude response structure like this:
```json
{
"content": [
{
"text": "Hi! My name is Claude.",
"type": "text"
}
],
"id": "msg_013Zva2CMHLNnXjNJJKqJ2EF",
"model": "claude-3-7-sonnet-20250219",
"role": "assistant",
"stop_reason": "end_turn",
"stop_sequence": null,
"type": "message",
"usage": {
"input_tokens": 2095,
"output_tokens": 503
}
}
```
We are looking for the `text` field, so the path should be 1.Key `content`, 2.First obj `[0]`, 3.Key `text`. So it should be `content.[0].text`.
## Usage
### Basic Usage
```bash
# One-shot mode
ai "What is the capital of France?"
# Chat mode
ai --chat
# Shell command generation mode
ai --shell "Create a backup of my Documents folder"
# Verbose mode for debugging
ai --verbose "Explain quantum computing"
```
### Command Line Options
- `<PROMPT>`: Argument
- `--verbose` or `-V`: Show verbose information
- `--chat` or `-c`: Start in chat mode
- `--shell` or `-s`: Generate and execute shell command
- `--install-completion`: Install completion for the current shell
- `--show-completion`: Show completion for the current shell, to copy it or customize the installation
- `--help` or `-h`: Show this message and exit
```bash
ai -h
Usage: ai [OPTIONS] [PROMPT]
yaicli. Your AI interface in cli.
╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ prompt [PROMPT] The prompt send to the LLM │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --verbose -V Show verbose information │
│ --chat -c Start in chat mode │
│ --shell -s Generate and execute shell command │
│ --install-completion Install completion for the current shell. │
│ --show-completion Show completion for the current shell, to copy it or customize the installation. │
│ --help -h Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
```
### Interactive Mode
In interactive mode (chat or shell), you can:
- Type your queries and get responses
- Use `Tab` to switch between Chat and Execute modes
- Type '/exit' to exit
- Type '/clear' to clear history
- Type '/his' to show history
### Shell Command Generation
In Execute mode:
1. Enter your request in natural language
2. YAICLI will generate an appropriate shell command
3. Review the command
4. Confirm to execute or reject
## Examples
### Chat Mode Example
```bash
$ ai --chat
💬 > Tell me about the solar system
Assistant:
Certainly! Here’s a brief overview of the solar system:
• Sun: The central star of the solar system, providing light and energy.
• Planets:
• Mercury: Closest to the Sun, smallest planet.
• Venus: Second planet, known for its thick atmosphere and high surface temperature.
• Earth: Third planet, the only known planet to support life.
• Mars: Fourth planet, often called the "Red Planet" due to its reddish appearance.
• Jupiter: Largest planet, a gas giant with many moons.
• Saturn: Known for its prominent ring system, also a gas giant.
• Uranus: An ice giant, known for its unique axial tilt.
• Neptune: Another ice giant, known for its deep blue color.
• Dwarf Planets:
• Pluto: Once considered the ninth planet, now classified as
💬 >
```
### Execute Mode Example
```bash
$ ai --shell "Find all PDF files in my Downloads folder"
Generated command: find ~/Downloads -type f -name "*.pdf"
Execute this command? [y/n]: y
Executing command: find ~/Downloads -type f -name "*.pdf"
/Users/username/Downloads/document1.pdf
/Users/username/Downloads/report.pdf
...
```
## Technical Implementation
YAICLI is built using several Python libraries:
- **Typer**: Provides the command-line interface
- **Rich**: Provides terminal content formatting and beautiful display
- **prompt_toolkit**: Provides interactive command-line input experience
- **requests**: Handles API requests
- **jmespath**: Parses JSON responses
## Contributing
Contributions of code, issue reports, or feature suggestions are welcome.
## License
[Apache License 2.0](LICENSE)
---
*YAICLI - Making your terminal smarter*
Raw data
{
"_id": null,
"home_page": null,
"name": "yaicli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "ai, chatgpt, cli, gpt, interact, interact with chatgpt, interact with gpt, interact with llm, interact with llms, interact with openai, interactive, llm, llms, openai, terminal",
"author": null,
"author_email": "belingud <im.victor@qq.com>",
"download_url": "https://files.pythonhosted.org/packages/c4/0c/80f620936cc5c4868ac6b2f36184e1cb6a591f878777dfc3d5af8df717cd/yaicli-0.0.11.tar.gz",
"platform": null,
"description": "# YAICLI - Your AI Interface in Command Line\n\n[](https://pypi.org/project/yaicli/)\n\n\n\n\nYAICLI is a compact yet potent command-line AI assistant, allowing you to engage with Large Language Models (LLMs) such as ChatGPT's gpt-4o directly via your terminal. It offers multiple operation modes for everyday conversations, generating and executing shell commands, and one-shot quick queries.\n\nSupport regular and deep thinking models.\n\n> [!WARNING] \n> This is a work in progress, some features could change or be removed in the future.\n\n## Features\n\n- **Multiple Operation Modes**:\n - **Chat Mode (\ud83d\udcac)**: Interactive conversation with the AI assistant\n - **Execute Mode (\ud83d\ude80)**: Generate and execute shell commands specific to your OS and shell\n - **Temp Mode**: Quick queries without entering interactive mode\n\n- **Smart Environment Detection**:\n - Automatically detects your operating system and shell\n - Customizes responses and commands for your specific environment\n\n- **Rich Terminal Interface**:\n - Markdown rendering for formatted responses\n - Streaming responses for real-time feedback\n - Color-coded output for better readability\n\n- **Configurable**:\n - Customizable API endpoints\n - Support for different LLM providers\n - Adjustable response parameters\n\n- **Keyboard Shortcuts**:\n - Tab to switch between Chat and Execute modes\n\n- **History**:\n - Save and recall previous queries\n\n## Installation\n\n### Prerequisites\n\n- Python 3.9 or higher\n\n### Install from PyPI\n\n```bash\n# Install by pip\npip install yaicli\n\n# Install by pipx\npipx install yaicli\n\n# Install by uv\nuv tool install yaicli\n```\n\n### Install from Source\n\n```bash\ngit clone https://github.com/yourusername/yaicli.git\ncd yaicli\npip install .\n```\n\n## Configuration\n\nOn first run, YAICLI will create a default configuration file at `~/.config/yaicli/config.ini`. You'll need to edit this file to add your API key and customize other settings.\n\nJust run `ai`, and it will create the config file for you. Then you can edit it to add your api key.\n\n### Configuration File\n\nThe default configuration file is located at `~/.config/yaicli/config.ini`. Look at the example below:\n\n```ini\n[core]\nPROVIDER=OPENAI\nBASE_URL=https://api.openai.com/v1\nAPI_KEY=your_api_key_here\nMODEL=gpt-4o\n\n# auto detect shell and os\nSHELL_NAME=auto\nOS_NAME=auto\n\n# if you want to use custom completions path, you can set it here\nCOMPLETION_PATH=/chat/completions\n# if you want to use custom answer path, you can set it here\nANSWER_PATH=choices[0].message.content\n\n# true: streaming response\n# false: non-streaming response\nSTREAM=true\n\nTEMPERATURE=0.7\nTOP_P=1.0\nMAX_TOKENS=1024\n```\n\n### Configuration Options\n\nBelow are the available configuration options and override environment variables:\n\n- **BASE_URL**: API endpoint URL (default: OpenAI API), env: AI_BASE_URL\n- **API_KEY**: Your API key for the LLM provider, env: AI_API_KEY\n- **MODEL**: The model to use (e.g., gpt-4o, gpt-3.5-turbo), default: gpt-4o, env: AI_MODEL\n- **SHELL_NAME**: Shell to use (auto for automatic detection), default: auto, env: AI_SHELL_NAME\n- **OS_NAME**: OS to use (auto for automatic detection), default: auto, env: AI_OS_NAME\n- **COMPLETION_PATH**: Path for completions endpoint, default: /chat/completions, env: AI_COMPLETION_PATH\n- **ANSWER_PATH**: Json path expression to extract answer from response, default: choices[0].message.content, env: AI_ANSWER_PATH\n- **STREAM**: Enable/disable streaming responses, default: true, env: AI_STREAM\n\nDefault config of `COMPLETION_PATH` and `ANSWER_PATH` is OpenAI compatible. If you are using OpenAI or other OpenAI compatible LLM provider, you can use the default config.\n\nIf you wish to use other providers that are not compatible with the openai interface, you can use the following config:\n\n- claude:\n - BASE_URL: https://api.anthropic.com/v1\n - COMPLETION_PATH: /messages\n - ANSWER_PATH: content.0.text\n- cohere:\n - BASE_URL: https://api.cohere.com/v2\n - COMPLETION_PATH: /chat\n - ANSWER_PATH: message.content.[0].text\n- google:\n - BASE_URL: https://generativelanguage.googleapis.com/v1beta/openai\n - COMPLETION_PATH: /chat/completions\n - ANSWER_PATH: choices[0].message.content\n\nYou can use google OpenAI complete endpoint and leave `COMPLETION_PATH` and `ANSWER_PATH` as default. BASE_URL: https://generativelanguage.googleapis.com/v1beta/openai. See https://ai.google.dev/gemini-api/docs/openai\n\nClaude also has a testable OpenAI-compatible interface, you can just use Calude endpoint and leave `COMPLETION_PATH` and `ANSWER_PATH` as default. See: https://docs.anthropic.com/en/api/openai-sdk\n\nIf you not sure how to config `COMPLETION_PATH` and `ANSWER_PATH`, here is a guide:\n1. **Find the API Endpoint**:\n - Visit the documentation of the LLM provider you want to use.\n - Find the API endpoint for the completion task. This is usually under the \"API Reference\" or \"Developer Documentation\" section.\n2. **Identify the Response Structure**:\n - Look for the structure of the response. This typically includes fields like `choices`, `completion`, etc.\n3. **Identify the Path Expression**:\n Forexample, claude response structure like this:\n ```json\n {\n \"content\": [\n {\n \"text\": \"Hi! My name is Claude.\",\n \"type\": \"text\"\n }\n ],\n \"id\": \"msg_013Zva2CMHLNnXjNJJKqJ2EF\",\n \"model\": \"claude-3-7-sonnet-20250219\",\n \"role\": \"assistant\",\n \"stop_reason\": \"end_turn\",\n \"stop_sequence\": null,\n \"type\": \"message\",\n \"usage\": {\n \"input_tokens\": 2095,\n \"output_tokens\": 503\n }\n }\n ```\n We are looking for the `text` field, so the path should be 1.Key `content`, 2.First obj `[0]`, 3.Key `text`. So it should be `content.[0].text`.\n\n\n## Usage\n\n### Basic Usage\n\n```bash\n# One-shot mode\nai \"What is the capital of France?\"\n\n# Chat mode\nai --chat\n\n# Shell command generation mode\nai --shell \"Create a backup of my Documents folder\"\n\n# Verbose mode for debugging\nai --verbose \"Explain quantum computing\"\n```\n\n### Command Line Options\n\n- `<PROMPT>`: Argument\n- `--verbose` or `-V`: Show verbose information\n- `--chat` or `-c`: Start in chat mode\n- `--shell` or `-s`: Generate and execute shell command\n- `--install-completion`: Install completion for the current shell\n- `--show-completion`: Show completion for the current shell, to copy it or customize the installation\n- `--help` or `-h`: Show this message and exit\n\n```bash\nai -h\n\n Usage: ai [OPTIONS] [PROMPT]\n\n yaicli. Your AI interface in cli.\n\n\u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 prompt [PROMPT] The prompt send to the LLM \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 --verbose -V Show verbose information \u2502\n\u2502 --chat -c Start in chat mode \u2502\n\u2502 --shell -s Generate and execute shell command \u2502\n\u2502 --install-completion Install completion for the current shell. \u2502\n\u2502 --show-completion Show completion for the current shell, to copy it or customize the installation. \u2502\n\u2502 --help -h Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\n\n```\n\n### Interactive Mode\n\nIn interactive mode (chat or shell), you can:\n- Type your queries and get responses\n- Use `Tab` to switch between Chat and Execute modes\n- Type '/exit' to exit\n- Type '/clear' to clear history\n- Type '/his' to show history\n\n### Shell Command Generation\n\nIn Execute mode:\n1. Enter your request in natural language\n2. YAICLI will generate an appropriate shell command\n3. Review the command\n4. Confirm to execute or reject\n\n## Examples\n\n### Chat Mode Example\n\n```bash\n$ ai --chat\n\ud83d\udcac > Tell me about the solar system\n\nAssistant:\nCertainly! Here\u2019s a brief overview of the solar system:\n\n \u2022 Sun: The central star of the solar system, providing light and energy.\n \u2022 Planets:\n \u2022 Mercury: Closest to the Sun, smallest planet.\n \u2022 Venus: Second planet, known for its thick atmosphere and high surface temperature.\n \u2022 Earth: Third planet, the only known planet to support life.\n \u2022 Mars: Fourth planet, often called the \"Red Planet\" due to its reddish appearance.\n \u2022 Jupiter: Largest planet, a gas giant with many moons.\n \u2022 Saturn: Known for its prominent ring system, also a gas giant.\n \u2022 Uranus: An ice giant, known for its unique axial tilt.\n \u2022 Neptune: Another ice giant, known for its deep blue color.\n \u2022 Dwarf Planets:\n \u2022 Pluto: Once considered the ninth planet, now classified as\n\n\ud83d\udcac >\n```\n\n### Execute Mode Example\n\n```bash\n$ ai --shell \"Find all PDF files in my Downloads folder\"\n\nGenerated command: find ~/Downloads -type f -name \"*.pdf\"\nExecute this command? [y/n]: y\n\nExecuting command: find ~/Downloads -type f -name \"*.pdf\"\n\n/Users/username/Downloads/document1.pdf\n/Users/username/Downloads/report.pdf\n...\n```\n\n## Technical Implementation\n\nYAICLI is built using several Python libraries:\n\n- **Typer**: Provides the command-line interface\n- **Rich**: Provides terminal content formatting and beautiful display\n- **prompt_toolkit**: Provides interactive command-line input experience\n- **requests**: Handles API requests\n- **jmespath**: Parses JSON responses\n\n## Contributing\n\nContributions of code, issue reports, or feature suggestions are welcome.\n\n## License\n\n[Apache License 2.0](LICENSE)\n\n---\n\n*YAICLI - Making your terminal smarter*\n",
"bugtrack_url": null,
"license": "Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. \"License\" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. \"Licensor\" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. \"Legal Entity\" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, \"control\" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. \"You\" (or \"Your\") shall mean an individual or Legal Entity exercising permissions granted by this License. \"Source\" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. \"Object\" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. \"Work\" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). \"Derivative Works\" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. \"Contribution\" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, \"submitted\" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as \"Not a Contribution.\" \"Contributor\" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a \"NOTICE\" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets \"[]\" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same \"printed page\" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.",
"summary": "A simple CLI tool to interact with LLM",
"version": "0.0.11",
"project_urls": {
"Documentation": "https://github.com/belingud/yaicli",
"Homepage": "https://github.com/belingud/yaicli",
"Repository": "https://github.com/belingud/yaicli"
},
"split_keywords": [
"ai",
" chatgpt",
" cli",
" gpt",
" interact",
" interact with chatgpt",
" interact with gpt",
" interact with llm",
" interact with llms",
" interact with openai",
" interactive",
" llm",
" llms",
" openai",
" terminal"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "835598391ca7c02abdd6e968d8760eccf0505fe22b7bf2daf6ea62eb1d785dfb",
"md5": "a9732e88c3ddd03c39e81fcf2966090b",
"sha256": "006b848134f20189435e257eab59967cbb89be95aeb920ce19e8934ee578d194"
},
"downloads": -1,
"filename": "yaicli-0.0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a9732e88c3ddd03c39e81fcf2966090b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 20105,
"upload_time": "2025-04-07T14:13:58",
"upload_time_iso_8601": "2025-04-07T14:13:58.510873Z",
"url": "https://files.pythonhosted.org/packages/83/55/98391ca7c02abdd6e968d8760eccf0505fe22b7bf2daf6ea62eb1d785dfb/yaicli-0.0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c40c80f620936cc5c4868ac6b2f36184e1cb6a591f878777dfc3d5af8df717cd",
"md5": "789b0c313f1fd1f92cb75321bf31984c",
"sha256": "8d85f7b7b6d44b8cef0b609993f93bf06b5050f727cfbe987faba9a8cf9526a9"
},
"downloads": -1,
"filename": "yaicli-0.0.11.tar.gz",
"has_sig": false,
"md5_digest": "789b0c313f1fd1f92cb75321bf31984c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 16873,
"upload_time": "2025-04-07T14:14:01",
"upload_time_iso_8601": "2025-04-07T14:14:01.296497Z",
"url": "https://files.pythonhosted.org/packages/c4/0c/80f620936cc5c4868ac6b2f36184e1cb6a591f878777dfc3d5af8df717cd/yaicli-0.0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-04-07 14:14:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "belingud",
"github_project": "yaicli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "yaicli"
}
