HCMS CLI for managing output channels | Censhare Documentation

Output channels can also be configured in the Censhare Java Client or Web Client as explained in this article.

View commands

Command	Argument	Meaning
`hcms channel list`	-	Displays all currently enabled channels as a YAML output
`hcms channel inspect`	channel id	Displays information about the specified channel as a YAML output

Sample YAML output (for one channel):

key: root.
name: Output channel
name_de: Ausgabekanal
domain: root.
domain2: root.
sorting: 1
enabled: true

Note Please be aware that you can accidently re-enable a domain by using the update command.

Command	Argument	Meaning
`hcms channel create`	channel key	Creates a new channel in the Censhare system.
`hcms channel update`	channel key	Updates a specified channel in the Censhare system. If the channel is currently disabled, it will be automatically enabled.

Option short	Option long	Default option value	Meaning
`-n`	`--name`	-	Output channel UI name for the default locale
`-d`	`--description`	-	Output channel UI description for the default locale
`-N`	-	-	Sets a name for the output channel in the Censhare UI listings, for any non-default locale.
`-D`	-	-	Sets a description for the output channel in the Censhare UI listings, for any non-default locale.
`-s`	`--sorting`	`999`	Sets the channel position in the Censhare UI listings
-	`--disabled`	(not disabled)	Disables a specified channel and all below it, i.e. omits them from any listings and makes assigning to it impossible

The syntax for setting non-default locales is the following: -N en=Stuff -N de=Zeug -N es=Chisme.

Sorting has "two defaults":

1 is set if you do not try to set your own order at all
999 is set if you try to set your own order using either -s or --sorting but do not specify any value

Command	Argument	Meaning
`hcms channel delete`	domain key

Option short	Option long	Default option value	Meaning
`--replace-by <RKEY>`	`root.`	Replaces all existing usages of these deleted channel on affected assets

It is not possible to delete output channels that are actively used.