npm package: @priyadarsimishra/iter8-cli
Description: [![Version](https://img.shields.io/npm/v/@priyadarsimishra/iter8-cli)](https://www.npmjs.com/package/@priyadarsimishra/iter8-cli) [![License](https://img.shields.io/github/license/Iterate-8/iter8-cli)](https://github.com/Iterate-8/iter8-cli/blob/main/LICE
Latest version: 1.1.0

# Iter8 CLI

[![Version](https://img.shields.io/npm/v/@priyadarsimishra/iter8-cli)](https://www.npmjs.com/package/@priyadarsimishra/iter8-cli)
[![License](https://img.shields.io/github/license/Iterate-8/iter8-cli)](https://github.com/Iterate-8/iter8-cli/blob/main/LICENSE)

![Iter8 CLI Screenshot](./docs/assets/gemini-screenshot.png)

Iter8 CLI is a powerful, modified version of the Gemini CLI that brings enhanced AI capabilities directly into your terminal. Built on top of Google's Gemini CLI, it provides an improved developer experience with additional features and customizations.

## 🚀 Why Iter8 CLI?

- **🎯 Enhanced Features**: Custom modifications and improvements over the original Gemini CLI
- **🧠 Powerful Gemini 2.5 Pro**: Access to 1M token context window
- **🔧 Built-in tools**: Google Search grounding, file operations, shell commands, web fetching
- **🔌 Extensible**: MCP (Model Context Protocol) support for custom integrations
- **💻 Terminal-first**: Designed for developers who live in the command line
- **🛡️ Open source**: Apache 2.0 licensed
- **⚡ Improved UX**: Enhanced user interface and workflow optimizations

## 📦 Installation

### Quick Install

#### Run instantly with npx

```bash
# Using npx (no installation required)
npx @priyadarsimishra/iter8-cli
```

#### Install globally with npm

```bash
npm install -g @priyadarsimishra/iter8-cli
```

#### System Requirements

- Node.js version 20 or higher
- macOS, Linux, or Windows

## 📋 Key Features

With Iter8 CLI you can:

- **Code Understanding & Generation**
  - Query and edit large codebases
  - Generate new apps from PDFs, images, or sketches using multimodal capabilities
  - Debug issues and troubleshoot with natural language
- **Automation & Integration**
  - Automate operational tasks like querying pull requests or handling complex rebases
  - Use MCP servers to connect new capabilities
  - Run non-interactively in scripts for workflow automation
- **Advanced Capabilities**
  - Ground your queries with built-in [Google Search](https://ai.google.dev/gemini-api/docs/grounding) for real-time information
  - Conversation checkpointing to save and resume complex sessions
  - Custom context files (GEMINI.md) to tailor behavior for your projects
- **Enhanced Developer Experience**
  - Improved UI/UX over the original Gemini CLI
  - Custom features and optimizations
  - Better workflow integration

## 🔐 Authentication Options

Choose the authentication method that best fits your needs:

### Option 1: OAuth login (Using your Google Account)

**✨ Best for:** Individual developers as well as anyone who has a Gemini Code Assist License.

**Benefits:**

- **Free tier**: 60 requests/min and 1,000 requests/day
- **Gemini 2.5 Pro** with 1M token context window
- **No API key management** - just sign in with your Google account
- **Automatic updates** to latest models

#### Start Iter8 CLI, then choose OAuth and follow the browser authentication flow when prompted

```bash
iter8
```

#### If you are using a paid Code Assist License from your organization, remember to set the Google Cloud Project

```bash
# Set your Google Cloud Project
export GOOGLE_CLOUD_PROJECT="YOUR_PROJECT_NAME"
iter8
```

### Option 2: Gemini API Key

**✨ Best for:** Developers who need specific model control or paid tier access

**Benefits:**

- **Free tier**: 100 requests/day with Gemini 2.5 Pro
- **Model selection**: Choose specific Gemini models
- **Usage-based billing**: Upgrade for higher limits when needed

```bash
# Get your key from https://aistudio.google.com/apikey
export GEMINI_API_KEY="YOUR_API_KEY"
iter8
```

### Option 3: Vertex AI

**✨ Best for:** Enterprise teams and production workloads

**Benefits:**

- **Enterprise features**: Advanced security and compliance
- **Scalable**: Higher rate limits with billing account
- **Integration**: Works with existing Google Cloud infrastructure

```bash
# Get your key from Google Cloud Console
export GOOGLE_API_KEY="YOUR_API_KEY"
export GOOGLE_GENAI_USE_VERTEXAI=true
iter8
```

## 🚀 Getting Started

### Basic Usage

#### Start in current directory

```bash
iter8
```

#### Include multiple directories

```bash
iter8 --include-directories ../lib,../docs
```

#### Use specific model

```bash
iter8 -m gemini-2.5-flash
```

#### Non-interactive mode for scripts

```bash
iter8 -p "Explain the architecture of this codebase"
```

### Quick Examples

#### Start a new project

```bash
cd new-project/
iter8
> Write me a Discord bot that answers questions using a FAQ.md file I will provide
```

#### Analyze existing code

```bash
git clone https://github.com/your-org/your-project
cd your-project
iter8
> Give me a summary of all of the changes that went in yesterday
```

## 🔧 Custom Features

Iter8 CLI includes several enhancements over the original Gemini CLI:

- **Enhanced User Interface**: Improved visual design and user experience
- **Better Workflow Integration**: Optimized for developer workflows
- **Custom Commands**: Additional commands and shortcuts
- **Performance Improvements**: Faster response times and better resource management
- **Extended Functionality**: Additional features not available in the original

## 📚 Documentation

### Getting Started

- [**Quickstart Guide**](./docs/cli/index.md) - Get up and running quickly
- [**Authentication Setup**](./docs/cli/authentication.md) - Detailed auth configuration
- [**Configuration Guide**](./docs/cli/configuration.md) - Settings and customization
- [**Keyboard Shortcuts**](./docs/keyboard-shortcuts.md) - Productivity tips

### Core Features

- [**Commands Reference**](./docs/cli/commands.md) - All slash commands (`/help`, `/chat`, `/mcp`, etc.)
- [**Checkpointing**](./docs/checkpointing.md) - Save and resume conversations
- [**Memory Management**](./docs/tools/memory.md) - Using GEMINI.md context files
- [**Token Caching**](./docs/cli/token-caching.md) - Optimize token usage

### Tools & Extensions

- [**Built-in Tools Overview**](./docs/tools/index.md)
  - [File System Operations](./docs/tools/file-system.md)
  - [Shell Commands](./docs/tools/shell.md)
  - [Web Fetch & Search](./docs/tools/web-fetch.md)
  - [Multi-file Operations](./docs/tools/multi-file.md)
- [**MCP Server Integration**](./docs/tools/mcp-server.md) - Extend with custom tools
- [**Custom Extensions**](./docs/extension.md) - Build your own commands

### Advanced Topics

- [**Architecture Overview**](./docs/architecture.md) - How Iter8 CLI works
- [**IDE Integration**](./docs/extension.md) - VS Code companion
- [**Sandboxing & Security**](./docs/sandbox.md) - Safe execution environments
- [**Enterprise Deployment**](./docs/deployment.md) - Docker, system-wide config
- [**Telemetry & Monitoring**](./docs/telemetry.md) - Usage tracking
- [**Tools API Development**](./docs/core/tools-api.md) - Create custom tools

### Configuration & Customization

- [**Settings Reference**](./docs/cli/configuration.md) - All configuration options
- [**Theme Customization**](./docs/cli/themes.md) - Visual customization
- [**.gemini Directory**](./docs/gemini-ignore.md) - Project-specific settings
- [**Environment Variables**](./docs/cli/configuration.md#environment-variables)

### Troubleshooting & Support

- [**Troubleshooting Guide**](./docs/troubleshooting.md) - Common issues and solutions
- [**FAQ**](./docs/troubleshooting.md#frequently-asked-questions) - Quick answers
- Use `/bug` command to report issues directly from the CLI

### Using MCP Servers

Configure MCP servers in `~/.gemini/settings.json` to extend Iter8 CLI with custom tools:

```text
> @github List my open pull requests
> @slack Send a summary of today's commits to #dev channel
> @database Run a query to find inactive users
```

See the [MCP Server Integration guide](./docs/tools/mcp-server.md) for setup instructions.

## 🤝 Contributing

We welcome contributions! Iter8 CLI is fully open source (Apache 2.0), and we encourage the community to:

- Report bugs and suggest features
- Improve documentation
- Submit code improvements
- Share your MCP servers and extensions

See our [Contributing Guide](./CONTRIBUTING.md) for development setup, coding standards, and how to submit pull requests.

## 📖 Resources

- **[NPM Package](https://www.npmjs.com/package/@priyadarsimishra/iter8-cli)** - Package registry
- **[GitHub Repository](https://github.com/Iterate-8/iter8-cli)** - Source code and issues
- **[Original Gemini CLI](https://github.com/google-gemini/gemini-cli)** - Base project

### Uninstall

```bash
npm uninstall -g @priyadarsimishra/iter8-cli
```

## 📄 Legal

- **License**: [Apache License 2.0](LICENSE)
- **Terms of Service**: [Terms & Privacy](./docs/tos-privacy.md)
- **Security**: [Security Policy](SECURITY.md)

---

<p align="center">
  Built with ❤️ by the Iter8 team, based on Google's Gemini CLI
</p>