Metadata-Version: 2.4
Name: haystack-cli
Version: 0.1.0
Summary: The official CLI for Haystack Agentic AI Framework
Keywords: haystack,llm,rag,pipelines,cli
License-Expression: Apache-2.0
Requires-Dist: typer>=0.12
Requires-Dist: rich>=13
Requires-Dist: questionary>=2
Requires-Dist: pyyaml>=6
Requires-Dist: tomlkit>=0.12
Requires-Dist: pydantic>=2
Requires-Dist: haystack-ai>=2.26.1
Requires-Dist: deepdiff>=8.6.2
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# Haystack CLI

A community maintained CLI for the Haystack Agentic AI Framework.

> [!NOTE]
> This is work in progress and can expect few bugs and unexpected behaviour. Feel free to raise issue with repro steps to understand and solve the problem.

## Installation

### From PyPI:
TBD

### From source:
```bash
git clone https://github.com/srini047/haystack-cli.git
cd haystack-cli
uv sync
```

## Why need CLI?
Let me list down as points as to why we need CLIs:
- This blog by [Justin Poehnelt](https://justin.poehnelt.com/posts/rewrite-your-cli-for-ai-agents/), explains the importance of CLI in the era of AI Agents.
- Haystack documentation has become very vast over the time with tons of components and integrations. It is very hard to keep track of all the components and their configurations. A handy tool without the need for a google search is cherry on top.
- Haystack ecosystem is improving significantly and quickly as well. We need to adopt to the latest changes in APIs and components. A CLI tries to keep that layer abstracted and provide a consistent interface to the user.
- `--help` flag is your first best friend more than any AI assistant.
- Since the inception of Haystack we didn't have a CLI and it's better late than never. It's high time to adopt to the CLI ecosystem so that we are not left behind in the race.

## Quick Start
After successful installation, you can run the CLI using the following command to verify successful installation:
```bash
haystack -v
```

## Commands
Refer to the [Commands Reference](CLI.md) for a comprehensive list of all available commands and their options.

This is generated by Typer (can be self generate via command): `typer haystack_cli.main utils docs --output CLI.md --name haystack`

## License
MIT [License](LICENSE)
