id = "cql"
name = "CovenantSQL"
homepage = "https://developers.covenantsql.io/docs/en/cql_intro"
description = "A command line toolset for terminal users to access and manage user accounts, wallet balances, and databases."
executables = ["cql"]

[dotfiles]

# https://developers.covenantsql.io/docs/en/cql_intro documents the default
# ~/.cql/config.yaml and says private.key is normally kept beside it. The
# config selects the network; private.key is the user's encrypted key pair.
paths = ["~/.cql/config.yaml"]
exclude = []
secret = ["~/.cql/private.key"]

[commands]
format = 1
label = "CovenantSQL client"
description = "Open an interactive SQL console on a CovenantSQL database or check a wallet balance. Account, database creation and other subcommands are not covered."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = false, short_attached = false, short_bundles = false }

[[commands.subcommand]]
path = ["console"]
label = "SQL console"

[[commands.subcommand.source]]
id = "docs"
kind = "manual"
url = "https://developers.covenantsql.io/docs/en/cql_intro"
revision = "0.8.0"
evidence = """
-config string
      Config file for covenantsql (Usually no need to set, default is enough.) (default "~/.cql/config.yaml")
$ cql console -dsn covenantsql://address
"""

[[commands.subcommand.field]]
id = "dsn"
label = "Database DSN"
description = "covenantsql://<database id>"
type = "string"
option = ["-dsn"]
sources = ["docs"]

[[commands.subcommand.field]]
id = "config"
label = "Config file"
description = "Defaults to ~/.cql/config.yaml."
type = "path"
option = ["-config"]
path = { kind = "file", role = "input", must_exist = true }
sources = ["docs"]

[[commands.subcommand.task]]
id = "console"
label = "Open console"
fields = ["dsn", "config"]
required = ["dsn"]

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["dsn", "config"]