# Socket Security CLI
The Socket Security CLI was created to enable integrations with other tools like Github Actions, Gitlab, BitBucket, local use cases and more. The tool will get the head scan for the provided repo from Socket, create a new one, and then report any new alerts detected. If there are new alerts against the Socket security policy it'll exit with a non-Zero exit code.
## Usage
```` shell
socketcli [-h] [--api_token API_TOKEN] [--repo REPO] [--branch BRANCH] [--committer COMMITTER] [--pr_number PR_NUMBER] [--commit_message COMMIT_MESSAGE] [--default_branch DEFAULT_BRANCH]
[--target_path TARGET_PATH] [--mode {diff,new,license}] [--scm {api,github}] [--generate-license GENERATE_LICENSE]
````
If you don't want to provide the Socket API Token every time then you can use the environment variable `SOCKET_SECURITY_API_KEY`
| Parameter | Alternate Name | Required | Default | Description |
|:-------------------|:---------------|:---------|:--------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------|
| -h | --help | False | | Show the CLI help message |
| --api_token | | False | | Provides the Socket API Token |
| --repo | | True | | The string name in a git approved name for repositories. |
| --branch | | False | | The string name in a git approved name for branches. |
| --committer | | False | | The string name of the person doing the commit or running the CLI. Can be specified multiple times to have more than one committer |
| --pr_number | | False | 0 | The integer for the PR or MR number |
| --commit_message | | False | | The string for a commit message if there is one |
| --default_branch | | False | False | If the flag is specified this will signal that this is the default branch. This needs to be enabled for a report to update Org Alerts and Org Dependencies |
| --target_path | | False | ./ | This is the path to where the manifest files are location. The tool will recursively search for all supported manifest files |
| --scm | | False | api | This is the mode that the tool is to run in. For local runs `api` would be the mode. Other options are `gitlab` and `github` |
| --generate-license | | False | False | If this flag is specified it will generate a json file with the license per package and license text in the current working directory |
| --version | -v | False | | Prints the version and exits |
| --enable-debug | | False | False | Enables debug messaging for the CLI |
Raw data
{
"_id": null,
"home_page": null,
"name": "socketsecurity",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Douglas Coburn <douglas@socket.dev>",
"keywords": "socketsecurity, socket.dev, sca, oss, security",
"author": null,
"author_email": "Douglas Coburn <douglas@socket.dev>",
"download_url": "https://files.pythonhosted.org/packages/9e/fa/2d3c210d97c13ac0cfc9d2c6ce7fd4aa36793da02c4beb625b05c0fbd832/socketsecurity-0.0.70.tar.gz",
"platform": null,
"description": "# Socket Security CLI\n\nThe Socket Security CLI was created to enable integrations with other tools like Github Actions, Gitlab, BitBucket, local use cases and more. The tool will get the head scan for the provided repo from Socket, create a new one, and then report any new alerts detected. If there are new alerts against the Socket security policy it'll exit with a non-Zero exit code.\n\n## Usage\n\n```` shell\nsocketcli [-h] [--api_token API_TOKEN] [--repo REPO] [--branch BRANCH] [--committer COMMITTER] [--pr_number PR_NUMBER] [--commit_message COMMIT_MESSAGE] [--default_branch DEFAULT_BRANCH]\n [--target_path TARGET_PATH] [--mode {diff,new,license}] [--scm {api,github}] [--generate-license GENERATE_LICENSE]\n````\n\nIf you don't want to provide the Socket API Token every time then you can use the environment variable `SOCKET_SECURITY_API_KEY`\n\n\n| Parameter | Alternate Name | Required | Default | Description |\n|:-------------------|:---------------|:---------|:--------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| -h | --help | False | | Show the CLI help message |\n| --api_token | | False | | Provides the Socket API Token |\n| --repo | | True | | The string name in a git approved name for repositories. |\n| --branch | | False | | The string name in a git approved name for branches. |\n| --committer | | False | | The string name of the person doing the commit or running the CLI. Can be specified multiple times to have more than one committer |\n| --pr_number | | False | 0 | The integer for the PR or MR number |\n| --commit_message | | False | | The string for a commit message if there is one |\n| --default_branch | | False | False | If the flag is specified this will signal that this is the default branch. This needs to be enabled for a report to update Org Alerts and Org Dependencies |\n| --target_path | | False | ./ | This is the path to where the manifest files are location. The tool will recursively search for all supported manifest files |\n| --scm | | False | api | This is the mode that the tool is to run in. For local runs `api` would be the mode. Other options are `gitlab` and `github` |\n| --generate-license | | False | False | If this flag is specified it will generate a json file with the license per package and license text in the current working directory |\n| --version | -v | False | | Prints the version and exits |\n| --enable-debug | | False | False | Enables debug messaging for the CLI |\n",
"bugtrack_url": null,
"license": null,
"summary": "Socket Security CLI for CI/CD",
"version": "0.0.70",
"project_urls": {
"Homepage": "https://socket.dev"
},
"split_keywords": [
"socketsecurity",
" socket.dev",
" sca",
" oss",
" security"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dbfa859d6aaa6e4052a45ba441133dda87863ee2196c2a7c26c5444ebcabafc6",
"md5": "ea6e6b44cdaca37cbfbad339bfe1c4c0",
"sha256": "d82206838bfb809b9a6d53cb8b386b0bade178dfb193c5a62010923ae26ff7e8"
},
"downloads": -1,
"filename": "socketsecurity-0.0.70-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ea6e6b44cdaca37cbfbad339bfe1c4c0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 2710033,
"upload_time": "2024-05-28T23:54:53",
"upload_time_iso_8601": "2024-05-28T23:54:53.401016Z",
"url": "https://files.pythonhosted.org/packages/db/fa/859d6aaa6e4052a45ba441133dda87863ee2196c2a7c26c5444ebcabafc6/socketsecurity-0.0.70-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9efa2d3c210d97c13ac0cfc9d2c6ce7fd4aa36793da02c4beb625b05c0fbd832",
"md5": "d4f986e128e0ed1516b7a083e2232e54",
"sha256": "2295f0ad2a98cb51f76f386a3075beb7309b5d30fe4410ee870cc6868ff04dc3"
},
"downloads": -1,
"filename": "socketsecurity-0.0.70.tar.gz",
"has_sig": false,
"md5_digest": "d4f986e128e0ed1516b7a083e2232e54",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 2686536,
"upload_time": "2024-05-28T23:54:56",
"upload_time_iso_8601": "2024-05-28T23:54:56.502412Z",
"url": "https://files.pythonhosted.org/packages/9e/fa/2d3c210d97c13ac0cfc9d2c6ce7fd4aa36793da02c4beb625b05c0fbd832/socketsecurity-0.0.70.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-28 23:54:56",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "socketsecurity"
}
JSON