Metadata-Version: 2.4
Name: zev
Version: 0.3.1
Summary: Lookup CLI commands easily
Project-URL: Repository, https://github.com/dtnewman/zev
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: openai==1.72.0
Requires-Dist: platformdirs==4.3.7
Requires-Dist: pyperclip==1.9.0
Requires-Dist: pydantic==2.10.6
Requires-Dist: python-dotenv==1.0.1
Requires-Dist: questionary===2.1.0
Requires-Dist: rich==13.9.4
Provides-Extra: dev
Requires-Dist: ruff>=0.11.2; extra == "dev"
Dynamic: license-file

# Zev 🔍

[![PyPI version](https://badge.fury.io/py/zev.svg)](https://badge.fury.io/py/zev)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Zev helps you remember (or discover) terminal commands using natural language.

![Description](./.github/demo.gif)

## 🔧 Installation

```bash
pip install zev
```

This project runs on top of the OpenAI API. After your first time running it, you will be prompted to enter an OpenAI key.

## 🎮 Usage

#### Option 1: Interactive Mode

```bash
zev
```

#### Option 2: Direct Query

```bash
zev '<what you want to do>'
```

## 📝 Examples

```bash
# Find running processes
zev 'show all running python processes'

# File operations
zev 'find all .py files modified in the last 24 hours'

# System information
zev 'show disk usage for current directory'

# Network commands
zev 'check if google.com is reachable'

# Git operations
zev 'show uncommitted changes in git'
```

## ⚙️ Settings

You can update your OpenAI API key or other settings by running:

```bash
zev --setup
```

To use the OpenAI key, you must have an OpenAI account and a subscription. You can create an API key on [this page](https://platform.openai.com/settings/organization/api-keys).

## 🐪 Using with Ollama

You can use Zev with [Ollama](https://ollama.ai/) as an alternative to OpenAI, which lets you run all commands locally. To set this up:

1. Install and start [Ollama](https://ollama.com/) with a model of your choice

2. Run `zev --setup` and put in the proper settings. For example:

```
Enter your OpenAI API key:
Enter your OpenAI base URL: http://localhost:11434/v1
Enter your OpenAI model: llama3.2
```

## 🤝 Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.

## 📄 License

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