Skip to main content

The official CLI for Haystack Agentic AI Framework

Project description

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:

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, 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:

haystack -v

Commands

Refer to the Commands Reference 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

haystack_cli-0.1.0.tar.gz (22.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

haystack_cli-0.1.0-py3-none-any.whl (36.5 kB view details)

Uploaded Python 3

File details

Details for the file haystack_cli-0.1.0.tar.gz.

File metadata

  • Download URL: haystack_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 22.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.17

File hashes

Hashes for haystack_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 43944703b9a82804974335ee9b5a2d349ac8c5194e35f8c929aa3ccdfb950a31
MD5 603bbccb58b5c3624b2b55361b802482
BLAKE2b-256 9d3a0a0ca6d1b3449fce65d0e920329396c0415f57e232d430274d70084cfe6c

See more details on using hashes here.

File details

Details for the file haystack_cli-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for haystack_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 47dc570f9a55684db7993e53c5c63d5391015d239edbd9cca8bc4b7bd9b7b531
MD5 bba4389f281a9872a449e26954713da2
BLAKE2b-256 41bae7d5b10a95f3d421493186f2f55263749b2a10f5ef456840bf3ce683509f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page