https://docs.justcat.it/reference/cat-cli/ Recent content in CAT CLI on Hugo -- gohugo.io Wed, 19 Aug 2026 10:00:00 +0200 https://docs.justcat.it/reference/cat-cli/introduction/ Wed, 25 Oct 2023 14:40:56 +0100 https://docs.justcat.it/reference/cat-cli/introduction/ CAT CLI is the command-line tool of CAT: a single self-contained catcli.exe with no dependency on PowerShell or on a separately installed .NET runtime. It works with the same project file (.cat.yaml) and runs tests with the same engine as CAT Studio, the PowerShell module and the Python module — which tool you use is a matter of environment and taste, not of capability. It runs on Windows only. For a hands-on first contact, follow the Get started with CAT CLI tutorial; this section is the reference. https://docs.justcat.it/reference/cat-cli/installation/ Wed, 19 Aug 2026 10:00:00 +0200 https://docs.justcat.it/reference/cat-cli/installation/ CAT CLI has no dependency on PowerShell and no dependency on a separately installed .NET runtime. That makes it the tool to reach for on machines where PowerShell 7 cannot be installed, or where a runtime cannot be managed. Where to get it # There are two equal routes; pick the one that fits the machine. Download the installer from the Releases page of this site. The page always carries the latest cat-cli-<version>-setup. https://docs.justcat.it/reference/cat-cli/run/ Fri, 27 Oct 2023 09:40:56 +0100 https://docs.justcat.it/reference/cat-cli/run/ Synopsis # catcli run [-p <path>] [-f <text>] [-i <tags>] [-e <tags>] [-n] [-g] [-l <level>] [-q] Options # Short Long Value Meaning -p --project path Project file, or a directory with exactly one *.cat.yaml. Default: the current directory. -f --filter text Run only tests whose full name contains the text. Substring match, not case-sensitive, no wildcards. -i --includeTags tags Run only tests that carry at least one of the tags. https://docs.justcat.it/reference/cat-cli/show/ Fri, 27 Oct 2023 09:40:56 +0100 https://docs.justcat.it/reference/cat-cli/show/ Synopsis # catcli show --summary [-p <path>] [-g] [-l <level>] [-q] catcli show --tests [-f <text>] [-p <path>] [-g] [-l <level>] [-q] Options # Short Long Value Meaning -s --summary Print the project summary. Exactly one of -s / -t is required. -t --tests Print the list of tests. -f --filter text With -t only: list only tests whose full name contains the text. Substring match, not case-sensitive, no wildcards (* alone means all). https://docs.justcat.it/reference/cat-cli/open/ Fri, 27 Oct 2023 09:40:56 +0100 https://docs.justcat.it/reference/cat-cli/open/ Synopsis # catcli open [-p <path>] [-g] [-q] Options # Short Long Value Meaning -p --project path Project file, or a directory with exactly one *.cat.yaml. Default: the current directory. -g --progress Accepted for uniformity with run and show; open always shows progress bars while the project loads. -q --quiet Hide the “working offline” notice. open has no --loggingLevel; the session runs without logging. What it does # Opens the project, then prompts for a command and keeps prompting until exit: https://docs.justcat.it/reference/cat-cli/exec/ Fri, 27 Oct 2023 09:40:56 +0100 https://docs.justcat.it/reference/cat-cli/exec/ Synopsis # catcli exec --dataSource <name> --command <text> [-p <path>] [-l <level>] [-q] Options # Short Long Value Meaning -d --dataSource name Required. Name of a data source defined in the project. -c --command text Required. The command to run — SQL, DAX or whatever the data source’s provider understands. Quote it. -p --project path Project file, or a directory with exactly one *.cat.yaml. Default: the current directory. -l --loggingLevel level None (default), Error, Information, Debug, … — see Logging. https://docs.justcat.it/reference/cat-cli/new/ Thu, 18 Jul 2024 09:40:56 +0100 https://docs.justcat.it/reference/cat-cli/new/ Synopsis # catcli new --list [-o] [-l <level>] [-q] catcli new [-t <code>] [-n <name>] [-d <directory>] [-c] [-w] [-f] [-o] [-l <level>] [-q] Options # Short Long Value Meaning --list List the templates and stop. No short form (-l is --loggingLevel). Combines only with -o, -l, -q. -t --template code Template to create the project from. Default: default. -n --name name Name of the project; becomes the project file name (. https://docs.justcat.it/reference/cat-cli/instance/ Fri, 27 Oct 2023 09:40:56 +0100 https://docs.justcat.it/reference/cat-cli/instance/ Synopsis # catcli instance --show [-l <level>] catcli instance --setLicenseKey <key> [-l <level>] catcli instance --setLicenseKey "" [-l <level>] Options # Short Long Value Meaning -s --show Print the instance table. Exactly one of -s / -k is required. -k --setLicenseKey key Store the license key. An empty value (-k "") removes the stored key. -l --loggingLevel level None (default), Error, Information, Debug, … — see Logging. -q --quiet Accepted for uniformity with the other verbs; instance never signs in, so there is nothing to silence. https://docs.justcat.it/reference/cat-cli/docs/ Fri, 27 Oct 2023 09:40:56 +0100 https://docs.justcat.it/reference/cat-cli/docs/ Synopsis # catcli docs Options # None. What it does # Asks the operating system to open https://docs.justcat.it with whatever handles https links — normally the default browser. It does not sign in, does not touch a project and sends nothing to CAT Portal. Output # Going to open CAT documentation in the default browser. https://docs.justcat.it Exit code # 0. (1 if the operating system cannot open the address.) Examples # catcli docs Related # Introduction — the other verbs and catcli help.