An open API service indexing awesome lists of open source software.

https://github.com/ziuus/gemini-cli


https://github.com/ziuus/gemini-cli

Last synced: 7 days ago
JSON representation

Awesome Lists containing this project

README

          

# Gemini Terminal

![License](https://img.shields.io/github/license/ziuus/gemini-cli)
![Version](https://img.shields.io/github/v/release/ziuus/gemini-cli)
![Build Status](https://img.shields.io/github/actions/workflow/status/ziuus/gemini-cli/release.yml)

A modern, AI-powered terminal emulator built with Tauri, React, and TypeScript. It integrates Google's Gemini AI directly into your command line workflow.

## Features

- **Persistent AI Mode**: Chat with Gemini directly in your terminal.
- **Smart Context**: Gemini knows it's running in a terminal and can help with shell commands.
- **One-off AI Commands**: Run quick AI queries without leaving your shell.
- **Modern UI**: Sleek, dark-themed interface with JetBrains Mono font.
- **Cross-Platform**: Runs on Linux and Windows.

## Installation

### Download
Go to the [Releases](https://github.com/ziuus/gemini-cli/releases) page and download the installer for your operating system:
- **Windows**: `.msi` or `.exe`
- **Linux**: `.deb` or `.AppImage`

### Manual Build
1. **Prerequisites**:
- [Rust](https://www.rust-lang.org/tools/install)
- [Node.js](https://nodejs.org/)
- [pnpm](https://pnpm.io/installation)

2. **Clone and Install**:
```bash
git clone https://github.com/ziuus/gemini-cli.git
cd gemini-cli
pnpm install
```

3. **Run in Development Mode**:
```bash
pnpm tauri dev
```

4. **Build for Production**:
```bash
pnpm tauri build
```

## Usage

### Standard Shell
The terminal behaves like a standard shell (e.g., `bash` or `zsh` on Linux, `cmd` or `PowerShell` on Windows). You can run all your usual commands (`ls`, `cd`, `git`, etc.).

### AI Commands
- **One-off Command**:
Type `ai ` to get a quick answer from Gemini.
```bash
➜ ~ ai how do I list all files including hidden ones?
```

- **Persistent AI Mode**:
Type `ai` (without arguments) or press `Ctrl+Space` to enter AI mode.
```bash
➜ ~ ai
✨ AI ➜ write a python script to calculate fibonacci
```
Type `exit` or press `Ctrl+Space` again to return to the shell.

- **Help**:
Type `help` to see a list of available commands and shortcuts.

### Shortcuts
- `Ctrl+Space`: Toggle AI mode.
- `Ctrl+L`: Clear the terminal.
- `Ctrl+C`: Interrupt current command.

## Contributing

We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md) for more details.

## Tech Stack
- **Frontend**: React, TypeScript, xterm.js
- **Backend**: Rust (Tauri)
- **Build Tool**: Vite, pnpm

## License
Distributed under the MIT License. See [LICENSE](LICENSE) for more information.