socket 1.0.86 → 1.0.88

package/README.md

@@ -47,23 +47,23 @@ All aliases support the flags and arguments of the commands they alias.
 
 - `--dry-run` - Run a command without uploading anything
 - `--debug` - Output additional debug
-- `--help` - Prints help documentation for a command
+- `--help` - Prints help documentation
 - `--max-old-space-size` - Set Node's V8 [`--max-old-space-size`](https://nodejs.org/api/cli.html#--max-old-space-sizesize-in-mib) option
 - `--max-semi-space-size` - Set Node's V8 [`--max-semi-space-size`](https://nodejs.org/api/cli.html#--max-semi-space-sizesize-in-mib) option
 - `--version` - Prints the Socket CLI version
 
 ## Configuration files
 
-The CLI reads and uses data from a
+Socket CLI reads and uses data from a
 [`socket.yml` file](https://docs.socket.dev/docs/socket-yml) in the folder you
 run it in. It supports the version 2 of the `socket.yml` file format and makes
 use of the `projectIgnorePaths` to excludes files when creating a report.
 
 ## Environment variables
 
-- `SOCKET_CLI_ACCEPT_RISKS` - Accept risks of a safe-npm or safe-npx run
 - `SOCKET_CLI_API_TOKEN` - Set the Socket API token
 - `SOCKET_CLI_CONFIG` - A JSON stringified Socket configuration object
+- `SOCKET_CLI_GITHUB_API_URL` - Change the base URL for GitHub REST API calls
 - `SOCKET_CLI_GIT_USER_EMAIL` - The git config `user.email` used by Socket CLI<br>
   *Defaults:* `github-actions[bot]@users.noreply.github.com`<br>
 - `SOCKET_CLI_GIT_USER_NAME` - The git config `user.name` used by Socket CLI<br>
@@ -72,14 +72,15 @@ use of the `projectIgnorePaths` to excludes files when creating a report.
   *Aliases:* `GITHUB_TOKEN`<br>
 - `SOCKET_CLI_NO_API_TOKEN` - Make the default API token `undefined`
 - `SOCKET_CLI_NPM_PATH` - The absolute location of the npm directory
-- `SOCKET_CLI_ORG_SLUG` - Specify the Socket organization slug
-- `SOCKET_CLI_VIEW_ALL_RISKS` - View all risks of a safe-npm or safe-npx run
+- `SOCKET_CLI_ORG_SLUG` - Specify the Socket organization slug<br><br>
+- `SOCKET_CLI_ACCEPT_RISKS` - Accept risks of a Socket wrapped npm/npx run
+- `SOCKET_CLI_VIEW_ALL_RISKS` - View all risks of a Socket wrapped npm/npx run
 
 ## Contributing
 
 ### Setup
 
-To run dev locally you can run these steps
+To run locally execute the following commands:
 
 ```
 npm install
@@ -89,7 +90,7 @@ npm exec socket
 
 ### Environment variables for development
 
-- `SOCKET_CLI_API_BASE_URL` - Change the base URL for all API-calls<br>
+- `SOCKET_CLI_API_BASE_URL` - Change the base URL for Socket API calls<br>
   *Defaults:* The "apiBaseUrl" value of socket/settings local app data if present, else `https://api.socket.dev/v0/`<br>
 - `SOCKET_CLI_API_PROXY` - Set the proxy all requests are routed through, e.g. if set to<br>
   [`http://127.0.0.1:9090`](https://docs.proxyman.io/troubleshooting/couldnt-see-any-requests-from-3rd-party-network-libraries), then all request are passed through that proxy<br>
@@ -97,14 +98,11 @@ npm exec socket
 - `SOCKET_CLI_DEBUG` - Enable debug logging in Socket CLI
 - `DEBUG` - Enable debug logging based on the [`debug`](https://socket.dev/npm/package/debug) package
 
-## Similar projects
-
-- [`@socketsecurity/sdk`](https://github.com/SocketDev/socket-sdk-js) - The SDK used by Socket CLI
-
 ## See also
 
 - [Announcement blog post](https://socket.dev/blog/announcing-socket-cli-preview)
 - [Socket API Reference](https://docs.socket.dev/reference) - The API used by Socket CLI
 - [Socket GitHub App](https://github.com/apps/socket-security) - The plug-and-play GitHub App
+- [`@socketsecurity/sdk`](https://github.com/SocketDev/socket-sdk-js) - The SDK used by Socket CLI
 
 [Socket.dev]: https://socket.dev/