yaicli 0.3.0__tar.gz → 0.3.2__tar.gz

{yaicli-0.3.0 → yaicli-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yaicli
-Version: 0.3.0
+Version: 0.3.2
 Summary: A simple CLI tool to interact with LLM
 Project-URL: Homepage, https://github.com/belingud/yaicli
 Project-URL: Repository, https://github.com/belingud/yaicli
@@ -465,6 +465,9 @@ ai --chat
 # Generate and execute shell commands
 ai --shell "Create a backup of my Documents folder"
 
+# Generate code snippets, default in Python
+ai --code "Write a Python function to sort a list"
+
 # Analyze code from a file
 cat app.py | ai "Explain what this code does"
 
@@ -475,17 +478,50 @@ ai --verbose "Explain quantum computing"
 ### Command Line Reference
 
 ```
-Usage: ai [OPTIONS] [PROMPT]
+ Usage: ai [OPTIONS] [PROMPT]
+
+ YAICLI: Your AI assistant in the command line.
+ Call with a PROMPT to get a direct answer, use --shell to execute as command, or use --chat for an interactive session.
+
+╭─ Arguments ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│   prompt      [PROMPT]  The prompt to send to the LLM. Reads from stdin if available. [default: None]                                   │
+╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ --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.                                                                             │
+╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ LLM Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ --model        -M      TEXT                       Specify the model to use.                                                             │
+│ --temperature  -T      FLOAT RANGE [0.0<=x<=2.0]  Specify the temperature to use. [default: 0.7]                                        │
+│ --top-p        -P      FLOAT RANGE [0.0<=x<=1.0]  Specify the top-p to use. [default: 1.0]                                              │
+│ --max-tokens   -M      INTEGER RANGE [x>=1]       Specify the max tokens to use. [default: 1024]                                        │
+╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Role Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ --role         -r      TEXT  Specify the assistant role to use. [default: DEFAULT]                                                      │
+│ --create-role          TEXT  Create a new role with the specified name.                                                                 │
+│ --delete-role          TEXT  Delete a role with the specified name.                                                                     │
+│ --list-roles                 List all available roles.                                                                                  │
+│ --show-role            TEXT  Show the role with the specified name.                                                                     │
+╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Chat Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ --chat        -c        Start in interactive chat mode.                                                                                 │
+│ --list-chats            List saved chat sessions.                                                                                       │
+╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Shell Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ --shell  -s        Generate and optionally execute a shell command (non-interactive).                                                   │
+╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Code Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ --code          Generate code in plaintext (non-interactive).                                                                           │
+╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Other Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ --verbose         -V                                                           Show verbose output (e.g., loaded config).               │
+│ --template                                                                     Show the default config file template and exit.          │
+│ --show-reasoning      --no-show-reasoning                                      Show reasoning content from the LLM. (default: True)     │
+│ --justify         -j                         [default|left|center|right|full]  Specify the justify to use. [default: default]           │
+╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
 ```
 
-| Option       | Short | Description                         |
-|--------------|-------|-------------------------------------|
-| `--chat`     | `-c`  | Start in interactive chat mode      |
-| `--shell`    | `-s`  | Generate and execute shell commands |
-| `--help`     | `-h`  | Show help message and exit          |
-| `--verbose`  | `-V`  | Show detailed debug information     |
-| `--template` |       | Display the config template         |
-
 ### Interactive Mode Features
 
 <table>
@@ -640,6 +676,32 @@ cat demo.py | ai "Explain this code"
 cat error.log | ai "Why am I getting these errors in my Python app?"
 ```
 
+### Role Management
+
+```bash
+# Create a new role, you need to input the role description
+ai --create-role "Philosopher Master"
+
+# List all roles
+ai --list-roles
+
+# Show a role
+ai --show-role "Philosopher Master"
+
+# Delete a role
+ai --delete-role "Philosopher Master"
+```
+
+Once you create a role, you can use it in the `--role` option.
+
+```bash
+# Use a specific role
+ai --role "Philosopher Master" "What is the meaning of life?"
+
+# Use a role in chat
+ai --chat --role "Philosopher Master"
+```
+
 ### History Management
 
 YAICLI maintains a history of your interactions (default: 500 entries) stored in `~/.yaicli_history`. You can:
@@ -674,6 +736,23 @@ Output:
 109M    ./
 ```
 
+### Code Generation
+
+In code mode, select the language for code generation. If none is specified, Python is the default.
+
+The `--code` mode outputs plain text, making it easy to copy, paste, or redirect to a file, especially when using the standard model.
+
+When using a deep reasoning model, the thinking content is displayed with syntax highlighting. To disable this, use the `--no-show-reasoning` option or set `SHOW_REASONING` to `false` in the configuration.
+
+```bash
+$ ai --code 'Write a fib generator'
+def fib_generator():
+    a, b = 0, 1
+    while True:
+        yield a
+        a, b = b, a + b
+```
+
 ### Chat Mode Example
 
 ```bash
@@ -747,6 +826,14 @@ Output:
 ...
 ```
 
+### Code Mode Example
+
+```bash
+$ ai --code "write a fib generator" --model deepseek-r1
+```
+
+![fib code example](artwork/reasoning_code_example.png)
+
 ## 💻 Technical Details
 
 ### Architecture

{yaicli-0.3.0 → yaicli-0.3.2}/README.md

@@ -241,6 +241,9 @@ ai --chat
 # Generate and execute shell commands
 ai --shell "Create a backup of my Documents folder"
 
+# Generate code snippets, default in Python
+ai --code "Write a Python function to sort a list"
+
 # Analyze code from a file
 cat app.py | ai "Explain what this code does"
 
@@ -251,17 +254,50 @@ ai --verbose "Explain quantum computing"
 ### Command Line Reference
 
 ```
-Usage: ai [OPTIONS] [PROMPT]
+ Usage: ai [OPTIONS] [PROMPT]
+
+ YAICLI: Your AI assistant in the command line.
+ Call with a PROMPT to get a direct answer, use --shell to execute as command, or use --chat for an interactive session.
+
+╭─ Arguments ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│   prompt      [PROMPT]  The prompt to send to the LLM. Reads from stdin if available. [default: None]                                   │
+╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ --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.                                                                             │
+╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ LLM Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ --model        -M      TEXT                       Specify the model to use.                                                             │
+│ --temperature  -T      FLOAT RANGE [0.0<=x<=2.0]  Specify the temperature to use. [default: 0.7]                                        │
+│ --top-p        -P      FLOAT RANGE [0.0<=x<=1.0]  Specify the top-p to use. [default: 1.0]                                              │
+│ --max-tokens   -M      INTEGER RANGE [x>=1]       Specify the max tokens to use. [default: 1024]                                        │
+╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Role Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ --role         -r      TEXT  Specify the assistant role to use. [default: DEFAULT]                                                      │
+│ --create-role          TEXT  Create a new role with the specified name.                                                                 │
+│ --delete-role          TEXT  Delete a role with the specified name.                                                                     │
+│ --list-roles                 List all available roles.                                                                                  │
+│ --show-role            TEXT  Show the role with the specified name.                                                                     │
+╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Chat Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ --chat        -c        Start in interactive chat mode.                                                                                 │
+│ --list-chats            List saved chat sessions.                                                                                       │
+╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Shell Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ --shell  -s        Generate and optionally execute a shell command (non-interactive).                                                   │
+╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Code Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ --code          Generate code in plaintext (non-interactive).                                                                           │
+╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Other Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ --verbose         -V                                                           Show verbose output (e.g., loaded config).               │
+│ --template                                                                     Show the default config file template and exit.          │
+│ --show-reasoning      --no-show-reasoning                                      Show reasoning content from the LLM. (default: True)     │
+│ --justify         -j                         [default|left|center|right|full]  Specify the justify to use. [default: default]           │
+╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
 ```
 
-| Option       | Short | Description                         |
-|--------------|-------|-------------------------------------|
-| `--chat`     | `-c`  | Start in interactive chat mode      |
-| `--shell`    | `-s`  | Generate and execute shell commands |
-| `--help`     | `-h`  | Show help message and exit          |
-| `--verbose`  | `-V`  | Show detailed debug information     |
-| `--template` |       | Display the config template         |
-
 ### Interactive Mode Features
 
 <table>
@@ -416,6 +452,32 @@ cat demo.py | ai "Explain this code"
 cat error.log | ai "Why am I getting these errors in my Python app?"
 ```
 
+### Role Management
+
+```bash
+# Create a new role, you need to input the role description
+ai --create-role "Philosopher Master"
+
+# List all roles
+ai --list-roles
+
+# Show a role
+ai --show-role "Philosopher Master"
+
+# Delete a role
+ai --delete-role "Philosopher Master"
+```
+
+Once you create a role, you can use it in the `--role` option.
+
+```bash
+# Use a specific role
+ai --role "Philosopher Master" "What is the meaning of life?"
+
+# Use a role in chat
+ai --chat --role "Philosopher Master"
+```
+
 ### History Management
 
 YAICLI maintains a history of your interactions (default: 500 entries) stored in `~/.yaicli_history`. You can:
@@ -450,6 +512,23 @@ Output:
 109M    ./
 ```
 
+### Code Generation
+
+In code mode, select the language for code generation. If none is specified, Python is the default.
+
+The `--code` mode outputs plain text, making it easy to copy, paste, or redirect to a file, especially when using the standard model.
+
+When using a deep reasoning model, the thinking content is displayed with syntax highlighting. To disable this, use the `--no-show-reasoning` option or set `SHOW_REASONING` to `false` in the configuration.
+
+```bash
+$ ai --code 'Write a fib generator'
+def fib_generator():
+    a, b = 0, 1
+    while True:
+        yield a
+        a, b = b, a + b
+```
+
 ### Chat Mode Example
 
 ```bash
@@ -523,6 +602,14 @@ Output:
 ...
 ```
 
+### Code Mode Example
+
+```bash
+$ ai --code "write a fib generator" --model deepseek-r1
+```
+
+![fib code example](artwork/reasoning_code_example.png)
+
 ## 💻 Technical Details
 
 ### Architecture

{yaicli-0.3.0 → yaicli-0.3.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "yaicli"
-version = "0.3.0"
+version = "0.3.2"
 description = "A simple CLI tool to interact with LLM"
 authors = [{ name = "belingud", email = "im.victor@qq.com" }]
 readme = "README.md"

{yaicli-0.3.0 → yaicli-0.3.2}/yaicli/api.py

@@ -93,7 +93,11 @@ class ApiClient:
 
     def get_headers(self) -> Dict[str, str]:
         """Get the request headers."""
-        return {"Authorization": f"Bearer {self.api_key}", "Content-Type": "application/json"}
+        return {
+            "Authorization": f"Bearer {self.api_key}",
+            "Content-Type": "application/json",
+            "X-Title": "Yaicli",
+        }
 
     def _process_completion_response(self, response_json: Dict[str, Any]) -> Tuple[Optional[str], Optional[str]]:
         """Process the JSON response from a non-streamed completion request."""

{yaicli-0.3.0 → yaicli-0.3.2}/yaicli/cli.py

@@ -344,6 +344,7 @@ class CLI:
     def get_system_prompt(self) -> str:
         """Get the system prompt based on current role and mode"""
         # Use the role manager to get the system prompt
+        self.console.print(f"Using role: {self.role}")
         return self.role_manager.get_system_prompt(self.role)
 
     def _build_messages(self, user_input: str) -> List[dict]:
@@ -499,6 +500,7 @@ class CLI:
         @self.bindings.add(Keys.ControlI)  # TAB
         def _(event: KeyPressEvent) -> None:
             self.current_mode = EXEC_MODE if self.current_mode == CHAT_MODE else CHAT_MODE
+            self.role = DefaultRoleNames.SHELL if self.current_mode == EXEC_MODE else DefaultRoleNames.DEFAULT
 
     def _run_once(self, input: str, shell: bool) -> None:
         """Run a single command (non-interactive)."""

{yaicli-0.3.0 → yaicli-0.3.2}/yaicli/entry.py

@@ -130,7 +130,7 @@ def main(
     code: bool = typer.Option(
         False,
         "--code",
-        help="Generate and optionally execute a code block (non-interactive).",
+        help="Generate code in plaintext (non-interactive).",
         rich_help_panel="Code Options",
     ),
     # ------------------- Chat Options -------------------