Skip to content

Commit

Permalink
chore(README): add new commands to readme and bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
Jguer committed Jul 6, 2021
1 parent 1fe6884 commit 4ef8054
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 1 deletion.
48 changes: 48 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ GITGUARDIAN_API_KEY=<GitGuardian API Key>
- [Scan](#scan-command)
- [Install](#install-command)
- [Ignore](#ignore-command)
- [Quota](#quota-command)
- [API Status](#api-status-command)

1. [Pre-commit](#pre-commit)

Expand Down Expand Up @@ -257,6 +259,52 @@ Options:
--last-found Ignore all secrets found by last run scan
```
## Quota command
Show remaining quota of the workspace.
```
Usage: ggshield quota [OPTIONS]
Command to show quotas overview.
Options:
--json JSON output results [default: False]
-h, --help Show this message and exit.
```
Example:
```
❯ ggshield quota
Quota available: 9440
Quota used in the last 30 days: 560
Total Quota of the workspace: 10000
```
## API Status command
Show API status and version.
```
Usage: ggshield api-status [OPTIONS]
Command to show api status.
Options:
--json JSON output results [default: False]
-h, --help Show this message and exit.
```
Example:
```
❯ ggshield api-status
status: healthy
app-version: 1.27.0-rc.1
secrets-engine-version-version: 2.44.0
```
# Configuration
Configuration in `ggshield` follows a `global>local>CLI` configuration scheme.
Expand Down
2 changes: 1 addition & 1 deletion ggshield/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "1.6.1"
__version__ = "1.7.0"

0 comments on commit 4ef8054

Please sign in to comment.