HCMS CLI managing Censhare domains | Censhare Documentation

Below is the overview of arguments and options for the hcms domain commands that manage the first domain. To manage the second domain, simply replace domain with domain2.

View commands

Command	Argument	Meaning
`hcms domain list`	-	Displays all currently enabled domains as a YAML output
`hcms domain inspect`	domain key	Displays information about the specified domain as a YAML output

Sample YAML output:

key: root.
name: Root
name_de: Root
sorting: 1
enabled: true

CRUD commands

Create and update

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

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

Option short	Option long	Default option value	Meaning
`-n`	`--name`	domain key	Sets a name for the domain in the Censhare UI listings
`-s`	`--sorting`	`999`	Sets the domain position in the Censhare UI listings
`-n`	`--name`	-	Sets a name for the domain in the Censhare UI listings
`-s`	`--sorting`	-	Sets the domain position in the Censhare UI listings
-	`--disabled`	(not disabled)	Disables a specified domain and its subdomains, i.e. omits them from any listings and makes assigning to it impossible

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

Delete

Command	Argument	Meaning
`hcms domain delete`	domain key	Deletes a specified domain and all its subdomains from the Censhare system