@commercelayer/cli-plugin-tags

Commerce Layer CLI Tags plugin

• Usage
• Commands

Usage

commercelayer COMMAND

commercelayer [COMMAND] (--help | -h) for detailed information about plugin commands.

Commands

• commercelayer tags [ID]
• commercelayer tags:add
• commercelayer tags:count ID_NAME
• commercelayer tags:create
• commercelayer tags:delete
• commercelayer tags:details ID_NAME
• commercelayer tags:list
• commercelayer tags:remove
• commercelayer tags:types
• commercelayer tags:update ID_NAME
• commercelayer tags:which ID_NAME

commercelayer tags [ID]

List all the created tags or show details of a single tag.

USAGE
  $ commercelayer tags [ID] [-A | -l <value>]

ARGUMENTS
  ID  unique id of the tag to be retrieved

FLAGS
  -A, --all            show all tags instead of first 25 only
  -l, --limit=<value>  limit number of tags in output

DESCRIPTION
  list all the created tags or show details of a single tag

See code: src/commands/tags/index.ts

commercelayer tags:add

Add one or more tags to a set of resources.

USAGE
  $ commercelayer tags:add -n <value> -t <value> -i <value> [-C <value>] [-v]

FLAGS
  -C, --create=<value>   create tags if don't exist
  -i, --id=<value>...    (required) the IDs of the resources to tag
  -n, --name=<value>...  (required) the tag name
  -t, --type=<value>     (required) the type of the resource to tag
  -v, --verbose          show details of the tag process

DESCRIPTION
  add one or more tags to a set of resources

ALIASES
  $ commercelayer tag

EXAMPLES
  $ commercelayer tags:add -t <resource-type> -n <tag-names> -i <resources-id>

  $ cl tag -t customers -i aBcDeFghIL mnOPqRstUV -n groupA

See code: src/commands/tags/add.ts

commercelayer tags:count ID_NAME

Count resources tagged with a specific tag.

USAGE
  $ commercelayer tags:count ID_NAME [-t <value> | -z]

ARGUMENTS
  ID_NAME  unique id or name of the tag

FLAGS
  -t, --type=<value>  the type of the tagged resources
  -z, --zero          show also resources without tags

DESCRIPTION
  count resources tagged with a specific tag

EXAMPLES
  $ commercelayer tags:count

  $ cl tags:count -t <resource-type>

See code: src/commands/tags/count.ts

commercelayer tags:create

Create one or more new tags.

USAGE
  $ commercelayer tags:create -n <value>

FLAGS
  -n, --name=<value>...  (required) the tag name

DESCRIPTION
  create one or more new tags

EXAMPLES
  $ commercelayer tags:create -n <tag-names>

  $ cl tags:create -n flag1 flag2 flag3

See code: src/commands/tags/create.ts

commercelayer tags:delete

Delete one or more existing tags.

USAGE
  $ commercelayer tags:delete -n <value>

FLAGS
  -n, --name=<value>...  (required) the tag name

DESCRIPTION
  delete one or more existing tags

EXAMPLES
  $ commercelayer tags:delete -n <tag-names>

  $ cl tags:delete -n flag1 flag2 flag3

See code: src/commands/tags/delete.ts

commercelayer tags:details ID_NAME

Show the details of an existing tag.

USAGE
  $ commercelayer tags:details ID_NAME

ARGUMENTS
  ID_NAME  unique id or name of the tag

DESCRIPTION
  show the details of an existing tag

EXAMPLES
  $ commercelayer tags:details <tag-id/tag-name>

See code: src/commands/tags/details.ts

commercelayer tags:list

List all the created tags.

USAGE
  $ commercelayer tags:list [-A | -l <value>]

FLAGS
  -A, --all            show all tags instead of first 25 only
  -l, --limit=<value>  limit number of tags in output

DESCRIPTION
  list all the created tags

EXAMPLES
  $ commercelayer tags

  $ cl tags:list -A

See code: src/commands/tags/list.ts

commercelayer tags:remove

Remove one or more tags to a set of resources.

USAGE
  $ commercelayer tags:remove -n <value> -t <value> -i <value> [-v]

FLAGS
  -i, --id=<value>...    (required) the IDs of th eresources to tag
  -n, --name=<value>...  (required) the tag name
  -t, --type=<value>     (required) the type of the resource to tag
  -v, --verbose          show details of the tag process

DESCRIPTION
  remove one or more tags to a set of resources

EXAMPLES
  $ commercelayer tags:remove -t <resource-type> -n <tag-names> -i <resources-id>

  $ cl tags:rm -t customers -i aBcDeFghIL mnOPqRstUV -n groupA

See code: src/commands/tags/remove.ts

commercelayer tags:types

Show online documentation for supported resources.

USAGE
  $ commercelayer tags:types [-O]

FLAGS
  -O, --open  open online documentation page

DESCRIPTION
  show online documentation for supported resources

EXAMPLES
  $ commercelayer tags:types

See code: src/commands/tags/types.ts

commercelayer tags:update ID_NAME

Update an existing tag.

USAGE
  $ commercelayer tags:update ID_NAME -n <value>

ARGUMENTS
  ID_NAME  unique id or name of the tag

FLAGS
  -n, --name=<value>  (required) the new tag name

DESCRIPTION
  update an existing tag

EXAMPLES
  $ commercelayer tags:update <tag-id> -n <tag-name>

See code: src/commands/tags/update.ts

commercelayer tags:which ID_NAME

Show all the resources with this tag.

USAGE
  $ commercelayer tags:which ID_NAME -t <value> [-A | -l <value>]

ARGUMENTS
  ID_NAME  unique id or name of the tag

FLAGS
  -A, --all            show all resources instead of first 25 only
  -l, --limit=<value>  limit number of resources in output
  -t, --type=<value>   (required) the type of the tagged resources

DESCRIPTION
  show all the resources with this tag

EXAMPLES
  $ commercelayer tags:which <tag-id-or-name> -t <resource-type>

  $ cl tags:which groupA -t customers -A

See code: src/commands/tags/which.ts