Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.semgrep.dev/llms.txt

Use this file to discover all available pages before exploring further.

Add tags for specific projects in the Semgrep AppSec Platform through the following methods:
  • Set tags through the Semgrep AppSec Platform > Projects > Project details page.
  • Set tags using the Semgrep AppSec Platform API.
  • Set tags in your repository’s .semgrepconfig.yml file.
SETTING TAGS
  • Keep in mind, when setting tags via the .semgrepconfig.yml file or Semgrep AppSec Platform API, that these actions supersede any tags previously set.
  • For example, if you set tags through the API and subsequently run a CI scan, then the previous tags set by the API will be overwritten by any tag definitions in the .semgrepconfig.yml file of the repository.
  • For this reason, the Semgrep team recommends exclusively choosing either the API or .semgrepconfig.yml file to manage and set tags. Do not use a mix of the two.

​
Set tags through Semgrep AppSec Platform and the API

To manage tags through Semgrep AppSec Platform, follow these steps:
1
Go to the Semgrep AppSec Platform Projects page.
2
Find the project you want to modify, then click its icon under Details.
3
Click the Settings tab.
4
Add or remove tags under the Tags section.
5
Click Save.
Refer to Semgrep API documentation to use the API.

​
Set tags in .semgrepconfig.yml

You can also add tags through a specific file added to your repository. To do so, follow the instructions below:
1
Create .semgrepconfig.yml file in the root directory of your repository.
2
Add tags to the .semgrepconfig.yml file. Example of tags added to .semgrepconfig.yml file:
tags:
    - favourite
    - awesomeproject
CAUTIONChanges to tags made through the .semgrepconfig.yml file are also visible in the Semgrep AppSec Platform > Projects page, however, the inverse is not true (changes in Semgrep AppSec Platform > Projects page will be overwritten by .semgrepconfig.yml.)