> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kosli.com/llms.txt
> Use this file to discover all available pages before exploring further.

# kosli tag

> Tag a resource in Kosli with key-value pairs.  

## Synopsis

```shell theme={"theme":"dracula","languages":{"custom":["/languages/rego.json"]}}
kosli tag RESOURCE-TYPE [RESOURCE-ID] [flags]
```

Tag a resource in Kosli with key-value pairs.\
use --set to add or update tags, and --unset to remove tags.

Valid resource types are: flow, flows, env, environment, environments, control, controls, repo, repos.

Repos are identified by their name. If multiple repos share the same name
across VCS providers, use --provider to disambiguate, or tag the repo
unambiguously by its internal ID with --repo-id (see: kosli get repo).
Note: in dry-run mode the repo name is not resolved to its internal ID
(no request is made to Kosli), so the previewed request URL contains the
name as-is, whereas a real run sends the resolved ID.

## Flags

| Flag | Type | Description |
| :- | :- | :- |
| `-D`, `--dry-run` | bool | \[optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors. |
| `-h`, `--help` | bool | help for tag |
| `--provider` | string | \[optional] The VCS provider of the repo (e.g. github, gitlab). Only valid when tagging repos; required when multiple repos share the same name across providers. |
| `--repo-id` | string | \[optional] The repo's internal ID (see: kosli get repo). Only valid when tagging repos; replaces the RESOURCE-ID argument and identifies the repo unambiguously. |
| `-s`, `--set` | stringToString | \[optional] The key-value pairs to tag the resource with. The format is: key=value |
| `-u`, `--unset` | strings | \[optional] The list of tag keys to remove from the resource. |

## Flags inherited from parent commands

| Flag | Type | Description |
| :- | :- | :- |
| `-a`, `--api-token` | string | The Kosli API token. |
| `-c`, `--config-file` | string | \[optional] The Kosli config file path. Config is read from this path or the default only, never implicitly from the current directory. (default "\$HOME/.kosli.yml") |
| `--debug` | bool | \[optional] Print debug logs to stdout. |
| `-H`, `--host` | string | \[defaulted] The Kosli endpoint. (default "[https://app.kosli.com](https://app.kosli.com)") |
| `--http-proxy` | string | \[optional] The HTTP proxy URL including protocol and port number. e.g. `http://proxy-server-ip:proxy-port` |
| `-r`, `--max-api-retries` | int | \[defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) |
| `--org` | string | The Kosli organization. |
| `-q`, `--quiet` | bool | \[optional] Suppress non-critical warning messages. Errors and normal output are not affected. If both `--quiet` and `--debug` are set, `--debug` wins. |

## Live Examples in different CI systems

<Tabs>
  <Tab title="GitHub">
    View an example of the `kosli tag` command in GitHub.

    In [this YAML file](https://github.com/cyber-dojo/aws-prod-co-promotion/blob/78095bc425078b1de3795c7dc866d8cafbd564ee/.github/workflows/promote_one.yml#L74)
  </Tab>

  <Tab title="GitLab">
    View an example of the `kosli tag` command in GitLab.

    In [this YAML file](https://gitlab.com/cyber-dojo/creator/-/blob/48bdbd3b059d45489e8ae5f9f680f48bc6201ad8/.gitlab/workflows/main.yml#L52)
  </Tab>
</Tabs>

## Examples Use Cases

These examples all assume that the flags  `--api-token`, `--org`, `--host`, (and `--flow`, `--trail` when required), are [set/provided](/getting_started/install/#assigning-flags-via-environment-variables).

<AccordionGroup>
  <Accordion title="add/update tags to a flow">
    ```shell theme={"theme":"dracula","languages":{"custom":["/languages/rego.json"]}}
    kosli tag flow yourFlowName 
    	--set key1=value1 
    	--set key2=value2 

    ```
  </Accordion>

  <Accordion title="tag an environment">
    ```shell theme={"theme":"dracula","languages":{"custom":["/languages/rego.json"]}}
    kosli tag env yourEnvironmentName 
    	--set key1=value1 
    	--set key2=value2 

    ```
  </Accordion>

  <Accordion title="add/update tags to an environment">
    ```shell theme={"theme":"dracula","languages":{"custom":["/languages/rego.json"]}}
    kosli tag env yourEnvironmentName 
    	--set key1=value1 
    	--set key2=value2 

    ```
  </Accordion>

  <Accordion title="remove tags from an environment">
    ```shell theme={"theme":"dracula","languages":{"custom":["/languages/rego.json"]}}
    kosli tag env yourEnvironmentName 
    	--unset key1=value1 

    ```
  </Accordion>

  <Accordion title="tag a control">
    ```shell theme={"theme":"dracula","languages":{"custom":["/languages/rego.json"]}}
    kosli tag control yourControlIdentifier 
    	--set key1=value1 

    ```
  </Accordion>

  <Accordion title="tag a repo">
    ```shell theme={"theme":"dracula","languages":{"custom":["/languages/rego.json"]}}
    kosli tag repo yourOrg/yourRepoName 
    	--set key1=value1 

    ```
  </Accordion>

  <Accordion title="tag a repo whose name exists across multiple VCS providers">
    ```shell theme={"theme":"dracula","languages":{"custom":["/languages/rego.json"]}}
    kosli tag repo yourOrg/yourRepoName 
    	--provider github 
    	--set key1=value1 

    ```
  </Accordion>

  <Accordion title="tag a repo by its internal ID (see: kosli get repo)">
    ```shell theme={"theme":"dracula","languages":{"custom":["/languages/rego.json"]}}
    kosli tag repo --repo-id yourRepoID 
    	--set key1=value1 
    ```
  </Accordion>
</AccordionGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.