Skip to content

Update README.md #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 27, 2025
Merged

Update README.md #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The Socket Security CLI was created to enable integrations with other tools like
```` shell
socketcli [-h] [--api_token API_TOKEN] [--repo REPO] [--branch BRANCH] [--committer COMMITTER] [--pr_number PR_NUMBER]
[--commit_message COMMIT_MESSAGE] [--default_branch] [--target_path TARGET_PATH] [--scm {api,github,gitlab}] [--sbom-file SBOM_FILE]
[--commit-sha COMMIT_SHA] [--generate-license GENERATE_LICENSE] [-v] [--enable-debug] [--enable-json] [--disable-overview]
[--commit-sha COMMIT_SHA] [--generate-license GENERATE_LICENSE] [-v] [--enable-debug] [--enable-json] [--enable-sarif] [--disable-overview]
[--disable-security-issue] [--files FILES] [--ignore-commit-files] [--timeout]
````

Expand All @@ -33,6 +33,7 @@ If you don't want to provide the Socket API Token every time then you can use th
| --commit-sha | | False | | The commit hash for the commit |
| --generate-license | | False | False | If enabled with `--sbom-file` will include license details |
| --enable-json | | False | False | If enabled will change the console output format to JSON |
| --enable-sarif | | False | False | If enabled will change the console output format to SARIF |
| --disable-overview | | False | False | If enabled will disable Dependency Overview comments |
| --disable-security-issue | | False | False | If enabled will disable Security Issue Comments |
| --files | | False | | If provided in the format of `["file1", "file2"]` will be used to determine if there have been supported file changes. This is used if it isn't a git repo and you would like to only run if it supported files have changed. |
Expand Down
Loading