ai-terminal-cli


Nameai-terminal-cli JSON
Version 0.1.2 PyPI version JSON
download
home_pageNone
SummaryTerminal assistant built as an open source minimal alternative to Warp
upload_time2025-08-24 07:05:17
maintainerNone
docs_urlNone
authorNone
requires_python>=3.12
licenseNone
keywords terminal ai shell assistant cli gemini
VCS
bugtrack_url
requirements google-genai prompt-toolkit rich pydantic python-dotenv
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # AI-Terminal

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
[![Platform](https://img.shields.io/badge/platform-linux-lightgrey.svg)](https://github.com/your-username/ai-enabled-terminal)

Terminal assistant which is built as an open source minimal alternative to warp.

## Quick Start

### Prerequisites

- Python 3.12 or higher
- Linux operating system (Ubuntu, Arch, Fedora, CentOS, openSUSE, Debian supported) (Windows and MacOS will be supproted later on)
- Google Gemini API key ([Get one here](https://aistudio.google.com/app/apikey))

### Installation

#### Option 1: Binary Release (Recommended)

1. Download the latest release from [Releases](https://github.com/your-username/ai-enabled-terminal/releases)
2. Extract and install:

   ```bash
   tar -xzf ai-terminal-linux.tar.gz
   cd ai-terminal-linux
   sudo ./install.sh
   ```

3. Launch the terminal:

   ```bash
   ai-terminal
   ```

4. Enter your Gemini API key when prompted

#### Option 2: From Source

1. Clone the repository:

   ```bash
   git clone https://github.com/Abhinavexists/ai-terminal.git
   cd ai-enabled-terminal
   ```

2. Create and activate virtual environment:

   ```bash
   python -m venv .venv
   source .venv/bin/activate  # On Windows: .venv\Scripts\activate
   ```

3. Install dependencies:

   ```bash
   pip install -r requirements.txt
   ```

4. Set up your API key:

   ```bash
   export GEMINI_API_KEY="your-api-key-here"
   ```

5. Run the application:

   ```bash
   python -m terminal.cli
   ```

## Usage Examples

```bash
# Natural language commands
> install docker
Command: sudo pacman -S docker
Explanation: Installs Docker using the system package manager

> find all python files in current directory
Command: find . -name "*.py" -type f
Explanation: Searches for all Python files in the current directory and subdirectories

> compress folder into zip
Command: zip -r archive.zip folder_name
Explanation: Creates a ZIP archive of the specified folder

> show disk usage sorted by size
Command: du -sh * | sort -hr
Explanation: Shows disk usage of all items in current directory, sorted by size
```

## Contributing

We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.

## Pending stuff

- [ ] Support for Windows and macOS
- [ ] Custom command templates and aliases
- [ ] Plugin system for extending functionality
- [ ] Command explanation and learning mode
- [ ] Integration with popular development tools
- [ ] Multi-language support

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ai-terminal-cli",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.12",
    "maintainer_email": null,
    "keywords": "terminal, ai, shell, assistant, cli, gemini",
    "author": null,
    "author_email": "Abhinav <abhinavkumarsingh2023@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/42/35/3ba294c34b7fea28b41306fbcbe8440627e15f38246a8f4dc5a3dd38ae03/ai_terminal_cli-0.1.2.tar.gz",
    "platform": null,
    "description": "# AI-Terminal\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)\n[![Platform](https://img.shields.io/badge/platform-linux-lightgrey.svg)](https://github.com/your-username/ai-enabled-terminal)\n\nTerminal assistant which is built as an open source minimal alternative to warp.\n\n## Quick Start\n\n### Prerequisites\n\n- Python 3.12 or higher\n- Linux operating system (Ubuntu, Arch, Fedora, CentOS, openSUSE, Debian supported) (Windows and MacOS will be supproted later on)\n- Google Gemini API key ([Get one here](https://aistudio.google.com/app/apikey))\n\n### Installation\n\n#### Option 1: Binary Release (Recommended)\n\n1. Download the latest release from [Releases](https://github.com/your-username/ai-enabled-terminal/releases)\n2. Extract and install:\n\n   ```bash\n   tar -xzf ai-terminal-linux.tar.gz\n   cd ai-terminal-linux\n   sudo ./install.sh\n   ```\n\n3. Launch the terminal:\n\n   ```bash\n   ai-terminal\n   ```\n\n4. Enter your Gemini API key when prompted\n\n#### Option 2: From Source\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/Abhinavexists/ai-terminal.git\n   cd ai-enabled-terminal\n   ```\n\n2. Create and activate virtual environment:\n\n   ```bash\n   python -m venv .venv\n   source .venv/bin/activate  # On Windows: .venv\\Scripts\\activate\n   ```\n\n3. Install dependencies:\n\n   ```bash\n   pip install -r requirements.txt\n   ```\n\n4. Set up your API key:\n\n   ```bash\n   export GEMINI_API_KEY=\"your-api-key-here\"\n   ```\n\n5. Run the application:\n\n   ```bash\n   python -m terminal.cli\n   ```\n\n## Usage Examples\n\n```bash\n# Natural language commands\n> install docker\nCommand: sudo pacman -S docker\nExplanation: Installs Docker using the system package manager\n\n> find all python files in current directory\nCommand: find . -name \"*.py\" -type f\nExplanation: Searches for all Python files in the current directory and subdirectories\n\n> compress folder into zip\nCommand: zip -r archive.zip folder_name\nExplanation: Creates a ZIP archive of the specified folder\n\n> show disk usage sorted by size\nCommand: du -sh * | sort -hr\nExplanation: Shows disk usage of all items in current directory, sorted by size\n```\n\n## Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.\n\n## Pending stuff\n\n- [ ] Support for Windows and macOS\n- [ ] Custom command templates and aliases\n- [ ] Plugin system for extending functionality\n- [ ] Command explanation and learning mode\n- [ ] Integration with popular development tools\n- [ ] Multi-language support\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Terminal assistant built as an open source minimal alternative to Warp",
    "version": "0.1.2",
    "project_urls": {
        "Homepage": "https://github.com/Abhinavexists/ai-terminal",
        "Issues": "https://github.com/Abhinavexists/ai-terminal/issues",
        "Repository": "https://github.com/Abhinavexists/ai-terminal.git"
    },
    "split_keywords": [
        "terminal",
        " ai",
        " shell",
        " assistant",
        " cli",
        " gemini"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b1249875ac01a7a92f1169285296e098da7b46ca83b8581bdc19efc8481d3b30",
                "md5": "caab430da1659e83b00273ea5f8565a9",
                "sha256": "e2c3cf02037df4e062bc178603e223158991d52dc87801870aa3049816a48528"
            },
            "downloads": -1,
            "filename": "ai_terminal_cli-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "caab430da1659e83b00273ea5f8565a9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12",
            "size": 12840,
            "upload_time": "2025-08-24T07:05:15",
            "upload_time_iso_8601": "2025-08-24T07:05:15.772832Z",
            "url": "https://files.pythonhosted.org/packages/b1/24/9875ac01a7a92f1169285296e098da7b46ca83b8581bdc19efc8481d3b30/ai_terminal_cli-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "42353ba294c34b7fea28b41306fbcbe8440627e15f38246a8f4dc5a3dd38ae03",
                "md5": "8992e13d79a600be6e42523676730e4a",
                "sha256": "ad614671e029aa4905925bc10f8488ae57030564beecd1be42c89813b0804b2e"
            },
            "downloads": -1,
            "filename": "ai_terminal_cli-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "8992e13d79a600be6e42523676730e4a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12",
            "size": 11280,
            "upload_time": "2025-08-24T07:05:17",
            "upload_time_iso_8601": "2025-08-24T07:05:17.060336Z",
            "url": "https://files.pythonhosted.org/packages/42/35/3ba294c34b7fea28b41306fbcbe8440627e15f38246a8f4dc5a3dd38ae03/ai_terminal_cli-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-24 07:05:17",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Abhinavexists",
    "github_project": "ai-terminal",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "google-genai",
            "specs": [
                [
                    "==",
                    "1.31.0"
                ]
            ]
        },
        {
            "name": "prompt-toolkit",
            "specs": [
                [
                    "==",
                    "3.0.51"
                ]
            ]
        },
        {
            "name": "rich",
            "specs": [
                [
                    "==",
                    "14.1.0"
                ]
            ]
        },
        {
            "name": "pydantic",
            "specs": [
                [
                    "==",
                    "2.11.7"
                ]
            ]
        },
        {
            "name": "python-dotenv",
            "specs": [
                [
                    "==",
                    "1.1.1"
                ]
            ]
        }
    ],
    "lcname": "ai-terminal-cli"
}
        
Elapsed time: 1.46925s