haystack/haystack/cli

Haystack CLI

Haystack is an open source NLP framework by deepset to help you build production ready search systems or applications powered by various NLP tasks such as Question Answering. Haystack is designed to help you build systems that work intelligently over large document collections. It achieves this with the concept of Pipelines consisting of various Nodes such as a DocumentStore, a Retriever and a Reader.

This is the repository where we keep the code for the Haystack CLI.

To contribute to the tutorials please check out our Contributing Guidelines

Available CLI commands

haystack prompt fetch

Usage:

haystack prompt fetch [OPTIONS] [PROMPT_NAME]

Download a prompt from the official Haystack PromptHub and save it locally for easier use in environments with no network.

You can specify multiple prompts to fetch at the same time.

PROMPTHUB_CACHE_PATH environment variable can be set to change the default folder in which the prompts will be saved in. You can find the default cache path on your machine by running the following code:

from haystack.nodes.prompt.prompt_template import PROMPTHUB_CACHE_PATH
print(PROMPTHUB_CACHE_PATH)

If you set a custom PROMPTHUB_CACHE_PATH environment variable, remember to set it to the same value in your console before running Haystack.

Example:

haystack prompt fetch deepset/conversational-agent-with-tools deepset/summarization

Options:

--help Show options and exit.

haystack --version

Show your current Haystack version and exit.