https://github.com/crowphp/badger
Badge Creator for CrowPHP
https://github.com/crowphp/badger
Last synced: 10 months ago
JSON representation
Badge Creator for CrowPHP
- Host: GitHub
- URL: https://github.com/crowphp/badger
- Owner: crowphp
- Created: 2021-01-09T13:42:30.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-01-28T09:08:22.000Z (almost 5 years ago)
- Last Synced: 2025-02-24T23:05:19.355Z (11 months ago)
- Language: PHP
- Size: 33.2 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# badger
Badger is a small CLI utility for generating a shields.io compatible JSON from clover.xml report and uploading it to a badger-server, see github.com/crowphp/badger-server to read more about the server.
## Installing badger from composer
```
composer require --dev crowphp/badger:dev-master
```
Notice: At the moment the badger is under development use it with caution.
## Usage
Help Document
```
$ php vendor/bin/badger --help
Console Tool
Usage:
command [options] [arguments]
Options:
-h, --help Display help for the given command. When no command is given display help for the list command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output
-n, --no-interaction Do not ask any interactive question
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
Available commands:
help Displays help for a command
list Lists commands
upload
upload:coverage Creates json for coverage badge shields.io and uploads it to a given badger server
```
Create badge schema on a badger server for a given branch
```
$ php upload:coverage
Description:
Creates json for coverage badge shields.io and uploads it to a given badger server
Usage:
upload:coverage
Arguments:
server URL for Badger Server
branch The branch name for the coverage
secret-key Secret api key for badger server
Options:
-h, --help Display help for the given command. When no command is given display help for the list command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output
-n, --no-interaction Do not ask any interactive question
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
```