{"id":20494807,"url":"https://github.com/gitguardian/gg-shield-orb","last_synced_at":"2025-03-05T17:48:10.493Z","repository":{"id":37825900,"uuid":"272659337","full_name":"GitGuardian/gg-shield-orb","owner":"GitGuardian","description":" GitGuardian Shield Circle CI Orb - Find exposed credentials in your commits ","archived":false,"fork":false,"pushed_at":"2023-11-13T17:33:00.000Z","size":34,"stargazers_count":1,"open_issues_count":1,"forks_count":5,"subscribers_count":20,"default_branch":"master","last_synced_at":"2025-01-16T06:12:03.735Z","etag":null,"topics":["ci","circleci","circleci-orbs","devsecops","gitguardian","secrets-detection","security-tools"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GitGuardian.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-16T08:58:40.000Z","updated_at":"2024-01-11T10:08:37.000Z","dependencies_parsed_at":"2022-08-31T05:40:32.948Z","dependency_job_id":null,"html_url":"https://github.com/GitGuardian/gg-shield-orb","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GitGuardian%2Fgg-shield-orb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GitGuardian%2Fgg-shield-orb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GitGuardian%2Fgg-shield-orb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GitGuardian%2Fgg-shield-orb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GitGuardian","download_url":"https://codeload.github.com/GitGuardian/gg-shield-orb/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242076654,"owners_count":20068234,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ci","circleci","circleci-orbs","devsecops","gitguardian","secrets-detection","security-tools"],"created_at":"2024-11-15T17:43:14.207Z","updated_at":"2025-03-05T17:48:10.470Z","avatar_url":"https://github.com/GitGuardian.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca href=\"https://gitguardian.com/\"\u003e\u003cimg src=\"https://cdn.jsdelivr.net/gh/GitGuardian/gg-shield-orb/doc/logo.svg\"\u003e\u003c/a\u003e\n\n---\n\n# [GitGuardian Shield](https://github.com/GitGuardian/gg-shield) CircleCI Orb\n\n[![CircleCI Registry](https://img.shields.io/badge/CircleCI%20Registry-v1-undefined.svg?logo=circleci\u0026logoColor=white\u0026style=for-the-badge)](https://circleci.com/orbs/registry/orb/gitguardian/ggshield)\n[![Docker Image Version (latest semver)](https://img.shields.io/docker/v/gitguardian/ggshield?color=1B2D55\u0026sort=semver\u0026style=for-the-badge\u0026label=ggshield)](https://hub.docker.com/r/gitguardian/ggshield)\n[![License](https://img.shields.io/github/license/GitGuardian/gg-shield-orb?color=%231B2D55\u0026style=for-the-badge)](LICENSE)\n![GitHub stars](https://img.shields.io/github/stars/gitguardian/gg-shield-orb?color=%231B2D55\u0026style=for-the-badge)\n\nFind exposed credentials in your commits using [**GitGuardian shield**](https://github.com/GitGuardian/gg-shield).\n\nThe **GitGuardian shield** (gg-shield) is a CLI application that runs in your local environment\nor in a CI environment to help you detect more than 200 types of secrets, as well as other potential security vulnerabilities or policy breaks.\n\n**GitGuardian shield** uses our [public API](https://api.gitguardian.com/doc) through [py-gitguardian](https://github.com/GitGuardian/py-gitguardian) to scan your files and detect potential secrets or issues in your code. **The `/v1/scan` endpoint of the [public API](https://api.gitguardian.com/doc) is stateless. We will not store any files you are sending or any secrets we have detected**.\n\nYou'll need an **API Key** from [GitGuardian](https://dashboard.gitguardian.com/api/v1/auth/user/github_login/authorize?utm_source=github\u0026utm_medium=gg_shield\u0026utm_campaign=shield1) to use gg-shield.\n\n## Installation\n\nTo add GitGuardian shield to your pipelines configure your `.circleci/config.yml` to add the ggshield orb:\n\n```yaml\nversion: 2.1\n\norbs:\n  ggshield: gitguardian/ggshield@volatile\n\nworkflows:\n  main:\n    jobs:\n      - ggshield/scan:\n          name: ggshield-scan # best practice is to name each orb job\n          base_revision: \u003c\u003cpipeline.git.base_revision\u003e\u003e\n          revision: \u003c\u003cpipeline.git.revision\u003e\u003e\n```\n\nDo not forget to add your [GitGuardian API Key](https://dashboard.gitguardian.com/api/v1/auth/user/github_login/authorize?utm_source=github\u0026utm_medium=gg_shield\u0026utm_campaign=shield1) to the `GITGUARDIAN_API_KEY` environment variable in your project settings.\n\n## License\n\nThis project is licensed under the MIT License - read [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitguardian%2Fgg-shield-orb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgitguardian%2Fgg-shield-orb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitguardian%2Fgg-shield-orb/lists"}