siada-cli 0.0.1__tar.gz

siada_cli-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 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 (c) 2025 Li Auto Inc. and its affiliates
+
+   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.

siada_cli-0.0.1/PKG-INFO

@@ -0,0 +1,457 @@
+Metadata-Version: 2.3
+Name: siada-cli
+Version: 0.0.1
+Summary: Siada CLI is a Ai Pair Programming Tool in terminal
+License: Apache-2.0
+Requires-Python: >=3.12,<4.0
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development
+Requires-Dist: binaryornot (==0.4.4)
+Requires-Dist: click (>=8.2.1,<9.0.0)
+Requires-Dist: configargparse (>=1.7,<2.0.0)
+Requires-Dist: diskcache (==5.6.3)
+Requires-Dist: fastapi (>=0.110.0,<1.0.0)
+Requires-Dist: grep-ast (>=0.9.0,<1.0.0)
+Requires-Dist: litellm (>=1.72.6,<2.0.0)
+Requires-Dist: openai (>=1.99.9,<2.0.0)
+Requires-Dist: openai-agents (==0.2.5)
+Requires-Dist: openhands-aci (==0.3.0)
+Requires-Dist: partial-json-parser (>=0.2.1.1.post6,<1.0.0)
+Requires-Dist: patch-ng (>=1.18.1,<2.0.0)
+Requires-Dist: pexpect (>=4.9.0,<5.0.0)
+Requires-Dist: prompt-toolkit (>=3.0.51,<4.0.0)
+Requires-Dist: psutil (>=7.0.0,<8.0.0)
+Requires-Dist: pydantic (>=2.6.0,<3.0.0)
+Requires-Dist: pydantic-settings (>=2.2.0,<3.0.0)
+Requires-Dist: pygments (>=2.19.1,<3.0.0)
+Requires-Dist: rich (>=13.0.0,<14.0.0)
+Requires-Dist: shtab (>=1.7,<2.0.0)
+Requires-Dist: termcolor (>=3.1.0,<4.0.0)
+Requires-Dist: tqdm (>=4.67.1,<5.0.0)
+Requires-Dist: trafilatura (>=2.0.0,<3.0.0)
+Requires-Dist: uvicorn (>=0.27.0,<1.0.0)
+Project-URL: Homepage, https://github.com/liauto-siada/siada-cli
+Description-Content-Type: text/markdown
+
+# Siada CLI
+
+**[简体中文](./docs/zh-CN/README_zh.md) | English**
+
+![Siada CLI Screenshot](./docs/assets/siada-cli-screenshot.png)
+
+This repository contains Siada CLI, a command-line AI workflow tool that provides specialized intelligent agents for code development, debugging, and automation tasks.
+
+With Siada CLI you can:
+
+- Fix bugs in large codebases through intelligent analysis and automated solutions.
+- Generate new applications and components using specialized frontend and backend agents.
+- Automate development workflows through intelligent code generation and testing.
+- Execute system commands and interact with development environments.
+- Seamlessly support multiple programming languages and frameworks.
+
+## Installation/Update
+
+1. System Requirements
+- MAC, Linux
+- GCC 11+
+
+2. Installation Command
+   TODO
+   
+
+## Installation (Developer Mode)
+
+1. **Prerequisites:** Ensure you have [Python 3.12](https://www.python.org/downloads/) or higher and [Poetry](https://python-poetry.org/docs/#installation) installed.
+
+2. **Clone and Install:**
+   ```bash
+   git clone https://github.com/your-org/siada-agenthub.git
+   cd siada-agenthub
+   poetry install
+   ```
+
+3. **Run CLI:**
+   ```bash
+   # Method 1: Run with Poetry
+   poetry run siada-cli
+   
+   # Method 2: Activate virtual environment then use (recommended)
+   source $(poetry env info --path)/bin/activate
+   siada-cli
+   ```
+
+## Configuration
+
+### Model Configuration
+
+**Method 1: Default Configuration**
+   - The system reads default configuration from `agent_config.yaml` file
+   - Current defaults: model `claude-sonnet-4`, provider `openrouter`
+
+   **Method 2: Customize via Configuration File**
+   - Regular Users
+      - Edit configuration file `~/.siada-cli/conf.yaml`
+         ```bash
+         # 1. Create configuration file in user home directory
+         cd ~
+         mkdir -p ~/.siada-cli
+         touch ~/.siada-cli/conf.yaml
+
+         # 2. Configuration file content example
+         llm_config:
+            model: "claude-sonnet-4"          # Change to your desired model
+            provider: "openrouter"
+         ```
+      - Required when using OpenRouter provider
+        ```bash
+           export OPENROUTER_API_KEY="your_openrouter_key"
+        ```
+   - Developer Mode
+      - Edit the `llm_config` section in `agent_config.yaml` file:
+         ```yaml
+         llm_config:
+            provider: "openrouter"
+            model_name: "claude-sonnet-4"     # Change to your desired model
+         ```
+
+   **Method 3: Via Environment Variables**
+   ```bash
+   # Set model
+   export SIADA_MODEL="claude-sonnet-4"
+   
+   # Set provider
+   export SIADA_PROVIDER="openrouter"
+
+   # Required when using OpenRouter provider
+   export OPENROUTER_API_KEY="your_openrouter_key"
+   ```
+
+   **Method 4: Via Command Line Parameters (Highest Priority)**
+   ```bash
+   # Only change model (keep provider unchanged)
+   siada-cli --model claude-sonnet-4
+   
+   # Change both model and provider
+   siada-cli --model gpt-4.1 --provider openrouter
+   
+   # Only change provider (keep model unchanged)
+   siada-cli --provider openrouter
+   ```
+
+   > **Important Notes:**
+   > - **Complete Priority**: `Command line parameters` > `Environment variables (SIADA_ prefix)` > `Configuration file (agent_config.yaml)`
+   > - **Provider Requirements**: When using `openrouter`, must set `OPENROUTER_API_KEY` environment variable
+
+### Agent Configuration (Developer Mode)
+
+Edit `agent_config.yaml` to customize agent behavior:
+
+```yaml
+agents:
+  bugfix:
+    class: "siada.agent_hub.coder.bug_fix_agent.BugFixAgent"
+    description: "Specialized agent for code bug fixing"
+    enabled: true
+
+llm_config:
+  provider: "openrouter"
+  model_name: "claude-sonnet-4"
+  repo_map_tokens: 8192
+  repo_map_mul_no_files: 16
+  repo_verbose: true
+```
+
+### Environment Variables
+
+Set environment variables to configure behavior:
+
+```bash
+# Siada-specific settings (use SIADA_ prefix)
+export SIADA_AGENT="bugfix"
+export SIADA_MODEL="claude-sonnet-4"
+export SIADA_THEME="dark"
+
+# Required when using OpenRouter provider
+export OPENROUTER_API_KEY="your_openrouter_key"
+
+# Unset environment variables in current terminal session
+unset SIADA_MODEL
+```
+
+## Usage Modes
+
+Siada CLI supports two usage modes to meet different usage scenarios:
+
+### Non-Interactive Mode
+
+**Features:**
+- One-time execution: Execute a single task and automatically exit
+- Stateless: Does not retain session context
+- Use cases: Automation scripts, CI/CD pipelines, single task execution
+
+**Usage:**
+```bash
+# Use --prompt parameter to trigger non-interactive mode
+siada-cli --agent bugfix --prompt "Fix login errors in auth.py"
+
+# Combine with other parameters
+siada-cli --agent coder --model claude-sonnet-4 --prompt "Create a REST API endpoint"
+```
+
+### Interactive Mode
+
+**Features:**
+- Continuous conversation: Maintains session state after startup, allows continuous dialogue
+- Context memory: AI remembers previous conversation content
+- Real-time interaction: Supports slash commands, editor mode, and other advanced features
+- Use cases: Exploratory programming, complex tasks, development work requiring multiple rounds of dialogue
+
+**Usage:**
+```bash
+# Start directly (defaults to interactive mode)
+siada-cli --agent coder
+```
+
+**Interactive Process:**
+```
+> Create a user management API
+[AI response...]
+> Add data validation to this API
+[AI response...]
+> Write some unit tests
+[AI response...]
+```
+
+## Command Line Options
+
+```bash
+# Use a specific agent
+siada-cli --agent coder
+# Supports abbreviations
+siada-cli -a coder
+
+# Non-interactive mode with a single prompt
+siada-cli --prompt "Fix authentication errors in login.py"
+# Supports abbreviations
+siada-cli -p "Fix authentication errors in login.py"
+
+# Use a different model
+siada-cli --model claude-sonnet-4
+
+# Use OpenRouter provider (requires API key setup)
+siada-cli --provider openrouter
+
+# Set color theme
+siada-cli --theme dark
+
+# Enable verbose output
+siada-cli --verbose
+
+# List all available models
+siada-cli --list-models
+siada-cli --models
+```
+
+## Slash Commands
+
+In the CLI, you can use slash commands for additional functionality:
+
+- `/shell` - Switch to shell mode to execute system commands (type `exit` or `quit` to exit shell mode)
+- `/models` - List available AI models
+- `/run <command>` or `!<command>` - Execute shell commands
+- `/editor` - Open editor for multiline input
+- `/exit` or `/quit` - Exit the application
+
+### Shell Mode Usage Guide
+
+Siada CLI provides two ways to execute system commands:
+
+#### Method 1: Use `/shell` to switch to shell mode
+Switch to persistent shell mode where you can continuously execute multiple system commands:
+
+```bash
+> /shell
+# After entering shell mode, you can execute multiple commands
+ls -la
+cd my-project
+npm install
+git status
+# Use exit or quit to exit shell mode
+exit
+```
+
+#### Method 2: Use `!` prefix to execute commands directly
+Execute single system commands directly in interactive mode without switching modes:
+
+```bash
+> !ls -la
+> !git status
+> !npm run dev
+```
+
+Differences between the two methods:
+- **`/shell`**: Suitable for scenarios requiring continuous execution of multiple system commands, switch once and use persistently
+- **`!<command>`**: Suitable for occasionally executing single system commands, returns to AI conversation mode immediately after execution
+
+## Agent Types
+
+### Bug Fix Agent (`--agent bugfix` / `-a bugfix` / `--bugfix`) 
+> **Only supports non-interactive mode!**
+
+Specialized for identifying, analyzing, and fixing bugs in codebases. Provides detailed analysis and automated fix suggestions.
+
+### Code Generation Agent (`--agent coder` / `-a coder` / `--coder`)
+General-purpose code development agent for creating new features, refactoring code, and implementing functionality in various programming languages.
+
+### Frontend Generation Agent (`--agent fegen` / `-a fegen` / `--fegen`)
+Focused on frontend development tasks, including React components, CSS styling, and user interface implementation.
+
+## Examples
+
+### Activate Virtual Environment (Developer Mode Only)
+First, enter the siada-agenthub project directory and activate the virtual environment:
+
+```bash
+# Enter project directory
+cd ~/path/to/siada-agenthub
+
+# Activate virtual environment (recommended method)
+source $(poetry env info --path)/bin/activate
+
+# Or use Poetry run (no need to activate environment)
+# poetry run siada-cli
+```
+
+### Usage Examples
+
+After activating the environment, you can choose between interactive mode or non-interactive mode to interact with AI agents.
+
+**Interactive Mode:**
+
+```bash
+# Enter project directory
+cd my-project/
+
+# Start interactive mode
+siada-cli --agent coder
+
+# Then you can input prompts in the interactive interface
+> Create a REST API server with user authentication using FastAPI
+# AI will respond and you can continue the conversation...
+> Add logging functionality to this API
+```
+
+**Non-Interactive Mode (One-time execution):**
+
+```bash
+# Execute a single task and exit (uses coder agent by default)
+siada-cli --prompt "Create a user registration API"
+
+# Specify a specific agent to execute tasks
+siada-cli --agent bugfix --prompt "Fix authentication errors in login.py"
+siada-cli --agent fegen --prompt "Create a responsive navigation bar component using React and Tailwind CSS"
+```
+
+**Exit Virtual Environment (Developer Mode Only):**
+
+```bash
+# Exit virtual environment after use
+deactivate
+```
+
+## Common Tasks
+
+### Debug and Fix Code Issues
+
+```text
+> Analyze this error message and suggest a fix: [paste error]
+```
+
+```text
+> Help me reproduce this intermittent bug that occurs during high load
+```
+
+### Code Generation and Development
+
+```text
+> Implement a caching layer for the database queries in this service
+```
+
+```text
+> Refactor this monolithic function into smaller, more maintainable pieces
+```
+
+### Frontend Development
+
+```text
+> Create a responsive dashboard layout with sidebar navigation
+```
+
+```text
+> Add form validation to the user registration form
+```
+
+## Troubleshooting
+
+### Common Issues
+
+**Command not found:**
+If running `siada-cli` directly shows command not found:
+- This is normal behavior in developer mode as the command is installed in the virtual environment
+- Refer to examples to activate the virtual environment
+
+**Model API errors:**
+- Check your internet connection
+- If using OpenRouter provider, ensure API key is set correctly
+- If using OpenRouter provider, verify your account has sufficient credits
+
+**Installation issues:**
+- Ensure you have Python 3.12+ installed
+- Install Poetry using the official installation method
+- Try removing `poetry.lock` and re-running `poetry install`
+
+**Agent not working:**
+- Check if the agent is enabled in `agent_config.yaml`
+- Verify the agent class path is correct
+- Use `--verbose` flag to see detailed output
+
+For more detailed troubleshooting, check logs and use the `--verbose` flag for additional debug information.
+
+## Contributing
+
+We welcome contributions to Siada CLI! Whether you want to fix bugs, add new features, improve documentation, or suggest enhancements, your contributions are greatly appreciated.
+
+To get started with contributing, please read our [Contributing Guide](./docs/CONTRIBUTING.md) which includes:
+
+- Our project vision and development goals
+- Project directory structure and development guidelines
+- Pull request guidelines and best practices
+- Code organization principles
+
+Before submitting any changes, please make sure to check our issue tracker and follow the contribution workflow outlined in the guide.
+
+## Acknowledgements
+
+Siada CLI is built upon the foundation of numerous open source projects, and we extend our deepest respect and gratitude to their contributors.
+
+Special thanks to the [OpenAI Agent SDK](https://github.com/openai/openai-agent-sdk) for providing the foundational framework that powers our intelligent agent capabilities.
+
+For a complete list of open source projects and licenses used in Siada CLI, please see our [CREDITS.md](./docs/CREDITS.md) file.
+
+## License
+
+Distributed under the Apache-2.0 License. See [`LICENSE`](LICENSE) for more information.
+
+## DISCLAIMERS
+See [disclaimers.md](./disclaimers.md)
+
+----
+<div align="center">
+Built with ❤️ by Li Auto Code Intelligence Team and the open source community
+</div>