yaicli 0.0.5__tar.gz → 0.0.7__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,5 @@
1
1
  [bumpversion]
2
- current_version = 0.0.5
2
+ current_version = 0.0.7
3
3
  commit = True
4
4
  tag = True
5
5
 
@@ -1,4 +1,45 @@
1
1
 
2
+ ---
3
+ ## [0.0.7](https://github.com/belingud/yaicli/compare/v0.0.6..v0.0.7) - 2025-04-04
4
+
5
+ ### 🚜 Refactor
6
+
7
+ - simplify CLI structure and improve code maintainability - ([4eed7d8](https://github.com/belingud/yaicli/commit/4eed7d85abf3a75766e015533682beb2998f8c3e)) - Belingud
8
+
9
+ ### ⚙️ Miscellaneous Tasks
10
+
11
+ - update yaicli version to 0.0.6 and CHANGELOG - ([563a468](https://github.com/belingud/yaicli/commit/563a4681c1a2e96a0609f2bd9822410567c4d0d0)) - Belingud
12
+
13
+
14
+ ---
15
+ ## [0.0.6](https://github.com/belingud/yaicli/compare/v0.0.5..v0.0.6) - 2025-04-03
16
+
17
+ ### 🚜 Refactor
18
+
19
+ - update environment variable names and remove max_tokens - ([3abba5f](https://github.com/belingud/yaicli/commit/3abba5fe189b3de0d005907e159a46291a69636f)) - Belingud
20
+ - simplify config handling and remove DEFAULT_MODE - ([3439eda](https://github.com/belingud/yaicli/commit/3439eda71fdb24816de9c61c7ccee389e32c53b2)) - Belingud
21
+
22
+ ### ⚙️ Miscellaneous Tasks
23
+
24
+ - update CHANGELOG and uv.lock for version 0.0.5 - ([d5abef4](https://github.com/belingud/yaicli/commit/d5abef4b602355fe472abaecd07f2701e8a38e4b)) - Belingud
25
+
26
+
27
+ ---
28
+ ## [0.0.5](https://github.com/belingud/yaicli/compare/v0.0.4..v0.0.5) - 2025-04-02
29
+
30
+ ### 🚜 Refactor
31
+
32
+ - rename ShellAI to YAICLI and update related tests - ([2284297](https://github.com/belingud/yaicli/commit/2284297d018851abcb74f01064554b00df821301)) - Belingud
33
+
34
+ ### 📚 Documentation
35
+
36
+ - update README with detailed project information and usage instructions - ([c71d50c](https://github.com/belingud/yaicli/commit/c71d50c9d232c47a3cdbe035d03c1f4a0dbbe7d2)) - Belingud
37
+
38
+ ### ⚙️ Miscellaneous Tasks
39
+
40
+ - update yaicli version to 0.0.4 - ([03cdedb](https://github.com/belingud/yaicli/commit/03cdedb38465adcf4fc10d4379b2d939daf22d9d)) - Belingud
41
+
42
+
2
43
  ---
3
44
  ## [0.0.4](https://github.com/belingud/yaicli/compare/v0.0.3..v0.0.4) - 2025-04-02
4
45
 
@@ -14,7 +14,7 @@ clean:
14
14
  # Run tests with pytest
15
15
  test:
16
16
  @echo "Running tests..."
17
- @pytest tests/
17
+ @pytest
18
18
 
19
19
  # Build package with hatch (runs clean first)
20
20
  build:
@@ -25,7 +25,7 @@ build:
25
25
  # Install package in editable mode
26
26
  install:
27
27
  @echo "Installing packages..."
28
- @pip install -e .
28
+ @uv sync
29
29
 
30
30
  # Generate changelog from git log
31
31
  changelog:
yaicli-0.0.7/PKG-INFO ADDED
@@ -0,0 +1,454 @@
1
+ Metadata-Version: 2.4
2
+ Name: yaicli
3
+ Version: 0.0.7
4
+ Summary: A simple CLI tool to interact with LLM
5
+ Project-URL: Homepage, https://github.com/belingud/yaicli
6
+ Project-URL: Repository, https://github.com/belingud/yaicli
7
+ Project-URL: Documentation, https://github.com/belingud/yaicli
8
+ Author-email: belingud <im.victor@qq.com>
9
+ License: Apache License
10
+ Version 2.0, January 2004
11
+ http://www.apache.org/licenses/
12
+
13
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
14
+
15
+ 1. Definitions.
16
+
17
+ "License" shall mean the terms and conditions for use, reproduction,
18
+ and distribution as defined by Sections 1 through 9 of this document.
19
+
20
+ "Licensor" shall mean the copyright owner or entity authorized by
21
+ the copyright owner that is granting the License.
22
+
23
+ "Legal Entity" shall mean the union of the acting entity and all
24
+ other entities that control, are controlled by, or are under common
25
+ control with that entity. For the purposes of this definition,
26
+ "control" means (i) the power, direct or indirect, to cause the
27
+ direction or management of such entity, whether by contract or
28
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
29
+ outstanding shares, or (iii) beneficial ownership of such entity.
30
+
31
+ "You" (or "Your") shall mean an individual or Legal Entity
32
+ exercising permissions granted by this License.
33
+
34
+ "Source" form shall mean the preferred form for making modifications,
35
+ including but not limited to software source code, documentation
36
+ source, and configuration files.
37
+
38
+ "Object" form shall mean any form resulting from mechanical
39
+ transformation or translation of a Source form, including but
40
+ not limited to compiled object code, generated documentation,
41
+ and conversions to other media types.
42
+
43
+ "Work" shall mean the work of authorship, whether in Source or
44
+ Object form, made available under the License, as indicated by a
45
+ copyright notice that is included in or attached to the work
46
+ (an example is provided in the Appendix below).
47
+
48
+ "Derivative Works" shall mean any work, whether in Source or Object
49
+ form, that is based on (or derived from) the Work and for which the
50
+ editorial revisions, annotations, elaborations, or other modifications
51
+ represent, as a whole, an original work of authorship. For the purposes
52
+ of this License, Derivative Works shall not include works that remain
53
+ separable from, or merely link (or bind by name) to the interfaces of,
54
+ the Work and Derivative Works thereof.
55
+
56
+ "Contribution" shall mean any work of authorship, including
57
+ the original version of the Work and any modifications or additions
58
+ to that Work or Derivative Works thereof, that is intentionally
59
+ submitted to Licensor for inclusion in the Work by the copyright owner
60
+ or by an individual or Legal Entity authorized to submit on behalf of
61
+ the copyright owner. For the purposes of this definition, "submitted"
62
+ means any form of electronic, verbal, or written communication sent
63
+ to the Licensor or its representatives, including but not limited to
64
+ communication on electronic mailing lists, source code control systems,
65
+ and issue tracking systems that are managed by, or on behalf of, the
66
+ Licensor for the purpose of discussing and improving the Work, but
67
+ excluding communication that is conspicuously marked or otherwise
68
+ designated in writing by the copyright owner as "Not a Contribution."
69
+
70
+ "Contributor" shall mean Licensor and any individual or Legal Entity
71
+ on behalf of whom a Contribution has been received by Licensor and
72
+ subsequently incorporated within the Work.
73
+
74
+ 2. Grant of Copyright License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ copyright license to reproduce, prepare Derivative Works of,
78
+ publicly display, publicly perform, sublicense, and distribute the
79
+ Work and such Derivative Works in Source or Object form.
80
+
81
+ 3. Grant of Patent License. Subject to the terms and conditions of
82
+ this License, each Contributor hereby grants to You a perpetual,
83
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
84
+ (except as stated in this section) patent license to make, have made,
85
+ use, offer to sell, sell, import, and otherwise transfer the Work,
86
+ where such license applies only to those patent claims licensable
87
+ by such Contributor that are necessarily infringed by their
88
+ Contribution(s) alone or by combination of their Contribution(s)
89
+ with the Work to which such Contribution(s) was submitted. If You
90
+ institute patent litigation against any entity (including a
91
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
92
+ or a Contribution incorporated within the Work constitutes direct
93
+ or contributory patent infringement, then any patent licenses
94
+ granted to You under this License for that Work shall terminate
95
+ as of the date such litigation is filed.
96
+
97
+ 4. Redistribution. You may reproduce and distribute copies of the
98
+ Work or Derivative Works thereof in any medium, with or without
99
+ modifications, and in Source or Object form, provided that You
100
+ meet the following conditions:
101
+
102
+ (a) You must give any other recipients of the Work or
103
+ Derivative Works a copy of this License; and
104
+
105
+ (b) You must cause any modified files to carry prominent notices
106
+ stating that You changed the files; and
107
+
108
+ (c) You must retain, in the Source form of any Derivative Works
109
+ that You distribute, all copyright, patent, trademark, and
110
+ attribution notices from the Source form of the Work,
111
+ excluding those notices that do not pertain to any part of
112
+ the Derivative Works; and
113
+
114
+ (d) If the Work includes a "NOTICE" text file as part of its
115
+ distribution, then any Derivative Works that You distribute must
116
+ include a readable copy of the attribution notices contained
117
+ within such NOTICE file, excluding those notices that do not
118
+ pertain to any part of the Derivative Works, in at least one
119
+ of the following places: within a NOTICE text file distributed
120
+ as part of the Derivative Works; within the Source form or
121
+ documentation, if provided along with the Derivative Works; or,
122
+ within a display generated by the Derivative Works, if and
123
+ wherever such third-party notices normally appear. The contents
124
+ of the NOTICE file are for informational purposes only and
125
+ do not modify the License. You may add Your own attribution
126
+ notices within Derivative Works that You distribute, alongside
127
+ or as an addendum to the NOTICE text from the Work, provided
128
+ that such additional attribution notices cannot be construed
129
+ as modifying the License.
130
+
131
+ You may add Your own copyright statement to Your modifications and
132
+ may provide additional or different license terms and conditions
133
+ for use, reproduction, or distribution of Your modifications, or
134
+ for any such Derivative Works as a whole, provided Your use,
135
+ reproduction, and distribution of the Work otherwise complies with
136
+ the conditions stated in this License.
137
+
138
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
139
+ any Contribution intentionally submitted for inclusion in the Work
140
+ by You to the Licensor shall be under the terms and conditions of
141
+ this License, without any additional terms or conditions.
142
+ Notwithstanding the above, nothing herein shall supersede or modify
143
+ the terms of any separate license agreement you may have executed
144
+ with Licensor regarding such Contributions.
145
+
146
+ 6. Trademarks. This License does not grant permission to use the trade
147
+ names, trademarks, service marks, or product names of the Licensor,
148
+ except as required for reasonable and customary use in describing the
149
+ origin of the Work and reproducing the content of the NOTICE file.
150
+
151
+ 7. Disclaimer of Warranty. Unless required by applicable law or
152
+ agreed to in writing, Licensor provides the Work (and each
153
+ Contributor provides its Contributions) on an "AS IS" BASIS,
154
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
155
+ implied, including, without limitation, any warranties or conditions
156
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
157
+ PARTICULAR PURPOSE. You are solely responsible for determining the
158
+ appropriateness of using or redistributing the Work and assume any
159
+ risks associated with Your exercise of permissions under this License.
160
+
161
+ 8. Limitation of Liability. In no event and under no legal theory,
162
+ whether in tort (including negligence), contract, or otherwise,
163
+ unless required by applicable law (such as deliberate and grossly
164
+ negligent acts) or agreed to in writing, shall any Contributor be
165
+ liable to You for damages, including any direct, indirect, special,
166
+ incidental, or consequential damages of any character arising as a
167
+ result of this License or out of the use or inability to use the
168
+ Work (including but not limited to damages for loss of goodwill,
169
+ work stoppage, computer failure or malfunction, or any and all
170
+ other commercial damages or losses), even if such Contributor
171
+ has been advised of the possibility of such damages.
172
+
173
+ 9. Accepting Warranty or Additional Liability. While redistributing
174
+ the Work or Derivative Works thereof, You may choose to offer,
175
+ and charge a fee for, acceptance of support, warranty, indemnity,
176
+ or other liability obligations and/or rights consistent with this
177
+ License. However, in accepting such obligations, You may act only
178
+ on Your own behalf and on Your sole responsibility, not on behalf
179
+ of any other Contributor, and only if You agree to indemnify,
180
+ defend, and hold each Contributor harmless for any liability
181
+ incurred by, or claims asserted against, such Contributor by reason
182
+ of your accepting any such warranty or additional liability.
183
+
184
+ END OF TERMS AND CONDITIONS
185
+
186
+ APPENDIX: How to apply the Apache License to your work.
187
+
188
+ To apply the Apache License to your work, attach the following
189
+ boilerplate notice, with the fields enclosed by brackets "[]"
190
+ replaced with your own identifying information. (Don't include
191
+ the brackets!) The text should be enclosed in the appropriate
192
+ comment syntax for the file format. We also recommend that a
193
+ file or class name and description of purpose be included on the
194
+ same "printed page" as the copyright notice for easier
195
+ identification within third-party archives.
196
+
197
+ Copyright [yyyy] [name of copyright owner]
198
+
199
+ Licensed under the Apache License, Version 2.0 (the "License");
200
+ you may not use this file except in compliance with the License.
201
+ You may obtain a copy of the License at
202
+
203
+ http://www.apache.org/licenses/LICENSE-2.0
204
+
205
+ Unless required by applicable law or agreed to in writing, software
206
+ distributed under the License is distributed on an "AS IS" BASIS,
207
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
208
+ See the License for the specific language governing permissions and
209
+ limitations under the License.
210
+ License-File: LICENSE
211
+ 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
212
+ Classifier: License :: OSI Approved :: MIT License
213
+ Classifier: Operating System :: OS Independent
214
+ Classifier: Programming Language :: Python :: 3
215
+ Requires-Python: >=3.9
216
+ Requires-Dist: distro>=1.9.0
217
+ Requires-Dist: jmespath>=1.0.1
218
+ Requires-Dist: prompt-toolkit>=3.0.50
219
+ Requires-Dist: requests>=2.32.3
220
+ Requires-Dist: rich>=13.9.4
221
+ Requires-Dist: typer>=0.15.2
222
+ Description-Content-Type: text/markdown
223
+
224
+ # YAICLI - Your AI Command Line Interface
225
+
226
+ YAICLI is a powerful command-line AI assistant tool that enables you to interact with Large Language Models (LLMs) like ChatGPT's gpt-4o through your terminal. It offers multiple operation modes for everyday conversations, generating and executing shell commands, and one-shot quick queries.
227
+
228
+ > [!WARNING]
229
+ > This is a work in progress, some features could change or be removed in the future.
230
+
231
+ ## Features
232
+
233
+ - **Multiple Operation Modes**:
234
+ - **Chat Mode (💬)**: Interactive conversation with the AI assistant
235
+ - **Execute Mode (🚀)**: Generate and execute shell commands specific to your OS and shell
236
+ - **Temp Mode**: Quick queries without entering interactive mode
237
+
238
+ - **Smart Environment Detection**:
239
+ - Automatically detects your operating system and shell
240
+ - Customizes responses and commands for your specific environment
241
+
242
+ - **Rich Terminal Interface**:
243
+ - Markdown rendering for formatted responses
244
+ - Streaming responses for real-time feedback
245
+ - Color-coded output for better readability
246
+
247
+ - **Configurable**:
248
+ - Customizable API endpoints
249
+ - Support for different LLM providers
250
+ - Adjustable response parameters
251
+
252
+ - **Keyboard Shortcuts**:
253
+ - Tab to switch between Chat and Execute modes
254
+
255
+ ## Installation
256
+
257
+ ### Prerequisites
258
+
259
+ - Python 3.9 or higher
260
+
261
+ ### Install from PyPI
262
+
263
+ ```bash
264
+ # Install by pip
265
+ pip install yaicli
266
+
267
+ # Install by pipx
268
+ pipx install yaicli
269
+
270
+ # Install by uv
271
+ uv tool install yaicli
272
+ ```
273
+
274
+ ### Install from Source
275
+
276
+ ```bash
277
+ git clone https://github.com/yourusername/yaicli.git
278
+ cd yaicli
279
+ pip install .
280
+ ```
281
+
282
+ ## Configuration
283
+
284
+ 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.
285
+
286
+ Just run `ai`, and it will create the config file for you. Then you can edit it to add your api key.
287
+
288
+ ### Configuration File
289
+
290
+ The default configuration file is located at `~/.config/yaicli/config.ini`. Look at the example below:
291
+
292
+ ```ini
293
+ [core]
294
+ BASE_URL=https://api.openai.com/v1
295
+ API_KEY=your_api_key_here
296
+ MODEL=gpt-4o
297
+
298
+ # auto detect shell and os
299
+ SHELL_NAME=auto
300
+ OS_NAME=auto
301
+
302
+ # if you want to use custom completions path, you can set it here
303
+ COMPLETION_PATH=/chat/completions
304
+ # if you want to use custom answer path, you can set it here
305
+ ANSWER_PATH=choices[0].message.content
306
+
307
+ # true: streaming response
308
+ # false: non-streaming response
309
+ STREAM=true
310
+ ```
311
+
312
+ ### Configuration Options
313
+
314
+ Below are the available configuration options and override environment variables:
315
+
316
+ - **BASE_URL**: API endpoint URL (default: OpenAI API), env: AI_BASE_URL
317
+ - **API_KEY**: Your API key for the LLM provider, env: AI_API_KEY
318
+ - **MODEL**: The model to use (e.g., gpt-4o, gpt-3.5-turbo), default: gpt-4o, env: AI_MODEL
319
+ - **SHELL_NAME**: Shell to use (auto for automatic detection), default: auto, env: AI_SHELL_NAME
320
+ - **OS_NAME**: OS to use (auto for automatic detection), default: auto, env: AI_OS_NAME
321
+ - **COMPLETION_PATH**: Path for completions endpoint, default: /chat/completions, env: AI_COMPLETION_PATH
322
+ - **ANSWER_PATH**: Json path expression to extract answer from response, default: choices[0].message.content, env: AI_ANSWER_PATH
323
+ - **STREAM**: Enable/disable streaming responses, default: true, env: AI_STREAM
324
+
325
+ ## Usage
326
+
327
+ ### Basic Usage
328
+
329
+ ```bash
330
+ # One-shot mode
331
+ ai "What is the capital of France?"
332
+
333
+ # Chat mode
334
+ ai --chat
335
+
336
+ # Shell command generation mode
337
+ ai --shell "Create a backup of my Documents folder"
338
+
339
+ # Verbose mode for debugging
340
+ ai --verbose "Explain quantum computing"
341
+ ```
342
+
343
+ ### Command Line Options
344
+
345
+ - `<PROMPT>`: Argument
346
+ - `--verbose` or `-V`: Show verbose information
347
+ - `--chat` or `-c`: Start in chat mode
348
+ - `--shell` or `-s`: Generate and execute shell command
349
+ - `--install-completion`: Install completion for the current shell
350
+ - `--show-completion`: Show completion for the current shell, to copy it or customize the installation
351
+ - `--help` or `-h`: Show this message and exit
352
+
353
+ ```bash
354
+ ai -h
355
+
356
+ Usage: ai [OPTIONS] [PROMPT]
357
+
358
+ yaicli. Your AI interface in cli.
359
+
360
+ ╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
361
+ │ prompt [PROMPT] The prompt send to the LLM │
362
+ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
363
+ ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
364
+ │ --verbose -V Show verbose information │
365
+ │ --chat -c Start in chat mode │
366
+ │ --shell -s Generate and execute shell command │
367
+ │ --install-completion Install completion for the current shell. │
368
+ │ --show-completion Show completion for the current shell, to copy it or customize the installation. │
369
+ │ --help -h Show this message and exit. │
370
+ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
371
+
372
+
373
+ ```
374
+
375
+ ### Interactive Mode
376
+
377
+ In interactive mode (chat or shell), you can:
378
+ - Type your queries and get responses
379
+ - Use `Tab` to switch between Chat and Execute modes
380
+ - Type '/exit' to exit
381
+ - Type '/clear' to clear history
382
+ - Type '/his' to show history
383
+
384
+ ### Shell Command Generation
385
+
386
+ In Execute mode:
387
+ 1. Enter your request in natural language
388
+ 2. YAICLI will generate an appropriate shell command
389
+ 3. Review the command
390
+ 4. Confirm to execute or reject
391
+
392
+ ## Examples
393
+
394
+ ### Chat Mode Example
395
+
396
+ ```bash
397
+ $ ai --chat
398
+ 💬 > Tell me about the solar system
399
+
400
+ Assistant:
401
+ Certainly! Here’s a brief overview of the solar system:
402
+
403
+ • Sun: The central star of the solar system, providing light and energy.
404
+ • Planets:
405
+ • Mercury: Closest to the Sun, smallest planet.
406
+ • Venus: Second planet, known for its thick atmosphere and high surface temperature.
407
+ • Earth: Third planet, the only known planet to support life.
408
+ • Mars: Fourth planet, often called the "Red Planet" due to its reddish appearance.
409
+ • Jupiter: Largest planet, a gas giant with many moons.
410
+ • Saturn: Known for its prominent ring system, also a gas giant.
411
+ • Uranus: An ice giant, known for its unique axial tilt.
412
+ • Neptune: Another ice giant, known for its deep blue color.
413
+ • Dwarf Planets:
414
+ • Pluto: Once considered the ninth planet, now classified as
415
+
416
+ 💬 >
417
+ ```
418
+
419
+ ### Execute Mode Example
420
+
421
+ ```bash
422
+ $ ai --shell "Find all PDF files in my Downloads folder"
423
+
424
+ Generated command: find ~/Downloads -type f -name "*.pdf"
425
+ Execute this command? [y/n]: y
426
+
427
+ Executing command: find ~/Downloads -type f -name "*.pdf"
428
+
429
+ /Users/username/Downloads/document1.pdf
430
+ /Users/username/Downloads/report.pdf
431
+ ...
432
+ ```
433
+
434
+ ## Technical Implementation
435
+
436
+ YAICLI is built using several Python libraries:
437
+
438
+ - **Typer**: Provides the command-line interface
439
+ - **Rich**: Provides terminal content formatting and beautiful display
440
+ - **prompt_toolkit**: Provides interactive command-line input experience
441
+ - **requests**: Handles API requests
442
+ - **jmespath**: Parses JSON responses
443
+
444
+ ## Contributing
445
+
446
+ Contributions of code, issue reports, or feature suggestions are welcome.
447
+
448
+ ## License
449
+
450
+ [Apache License 2.0](LICENSE)
451
+
452
+ ---
453
+
454
+ *YAICLI - Making your terminal smarter*
@@ -1,6 +1,9 @@
1
1
  # YAICLI - Your AI Command Line Interface
2
2
 
3
- YAICLI is a powerful command-line AI assistant tool that enables you to interact with Large Language Models (LLMs) through your terminal. It offers multiple operation modes for everyday conversations, generating and executing shell commands, and one-shot quick queries.
3
+ YAICLI is a powerful command-line AI assistant tool that enables you to interact with Large Language Models (LLMs) like ChatGPT's gpt-4o through your terminal. It offers multiple operation modes for everyday conversations, generating and executing shell commands, and one-shot quick queries.
4
+
5
+ > [!WARNING]
6
+ > This is a work in progress, some features could change or be removed in the future.
4
7
 
5
8
  ## Features
6
9
 
@@ -31,7 +34,6 @@ YAICLI is a powerful command-line AI assistant tool that enables you to interact
31
34
  ### Prerequisites
32
35
 
33
36
  - Python 3.9 or higher
34
- - pip (Python package manager)
35
37
 
36
38
  ### Install from PyPI
37
39
 
@@ -62,18 +64,14 @@ Just run `ai`, and it will create the config file for you. Then you can edit it
62
64
 
63
65
  ### Configuration File
64
66
 
67
+ The default configuration file is located at `~/.config/yaicli/config.ini`. Look at the example below:
68
+
65
69
  ```ini
66
70
  [core]
67
71
  BASE_URL=https://api.openai.com/v1
68
72
  API_KEY=your_api_key_here
69
73
  MODEL=gpt-4o
70
74
 
71
- # default run mode, default: temp
72
- # chat: interactive chat mode
73
- # exec: shell command generation mode
74
- # temp: one-shot mode
75
- DEFAULT_MODE=temp
76
-
77
75
  # auto detect shell and os
78
76
  SHELL_NAME=auto
79
77
  OS_NAME=auto
@@ -90,15 +88,16 @@ STREAM=true
90
88
 
91
89
  ### Configuration Options
92
90
 
93
- - **BASE_URL**: API endpoint URL (default: OpenAI API)
94
- - **API_KEY**: Your API key for the LLM provider
95
- - **MODEL**: The model to use (e.g., gpt-4o, gpt-3.5-turbo), default: gpt-4o
96
- - **DEFAULT_MODE**: Default operation mode (chat, exec, or temp), default: temp
97
- - **SHELL_NAME**: Shell to use (auto for automatic detection), default: auto
98
- - **OS_NAME**: OS to use (auto for automatic detection), default: auto
99
- - **COMPLETION_PATH**: Path for completions endpoint, default: /chat/completions
100
- - **ANSWER_PATH**: Json path expression to extract answer from response, default: choices[0].message.content
101
- - **STREAM**: Enable/disable streaming responses
91
+ Below are the available configuration options and override environment variables:
92
+
93
+ - **BASE_URL**: API endpoint URL (default: OpenAI API), env: AI_BASE_URL
94
+ - **API_KEY**: Your API key for the LLM provider, env: AI_API_KEY
95
+ - **MODEL**: The model to use (e.g., gpt-4o, gpt-3.5-turbo), default: gpt-4o, env: AI_MODEL
96
+ - **SHELL_NAME**: Shell to use (auto for automatic detection), default: auto, env: AI_SHELL_NAME
97
+ - **OS_NAME**: OS to use (auto for automatic detection), default: auto, env: AI_OS_NAME
98
+ - **COMPLETION_PATH**: Path for completions endpoint, default: /chat/completions, env: AI_COMPLETION_PATH
99
+ - **ANSWER_PATH**: Json path expression to extract answer from response, default: choices[0].message.content, env: AI_ANSWER_PATH
100
+ - **STREAM**: Enable/disable streaming responses, default: true, env: AI_STREAM
102
101
 
103
102
  ## Usage
104
103
 
@@ -155,7 +154,9 @@ ai -h
155
154
  In interactive mode (chat or shell), you can:
156
155
  - Type your queries and get responses
157
156
  - Use `Tab` to switch between Chat and Execute modes
158
- - Type 'exit' or 'quit' to exit
157
+ - Type '/exit' to exit
158
+ - Type '/clear' to clear history
159
+ - Type '/his' to show history
159
160
 
160
161
  ### Shell Command Generation
161
162
 
@@ -0,0 +1,66 @@
1
+ [project]
2
+ name = "yaicli"
3
+ version = "0.0.7"
4
+ description = "A simple CLI tool to interact with LLM"
5
+ authors = [{ name = "belingud", email = "im.victor@qq.com" }]
6
+ readme = "README.md"
7
+ requires-python = ">=3.9"
8
+ license = { file = "LICENSE" }
9
+ classifiers = [
10
+ "Programming Language :: Python :: 3",
11
+ "License :: OSI Approved :: MIT License",
12
+ "Operating System :: OS Independent",
13
+ ]
14
+ keywords = [
15
+ "cli",
16
+ "llm",
17
+ "ai",
18
+ "chatgpt",
19
+ "openai",
20
+ "gpt",
21
+ "llms",
22
+ "openai",
23
+ "terminal",
24
+ "interactive",
25
+ "interact",
26
+ "interact with llm",
27
+ "interact with chatgpt",
28
+ "interact with openai",
29
+ "interact with gpt",
30
+ "interact with llms",
31
+ ]
32
+ dependencies = [
33
+ "distro>=1.9.0",
34
+ "jmespath>=1.0.1",
35
+ "prompt-toolkit>=3.0.50",
36
+ "requests>=2.32.3",
37
+ "rich>=13.9.4",
38
+ "typer>=0.15.2",
39
+ ]
40
+ [project.urls]
41
+ Homepage = "https://github.com/belingud/yaicli"
42
+ Repository = "https://github.com/belingud/yaicli"
43
+ Documentation = "https://github.com/belingud/yaicli"
44
+
45
+ [project.scripts]
46
+ ai = "yaicli:app"
47
+
48
+ [tool.uv]
49
+ resolution = "highest"
50
+
51
+ [dependency-groups]
52
+ dev = [
53
+ "bump2version>=1.0.1",
54
+ "pytest>=8.3.5",
55
+ "ruff>=0.11.2",
56
+ ]
57
+
58
+ [tool.ruff]
59
+ line-length = 120
60
+ select = ["E", "F", "W", "I", "B", "C90"]
61
+ ignore = ["E501"]
62
+
63
+
64
+ [build-system]
65
+ requires = ["hatchling>=1.18.0"]
66
+ build-backend = "hatchling.build"