https://docs.justcat.it/reference/powershell-module/ Recent content in CAT PowerShell module on Hugo -- gohugo.io Wed, 19 Aug 2026 10:00:00 +0200 https://docs.justcat.it/reference/powershell-module/introduction/ Fri, 17 Mar 2023 15:56:11 +0100 https://docs.justcat.it/reference/powershell-module/introduction/ The CAT PowerShell module is the PowerShell face of CAT: 19 cmdlets that open a project file (.cat.yaml), run its tests, hand the results back as objects, and manage the installation. It works with the same project file and runs tests with the same engine as CAT Studio, CAT CLI and the Python module — which tool you use is a matter of environment and taste, not of capability. It requires PowerShell 7. https://docs.justcat.it/reference/powershell-module/installation/ Fri, 17 Mar 2023 15:56:11 +0100 https://docs.justcat.it/reference/powershell-module/installation/ The module is installed with Install-Module, upgraded with Update-Module and removed with Uninstall-Module. No administrator permissions are needed when installing into CurrentUser scope. Prerequisites # PowerShell 7 # The module declares PowerShellVersion = '7.4' and CompatiblePSEditions = 'Core'. Windows PowerShell 5 is not supported: Install-Module CAT completes there without an error, but the module does not work. Version of CAT Required version of PowerShell 0.* 7.2 1.* 7.4 2.* 7.4 PowerShell 7 releases with long-term support come out every second year and are supported for three years, so a PowerShell upgrade is needed at least once in three years. https://docs.justcat.it/reference/powershell-module/close-catproject/ Fri, 17 Mar 2023 15:56:11 +0100 https://docs.justcat.it/reference/powershell-module/close-catproject/ Synopsis # Close-CatProject Parameters # None (common parameters only). What it does # Removes the open project from the module state and disposes the session behind it, releasing the connections it held. Nothing has to be closed before another Open-CatProject — opening replaces the previous project by itself — and ending the PowerShell session releases everything as well; Close-CatProject is for scripts that want to release data-source connections explicitly, or to make sure a later Get-Cat* cannot accidentally read a stale project. https://docs.justcat.it/reference/powershell-module/get-catdatasource/ Fri, 17 Mar 2023 15:56:11 +0100 https://docs.justcat.it/reference/powershell-module/get-catdatasource/ Synopsis # Get-CatDataSource Parameters # None (common parameters only). What it does # Reads the data sources CAT loaded when the project was opened — from the project file and from every data-source list the project points to — and writes them to the pipeline. Nothing is connected; this is what the project defines. Output # One List<DataSourceDefinition> object (assign it, or wrap the call in parentheses, to work with the items — see Introduction). https://docs.justcat.it/reference/powershell-module/get-catdatasourcelist/ Fri, 17 Mar 2023 15:56:11 +0100 https://docs.justcat.it/reference/powershell-module/get-catdatasourcelist/ Synopsis # Get-CatDataSourceList Parameters # None (common parameters only). What it does # Intended to write the project’s data-source lists — the places the project loads data-source definitions from (the project file itself, a YAML file, a database table, …). In the current version the cmdlet returns the project’s test lists, the same objects as Get-CatTestList — a defect in the module, not in your project. Until it is fixed, read the data-source lists from the project object: (Get-CatProject). https://docs.justcat.it/reference/powershell-module/get-catinstance/ Fri, 17 Mar 2023 15:56:11 +0100 https://docs.justcat.it/reference/powershell-module/get-catinstance/ Synopsis # Get-CatInstance [[-LoggingLevel] <string>] [[-LoggingPath] <string>] Parameters # Parameter Type Position Default Meaning -LoggingLevel string 1 None None · Fatal · Error · Warning · Information · Debug · Verbose. -LoggingPath string 2 Documents\CAT\Logs\cat-log.log Log file, when logging is on. What it does # Reads %APPDATA%\CAT\.catconfig (~/.config/CAT/.catconfig on Linux) and the runtime, and writes one object describing the installation. It does not sign in and does not need a token or a key — it is the one cmdlet that always works, which makes it the first thing to run when something else does not. https://docs.justcat.it/reference/powershell-module/get-catproject/ Fri, 17 Mar 2023 15:56:11 +0100 https://docs.justcat.it/reference/powershell-module/get-catproject/ Synopsis # Get-CatProject Parameters # None (common parameters only). What it does # Writes the project CAT built when it was opened — everything the project file and its lists resolved to. The Get-Cat* cmdlets are shortcuts to single properties of this object; use it when you need several of them, or the ones that have no cmdlet (DataSourceLists, Queries, QueryLists, TestTemplates, Outputs, Threads). Output # One Project object: DataSources, DataSourceLists, Tests, TestLists, Queries, QueryLists, TestTemplates, Outputs, Threads, ThreadsRaw, ProjectPathInfo (ResolvedPath, ResolvedDirectory, FileNameWithoutExtension, ProvidedPath), TestGeneratorResults, ProjectDataSet. https://docs.justcat.it/reference/powershell-module/get-catprojecttemplate/ Fri, 17 Mar 2023 15:56:11 +0100 https://docs.justcat.it/reference/powershell-module/get-catprojecttemplate/ Synopsis # Get-CatProjectTemplate [-Online] [-LoggingLevel <string>] Parameters # Parameter Type Position Default Meaning -Online switch named off List the templates on the CAT server instead of the local ones. -LoggingLevel string named Error Used only when this cmdlet has to create the session. What it does # Without -Online, returns the templates available locally — the two shipped with CAT (default, getStartedWindows) and any downloaded earlier. With -Online, asks the CAT server for its list, which may hold more templates and newer versions; nothing is downloaded by listing. https://docs.justcat.it/reference/powershell-module/get-catsession/ Fri, 17 Mar 2023 15:56:11 +0100 https://docs.justcat.it/reference/powershell-module/get-catsession/ Synopsis # Get-CatSession Parameters # None (common parameters only). What it does # Writes the session object the module created with the last Open-CatProject / Invoke-CatProject (or New-CatProject / Get-CatProjectTemplate). It answers the questions Get-CatInstance cannot: as whom am I signed in, which plan applies, what does it limit, is the authorisation from the cache? Output # One CatSession object; the useful properties: Property Meaning SignedInUser Email, UserName, Plan, FromCache (working offline), ExpiresAt (end of the offline grace), AuthMethod; empty when a license key unlocked the plan. https://docs.justcat.it/reference/powershell-module/get-cattest/ Fri, 17 Mar 2023 15:56:11 +0100 https://docs.justcat.it/reference/powershell-module/get-cattest/ Synopsis # Get-CatTest Parameters # None (common parameters only). What it does # Writes the tests CAT loaded when the project was opened: the ones written in the project file, the ones loaded from every test list, and the ones generated from metadata — in the order CAT loaded them. It is the way to see what a run would execute, and to pick test IDs for Invoke-CatTest -TestID. Output # One List<TestDefinition> object (assign it, or wrap the call in parentheses, to work with the items).