https://github.com/blimmer/circleci-audit

Audit your CircleCI Environment
https://github.com/blimmer/circleci-audit

circleci security security-audit security-auditing-tool

Last synced: 4 months ago
JSON representation

Audit your CircleCI Environment

• Host: GitHub
• URL: https://github.com/blimmer/circleci-audit
• Owner: blimmer
• License: mit
• Created: 2023-01-06T20:30:08.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-04-01T23:07:13.000Z (about 3 years ago)
• Last Synced: 2025-10-07T13:00:43.507Z (8 months ago)
• Topics: circleci, security, security-audit, security-auditing-tool
• Language: TypeScript
• Homepage:
• Size: 1.67 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# circleci-audit

This is a simple tool that helps audit CircleCI context environment variables need to be rotated in response

to the [January 4, 2023 security incident](https://circleci.com/blog/january-4-2023-security-alert/).

Secrets that need rotation are highlighted for easy identification.

![example output of circleci-audit contexts command](https://user-images.githubusercontent.com/630449/211111479-ab2f8a2c-5200-4ded-8c5e-aee2bce1f753.png)

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

[![Version](https://img.shields.io/npm/v/blimmer-circleci-audit.svg)](https://npmjs.org/package/circleci-audit)

[![Downloads/week](https://img.shields.io/npm/dw/blimmer-circleci-audit.svg)](https://npmjs.org/package/circleci-audit)

[![License](https://img.shields.io/npm/l/blimmer-circleci-audit.svg)](https://github.com/blimmer/circleci-audit/blob/main/package.json)

* [circleci-audit](#circleci-audit)

* [Usage](#usage)

* [Commands](#commands)

# Usage

```sh-session

$ npm install -g circleci-audit

$ circleci-audit COMMAND

running command...

$ circleci-audit (--version)

circleci-audit/0.0.0-development darwin-arm64 node-v18.12.1

$ circleci-audit --help [COMMAND]

USAGE

  $ circleci-audit COMMAND

...

```

# Commands

* [`circleci-audit contexts`](#circleci-audit-contexts)

* [`circleci-audit help [COMMAND]`](#circleci-audit-help-command)

## `circleci-audit contexts`

Audit CircleCI contexts for exposed secrets

```

USAGE

  $ circleci-audit contexts -o  -t  [-o csv|table|json]

FLAGS

  -o, --orgId=                  (required) Your organization's ID. Find it on app.circleci.com, click

                                       'Organization Settings'. It's a UUID.

  -o, --outputFormat=(csv|table|json)  [default: table]

  -t, --token=                  (required) A CircleCI API token. Generate one here:

                                       https://app.circleci.com/settings/user/tokens.

DESCRIPTION

  Audit CircleCI contexts for exposed secrets

EXAMPLES

  $ circleci-audit contexts --token $CIRCLECI_TOKEN --orgId YOUR-ORG-UUID

```

_See code: [dist/commands/contexts/index.ts](https://github.com/blimmer/circleci-audit/blob/v0.0.0-development/dist/commands/contexts/index.ts)_

## `circleci-audit help [COMMAND]`

Display help for circleci-audit.

```

USAGE

  $ circleci-audit help [COMMAND] [-n]

ARGUMENTS

  COMMAND  Command to show help for.

FLAGS

  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION

  Display help for circleci-audit.

```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.22/src/commands/help.ts)_