CLI commands

valiqai domains

Your verified domains: list, add (with the TXT record), verify, remove.

valiqai domains

Your verified domains: list, add (with the TXT record), verify, remove

Terminal
valiqai domains [options] [command]

Commands: list, add, verify, remove.

On its own, valiqai domains runs valiqai domains list.

valiqai domains list

Your domains and whether each is verified

Terminal
valiqai domains list [options]
OptionWhat it does
--workspace <name>Workspace to use (default: the one in valiqai.json, or the active one)
--api-url <url>ValiqAI address
--jsonPrint JSON on stdout
Terminal
$ valiqai domains

valiqai domains add

Add a domain to verify and print the TXT record to add

Terminal
valiqai domains add [options] <domain>
ArgumentWhat it is
domainThe domain, like example.com (covers its subdomains)
OptionWhat it does
--label <text>A name for it in ValiqAI
--waitThen check every 30 seconds until it verifies
--timeout <duration>How long --wait waits (default: "10m")
--workspace <name>Workspace to use (default: the one in valiqai.json, or the active one)
--api-url <url>ValiqAI address
--jsonPrint JSON on stdout
Terminal
$ valiqai domains add example.com$ valiqai domains add example.com --wait

valiqai domains verify

Check the TXT record now (at most every 30 seconds)

Terminal
valiqai domains verify [options] <domain>
ArgumentWhat it is
domainThe domain, or its id
OptionWhat it does
--waitKeep checking every 30 seconds until it verifies
--timeout <duration>How long --wait waits (default: "10m")
--workspace <name>Workspace to use (default: the one in valiqai.json, or the active one)
--api-url <url>ValiqAI address
--jsonPrint JSON on stdout
Terminal
$ valiqai domains verify example.com$ valiqai domains verify example.com --wait --timeout 30m

valiqai domains remove

Stop verifying a domain; scans of it are refused after

Terminal
valiqai domains remove|rm [options] <domain>

Also: valiqai domains rm.

ArgumentWhat it is
domainThe domain, or its id
OptionWhat it does
-y, --yesDon't ask first
--workspace <name>Workspace to use (default: the one in valiqai.json, or the active one)
--api-url <url>ValiqAI address
--jsonPrint JSON on stdout
Terminal
$ valiqai domains remove example.com$ valiqai domains rm example.com --yes

Every command also takes the options for every command: --quiet, --debug and --no-color.