Metadata-Version: 2.3
Name: shellix
Version: 0.3.0
Summary: Terminal AI assistant for development
License: MIT
Author: Aydar Akhmetzyanov
Author-email: aydar.tech@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: langchain-community (>=0.3.19,<0.4.0)
Requires-Dist: langchain-experimental (>=0.3.4,<0.4.0)
Requires-Dist: langchain-openai (>=0.3.7,<0.4.0)
Requires-Dist: langgraph (>=0.3.5,<0.4.0)
Requires-Dist: tavily-python (>=0.5.1,<0.6.0)
Description-Content-Type: text/markdown

# Shellix AI

Shellix is an open-source terminal AI assistant designed to revolutionize your development workflow by providing intelligent, context-aware assistance. With direct access to your project files and system, Shellix can automate complex tasks, modify code, and streamline your development process.

## Features

- **Development Assistance:** AI-driven insights and automation for coding, debugging, and project management.
- **Web Search and Deep Research:** Perform comprehensive web searches and gather detailed insights directly from the terminal.
- **Conversation History Support:** Maintain context with conversation history, allowing for seamless interactions and follow-ups.
- **Project Status and Files Awareness:** Access and modify project files with AI assistance, ensuring up-to-date project status awareness.
- **Simple Terminal Usage:** Execute complex commands and automate tasks with simple terminal inputs.

## Installation

Python installation is pre-requisite for Shellix.
To install run from the system or project terminal:

```bash
pip install shellix
```

## Usage Examples

1. **Automated Project Setup**
   ```bash
   poetry run sx "Initialize a new Git repository, create a Python virtual environment, and install Flask"
   ```
   Streamline your project initialization with automated setup commands.

2. **End-to-End Web App Development**
   ```bash
   poetry run sx "Create a full-stack React application with a Node.js backend"
   ```
   This command will automate the creation of a React frontend, a Node.js backend, providing a seamless development experience.

3. **AI-Powered Code Modification**
   ```bash
   poetry run sx "Refactor the existing codebase to improve performance and readability"
   ```
   Leverage AI to analyze and refactor your code, enhancing performance and maintainability.

4. **Advanced Web Research**
   ```bash
   poetry run sx "Conduct a detailed search on the latest advancements in AI and summarize the top three articles. Create CSV file with the list of summaries."
   ```
   Save time on research with AI-driven web searches and summaries.

## Development snippets

To run Shellix in dev mode, use:

```bash
poetry install
poetry run sx ...
```

## Building, updating and publishing the Project

Use:

```bash
poetry update
poetry build
poetry publish
```

For more details, please see [CONTRIBUTING.md](CONTRIBUTING.md).

## License

Shellix is licensed under the GNU General Public License v3. See the [LICENSE](LICENSE) file for more details.

