source

Command: source

Description: Use this command to configure and manage the sources (feeds) that you want to use to access packages.

Use: tcpkg source [subcommand] [options]

Subcommands

Subcommand: list

Description: Use this command to query all configured sources (feeds). The name, the URL/path, the priority, the proxy setting and the setting as to whether pre-release versions should be viewed are queried.

Example for the output:

Beckhoff Stable Feed - https://public.tcpkg.beckhoff-cloud.com/api/v1/feeds/stable (Authenticated) | Priority - 1 | Bypass Proxy - False | Include Prereleases - False

Use: tcpkg source list [options]

Options:

--as-json

If this option is used, the output text is returned in JSON format. This implicitly sets the -y option.

Sample:

Listing of all configured feeds:

tcpkg source list

Subcommand: add

Description: Use this command to enter a new source (feed).

Use: tcpkg source add [options]

Options:

-n, --name <name> (REQUIRED)

Use this option to define the name of the feed.

-s, --source <source> (REQUIRED)

Use this option to define the URL or path of the feed.

--enabled <true|false>

Use this option to define whether the feed should be enabled (true) or disabled (false). The default, if this option is not used, is enabled.

-u, --user <user>

Use this option to define the user if the feed requires a login, as is the case with Beckhoff feeds. The password is automatically requested after the command is confirmed. Alternatively, you can set the password using the --password-stdin option.

--priority <priority>

Use this option to define the priority of the feed. The smaller the value, the higher the priority. The priority determines the order in which the feeds are searched. The feed with the highest priority

-p, --pre, --include-prereleases

When using this option, pre-release versions are also listed.

--bypass-proxy

This is a feed in the local network that does not require a request to the proxy

-k, --api -key <api-key> The API key for the server. Can be saved to transmit packages to configured sources.

-y, --bypass, --bypass-confirmation, --no-prompt

Use this option to prevent queries from being made during installation.

Sample:

Adding the Beckhoff Stable Feed:

tcpkg source add -n =”Beckhoff Stable Feed” -s=https://public.tcpkg.beckhoff-cloud.com/api/v1/feeds/stable -u=example.user@mail.com

Subcommand: remove <name>

Description: Use this command to delete a source (feed).

Use: tcpkg source remove <name> [options]

Arguments:

<name>

Use this argument to define the name of the feed to be deleted.

Subcommand: edit <name>

Description: Use this command to change a configured feed.

Use: tcpkg source edit <name> [options]

Arguments:

<name>

Use this argument to define the name of the feed to be changed.

Options:

-n, --new-name <new-name>

Use this option to define a new name for the feed.

-s, --source <source>

Use this option to change the URL or the path of the feed.

--enabled <true|false>

Use this option to define whether the feed should be enabled (true) or disabled (false). The default, if this option is not used, is enabled.

-u, --user <user>

Use this option to change the user if the feed requires a login, as is the case with Beckhoff feeds. The password is automatically requested after the command is confirmed. Alternatively, you can set the password using the --password-stdin option.

--priority <priority>

Use this option to change the priority of the feed. The smaller the value, the higher the priority. The priority determines the order in which the feeds are searched.

-p, --pre, --include-prereleases

When using this option, pre-release versions are also considered.

--bypass-proxy

This option allows a configured proxy to be bypassed for local feed addresses

-k, --api- key <api-key>

The API key for the server can be saved here in order to push packages to the feed.

-y, --bypass, --bypass-confirmation, --no-prompt

Use this option to prevent queries from being made during installation.

Sample:

Disabling the Beckhoff Stable Feed without removing it:

tcpkg source edit „Beckhoff Stable Feed” --enabled false

Subcommand: verify <name>

Description: Use this command to check whether the configured feeds are available.

Use: tcpkg source verify <name> [options]

Arguments:

<name>

Use this argument to define the name of a feed whose availability is to be checked. If no name is specified, all feeds are checked.

Options:

--as-json

If this option is used, the output text is returned in JSON format. This implicitly sets the -y option.