socket 1.0.85 → 1.0.86

package/README.md

@@ -3,7 +3,7 @@
 [![Socket Badge](https://socket.dev/api/badge/npm/package/socket)](https://socket.dev/npm/package/socket)
 [![Follow @SocketSecurity](https://img.shields.io/twitter/follow/SocketSecurity?style=social)](https://twitter.com/SocketSecurity)
 
-> CLI tool for [Socket.dev](https://socket.dev/)
+> CLI tool for [Socket.dev]
 
 ## Usage
 
@@ -15,15 +15,15 @@ socket --help
 ## Commands
 
 - `socket npm [args...]` and `socket npx [args...]` - Wraps `npm` and `npx` to
-  integrate Socket and preempt installation of alerted packages using the
-  builtin resolution of `npm` to precisely determine package installations.
+  integrate [Socket.dev] and preempt installation of alerted packages using the
+  builtin resolution of `npm` to precisely determine package installations
 
 - `socket optimize` - Optimize dependencies with
-  [`@socketregistry`](https://github.com/SocketDev/socket-registry) overrides!
+  [`@socketregistry`](https://github.com/SocketDev/socket-registry) overrides
   _(👀 [our blog post](https://socket.dev/blog/introducing-socket-optimize))_
 
-  - `--pin` - Pin overrides to their latest version.
-  - `--prod` - Add overrides for only production dependencies.
+  - `--pin` - Pin overrides to their latest version
+  - `--prod` - Add overrides for only production dependencies
 
 - `socket cdxgen [command]` - Call out to
   [cdxgen](https://cyclonedx.github.io/cdxgen/#/?id=getting-started). See
@@ -34,44 +34,23 @@ socket --help
 
 All aliases support the flags and arguments of the commands they alias.
 
-- `socket ci` - alias for `socket report create --view --strict` which creates a
-  report and quits with an exit code if the result is unhealthy. Use like eg.
-  `socket ci .` for a report for the current folder
+- `socket ci` - alias for `socket scan create --report` which creates a report for the current directory and quits with an exit code if the result is unhealthy
 
 ## Flags
 
-### Command specific flags
-
-- `--view` - when set on `socket report create` the command will immediately do
-  a `socket report view` style view of the created report, waiting for the
-  server to complete it
-
 ### Output flags
 
-- `--json` - outputs result as json which you can then pipe into
-  [`jq`](https://stedolan.github.io/jq/) and other tools
-- `--markdown` - outputs result as markdown which you can then copy into an
-  issue, PR or even chat
-
-## Strictness flags
-
-- `--all` - by default only `high` and `critical` issues are included, by
-  setting this flag all issues will be included
-- `--strict` - when set, exits with an error code if report result is deemed
-  unhealthy
+- `--json` - Outputs result as JSON which can be piped into [`jq`](https://stedolan.github.io/jq/) and other tools
+- `--markdown` - Outputs result as Markdown which can be copied into issues, pull requests, or chats
 
 ### Other flags
 
-- `--dry-run` - like all CLI tools that perform an action should have, we have a
-  dry run flag. Eg. `socket report create` supports running the command without
-  actually uploading anything
-- `--debug` - outputs additional debug output. Great for debugging, geeks and us
-  who develop. Hopefully you will never _need_ it, but it can still be fun,
-  right?
-- `--help` - prints the help for the current command. All CLI tools should have
-  this flag
-- `--version` - prints the version of the tool. All CLI tools should have this
-  flag
+- `--dry-run` - Run a command without uploading anything
+- `--debug` - Output additional debug
+- `--help` - Prints help documentation for a command
+- `--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
 
@@ -82,7 +61,19 @@ use of the `projectIgnorePaths` to excludes files when creating a report.
 
 ## Environment variables
 
-- `SOCKET_CLI_API_TOKEN` - if set, this will be used as the API-key
+- `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_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>
+  *Defaults:* `github-actions[bot]`<br>
+- `SOCKET_CLI_GITHUB_TOKEN` - A classic or fine-grained [GitHub personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) with the "repo" scope or read/write permissions set for "Contents" and "Pull Request"<br>
+  *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
 
 ## Contributing
 
@@ -92,30 +83,28 @@ To run dev locally you can run these steps
 
 ```
 npm install
-npm run build:dist
+npm run build
 npm exec socket
 ```
 
-That should invoke it from local sources. If you make changes you run
-`build:dist` again.
-
 ### Environment variables for development
 
-- `SOCKET_CLI_API_BASE_URL` - if set, this will be the base for all
-  API-calls. Defaults to `https://api.socket.dev/v0/`
-- `SOCKET_CLI_API_PROXY` - if set to something like
-  [`http://127.0.0.1:9090`](https://docs.proxyman.io/troubleshooting/couldnt-see-any-requests-from-3rd-party-network-libraries),
-  then all request will be proxied through that proxy
+- `SOCKET_CLI_API_BASE_URL` - Change the base URL for all 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>
+  *Aliases:* `HTTPS_PROXY`, `https_proxy`, `HTTP_PROXY`, and `http_proxy`<br>
+- `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 in this CLI
+- [`@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 in
-  this CLI
-- [Socket GitHub App](https://github.com/apps/socket-security) - the
-  plug-and-play GitHub App
+- [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
+
+[Socket.dev]: https://socket.dev/