Metadata-Version: 2.3
Name: ssannssarr.zuni
Version: 0.1.0
Summary: A terminal research assistant with web search and cited answers.
Keywords: cli,ai,llm,research,web-search,terminal
Author: ssannssarr
Author-email: ssannssarr <ssantanusarkar8@gmail.com>
License: MIT
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Utilities
Requires-Dist: asyncclick>=8.4.2.1
Requires-Dist: bs4>=0.0.2
Requires-Dist: curl-cffi>=0.16.3
Requires-Dist: httpx>=0.28.1
Requires-Dist: rich>=15.0.0
Requires-Dist: markdownify>=1.0.0
Requires-Python: >=3.11
Project-URL: Homepage, https://ssannssarr.github.io/Zuni/
Project-URL: Repository, https://github.com/ssannssarr/Zuni
Project-URL: Documentation, https://ssannssarr.github.io/Zuni/
Project-URL: Issues, https://github.com/ssannssarr/Zuni/issues
Description-Content-Type: text/markdown

# Zuni

**Zuni** is a terminal research assistant that combines an OpenAI-compatible LLM with web search and source citations.

## Features

- Ask questions from the terminal
- Search the web automatically
- Extract readable page content for the model
- Return answers with source citations
- Use any compatible OpenAI-style API endpoint

## Installation

Requires Python 3.11 or newer.

Using `uv`:

```bash
uv tool install ssannssar.zuni
```

Or install into an environment:

```bash
uv add ssannssar.zuni
```

## Configuration

Set your API key:

```bash
zuni config --api-key YOUR_API_KEY
```

You can also configure the model and API base URL:

```bash
zuni config --model YOUR_MODEL --base-url YOUR_BASE_URL
```

Environment variables are supported too:

```bash
export ZUNI_API_KEY="YOUR_API_KEY"
export ZUNI_BASE_URL="https://your-provider.example/v1"
```

## Usage

Ask a question:

```bash
zuni ask "What is quantum computing?"
```

Skip web search:

```bash
zuni ask --no-search "Explain recursion"
```

Control the number of search results:

```bash
zuni ask -n 3 "Latest developments in Python"
```

See all commands and options:

```bash
zuni --help
zuni ask --help
```

## Documentation

Full documentation is available at:

https://ssannssarr.github.io/Zuni/

## Development

Clone the repository and install the project with its development dependencies:

```bash
git clone https://github.com/ssannssarr/Zuni.git
cd Zuni
uv sync
```

Run the CLI from the project environment:

```bash
uv run zuni --help
```

## License

Zuni is released under the MIT License. See [LICENSE](LICENSE).
