https://github.com/stoe/action-reporting-parse-cli

CLI to parse https://github.com/stoe/action-reporting-cli reports
https://github.com/stoe/action-reporting-parse-cli

cli github parser reporting

Last synced: 4 months ago
JSON representation

CLI to parse https://github.com/stoe/action-reporting-cli reports

• Host: GitHub
• URL: https://github.com/stoe/action-reporting-parse-cli
• Owner: stoe
• License: mit
• Created: 2023-08-15T07:47:41.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2025-04-01T09:37:01.000Z (about 1 year ago)
• Last Synced: 2025-07-13T23:48:56.308Z (12 months ago)
• Topics: cli, github, parser, reporting
• Language: JavaScript
• Homepage: https://npm.im/@stoe/action-reporting-parse-cli
• Size: 293 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: license
  • Codeowners: .github/codeowners

Awesome Lists containing this project

README

          
# action-reporting-parse-cli

[![Test](https://github.com/stoe/action-reporting-parse-cli/actions/workflows/test.yml/badge.svg)](https://github.com/stoe/action-reporting-parse-cli/actions/workflows/test.yml) [![CodeQL](https://github.com/stoe/action-reporting-parse-cli/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/stoe/action-reporting-parse-cli/actions/workflows/github-code-scanning/codeql) [![Publish](https://github.com/stoe/action-reporting-parse-cli/actions/workflows/publish.yml/badge.svg)](https://github.com/stoe/action-reporting-parse-cli/actions/workflows/publish.yml) [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

> CLI to parse https://github.com/stoe/action-reporting-cli reports

## Usage example

```sh

$ npx @stoe/action-reporting-parse-cli [--options]

```

> **Note**

> Report CSV file will be saved in `current_directory/uses.csv`.

## Required options

- `--config`, `-c` Path to config.yml file.

- `--data`, `-d` Path to data directory to lookup `*actions.json` files.

## Additional options

- `--open`, `-o` Open the generated CSV file.

## Helper options

- `--help`, `-h` Print action-reporting-parse-cli help.

- `--version`, `-v` Print action-reporting-parse-cli version.

## Examples

```sh

# Run action-reporting-parse-cli with default options

$ npx @stoe/action-reporting-parse-cli \

  --config ./config.yml \

  --data ./data

```

```sh

# Run action-reporting-parse-cli with default options

# and open the generated CSV file

$ npx @stoe/action-reporting-parse-cli \

  --config ./config.yml \

  --data ./data \

  --open

```

## License

[MIT](./license) © [Stefan Stölzle](https://github.com/stoe)