Dwarp

Terminal assistant 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)

Installation

Option 1: Binary Release (Recommended)

1. Download the latest release from Releases

2. Extract and install:

   tar -xzf dwarp-linux.tar.gz
   cd dwarp-linux
   sudo ./install.sh

3. Launch the terminal:

   dwarp

4. Enter your Gemini API key when prompted

Option 2: From Source

1. Clone the repository:

   git clone https://github.com/Abhinavexists/dwarp.git
   cd dwarp

2. Create and activate virtual environment:

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

3. Install dependencies:

   pip install -r requirements.txt

4. Set up your API key:

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

5. Run the application:

   python -m terminal.cli

Usage Examples

# 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 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 file for details.