config

Command: config

Description: This command is used to query and change the configuration of TcPkg CLI.

Use: tcpkg config [subcommand] [options]

Subcommands:

Subcommand: list

Description: Use this command to query all configurations.

Use: tcpkg config list

Subcommand: set

Description: Use this command to set a configuration option.

Use: tcpkg config set -n [options]

Options:

useVS2017|useVS2019|useVS2022|useTcXaeShell|useTcXaeShell64

This option configures the integration into the TcXaeShell, TcXaeShell64 or a Visual Studio version. In an existing installation, if you change the Visual Studio integration, you must also install the corresponding packages using: tcpkg install <vs2017.ext|vs2019.ext|vs2022.ext|tcxaeshell.ext|tcxaeshell64.ext>

verifySignatures

This option configures Beckhoff package signatures to be checked. (Default: enabled)

tcPkgVersionOutput

This option configures the TcPkg version to be displayed at the beginning of the output when a command is executed. (Default: enabled)

logLevel -v <verbose|information>

This option configures the level at which TcPkg enters log entries in the corresponding file. (Default: information)

xarMode -v <UM|KM|KMWithUM>

This option configures the runtime mode. (Default: KM)

Samples:

Setting the Visual Studio integration and subsequent installation of the integration:

tcpkg config set -n useVS2022

tcpkg install vs2022.ext

Changing the logging data:

tcpkg config set -n logLevel -v verbose

Changing the runtime mode:

tcpkg config set -n xarMode -v KM

Subcommand: unset

Description: Use this command to reset a configuration option.

Use: tcpkg config unset -n [options]

Options:

useVS2017|useVS2019|useVS2022|useTcXaeShell|useTcXaeShell64

This option removes the configuration for TwinCAT integration in the TcXaeShell, TcXaeShell64 or a Visual Studio version. To remove all integration packages, execute the following command: tcpkg uninstall <vs2017.ext|vs2019.ext|vs2022.ext|tcxaeshell.ext|tcxaeshell64.ext>

verifySignatures

This option configures the package signatures to not be checked.

tcPkgVersionOutput

This option removes the output of the TcPkg version when executing a command.

logLevel <verbose|information>

This option configures the "information" level with which TcPkg enters log entries in the corresponding file.

xarMode <UM|KM|KMWithUM>

This option configures the default runtime mode.

Sample:

Subcommand: set proxy

Description: Use this command to configure the information of a proxy.

Use: tcpkg config set proxy [options]

Options:

-d, --domain <domain>

Specification of the domain of the proxy in the form <protocol header><IP adress>:<port>

-u, --user <user>

Username for logging in to the proxy, you will then be asked for the password.

--bypass-on-local

Option to bypass the proxy for local connections.

Sample:

tcpkg config set proxy -d https://127.0.0.1:80 -u example.user@mail.com