id          = "weaviate-cli"
name        = "Weaviate CLI"
homepage    = "https://github.com/weaviate/weaviate-cli"
description = "A powerful command-line interface for managing and interacting with Weaviate vector databases directly from your terminal."
executables      = ["weaviate-cli"]

[dotfiles]

# The upstream README says the default file is ~/.config/weaviate/config.json
# and shows auth.api_key, per-user API keys, and provider API keys in headers.
# Since credentials can occupy this same file and the documented format has
# several credential shapes, classify the whole file as a secret.
# https://github.com/weaviate/weaviate-cli/blob/main/README.md#configuration
paths  = []
secret = ["~/.config/weaviate/config.json"]

[commands]
format = 1
label = "Weaviate CLI"
description = "Create a collection or query data with weaviate-cli. Only the options shown in the project README are covered."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = false, short_attached = false, short_bundles = false }

[[commands.source]]
id = "readme"
kind = "help"
url = "https://github.com/weaviate/weaviate-cli/blob/main/README.md"
revision = "2026-10-27"
evidence = """
weaviate-cli create collection --collection movies --vectorizer transformers
weaviate-cli query data --collection movies --search-type hybrid --query "action movies"
weaviate-cli --config-file /path/to/your/config.json
weaviate-cli --user user1 create collection --collection movies --vectorizer transformers
"""

[[commands.field]]
id = "config_file"
label = "Config file"
type = "path"
path = { kind = "file", role = "input" }
option = ["--config-file"]
sources = ["readme"]

[[commands.field]]
id = "user"
label = "User"
description = "User name defined in the config file."
type = "string"
option = ["--user"]
sources = ["readme"]

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["config_file", "user"]

[[commands.subcommand]]
path = ["create", "collection"]
label = "Create a collection"

[[commands.subcommand.source]]
id = "readme"
kind = "help"
url = "https://github.com/weaviate/weaviate-cli/blob/main/README.md"
revision = "2026-10-27"
evidence = """
weaviate-cli create collection --collection movies --vectorizer transformers
"""

[[commands.subcommand.field]]
id = "collection"
label = "Collection name"
type = "string"
option = ["--collection"]
sources = ["readme"]

[[commands.subcommand.field]]
id = "vectorizer"
label = "Vectorizer"
type = "string"
option = ["--vectorizer"]
suggestions = [{ value = "transformers", label = "transformers" }]
sources = ["readme"]

[[commands.subcommand.task]]
id = "create"
label = "Create collection"
fields = ["collection", "vectorizer"]
required = ["collection"]

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["collection", "vectorizer"]

[[commands.subcommand]]
path = ["query", "data"]
label = "Query data"

[[commands.subcommand.source]]
id = "readme"
kind = "help"
url = "https://github.com/weaviate/weaviate-cli/blob/main/README.md"
revision = "2026-10-27"
evidence = """
weaviate-cli query data --collection movies --search-type hybrid --query "action movies"
"""

[[commands.subcommand.field]]
id = "collection"
label = "Collection name"
type = "string"
option = ["--collection"]
sources = ["readme"]

[[commands.subcommand.field]]
id = "search_type"
label = "Search type"
type = "string"
option = ["--search-type"]
suggestions = [{ value = "hybrid", label = "hybrid" }]
sources = ["readme"]

[[commands.subcommand.field]]
id = "query"
label = "Query"
type = "string"
option = ["--query"]
sources = ["readme"]

[[commands.subcommand.task]]
id = "search"
label = "Search a collection"
fields = ["collection", "search_type", "query"]
required = ["collection", "query"]

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["collection", "search_type", "query"]