Skip to main content

Tag and Tag Type Commands

Manage tags and tag types for organizing and categorizing assets in VAMS. Tags belong to tag types, which define categories for classification.


tag list

List all tags, optionally filtered by tag type.

vamscli tag list [--tag-type <TYPE>] [--json-output]
OptionTypeRequiredDescription
--tag-typeTEXTNoFilter tags by tag type name
--json-outputFlagNoOutput raw JSON response

tag create

Create a new tag or multiple tags.

vamscli tag create [OPTIONS]
OptionTypeRequiredDescription
--tag-nameTEXTConditionalTag name (required unless using --json-input)
--descriptionTEXTConditionalTag description
--tag-type-nameTEXTConditionalTag type name
--json-inputTEXTNoJSON input for batch creation
--json-outputFlagNoOutput raw JSON response

JSON input format (batch creation)

{
"tags": [
{ "tagName": "urgent", "description": "Urgent priority", "tagTypeName": "priority" },
{ "tagName": "low", "description": "Low priority", "tagTypeName": "priority" }
]
}
vamscli tag create --tag-name "urgent" --description "Urgent priority" --tag-type-name "priority"
vamscli tag create --json-input @tags.json --json-output

tag update

Update an existing tag's description or tag type.

vamscli tag update --tag-name "urgent" --description "Updated description"
vamscli tag update --tag-name "urgent" --tag-type-name "new-priority"

tag delete

Delete a tag. Requires the --confirm flag.

vamscli tag delete urgent --confirm

tag-type list

List all tag types, optionally including associated tags.

vamscli tag-type list [--show-tags] [--json-output]

tag-type create

Create a new tag type or multiple tag types.

vamscli tag-type create [OPTIONS]
OptionTypeRequiredDescription
--tag-type-nameTEXTConditionalTag type name
--descriptionTEXTConditionalTag type description
--requiredFlagNoMark as required for asset classification
--json-inputTEXTNoJSON input for batch creation
--json-outputFlagNoOutput raw JSON response

JSON input format

{
"tagTypes": [
{ "tagTypeName": "priority", "description": "Priority levels", "required": "True" },
{ "tagTypeName": "category", "description": "Asset categories", "required": "False" }
]
}

tag-type update

Update a tag type's description or required status.

vamscli tag-type update --tag-type-name "priority" --description "Updated description"
vamscli tag-type update --tag-type-name "priority" --required
vamscli tag-type update --tag-type-name "priority" --not-required

tag-type delete

Delete a tag type. Cannot delete tag types that are currently in use by tags.

vamscli tag-type delete priority --confirm

Workflow Example

# Create tag types first
vamscli tag-type create --tag-type-name "priority" --description "Priority levels" --required
vamscli tag-type create --tag-type-name "category" --description "Asset categories"

# Create tags for each type
vamscli tag create --tag-name "urgent" --description "Urgent priority" --tag-type-name "priority"
vamscli tag create --tag-name "model" --description "3D models" --tag-type-name "category"

# Verify
vamscli tag-type list --show-tags
vamscli tag list --tag-type priority