@socketsecurity/cli-with-sentry
v1.1.63TypeScript
CLI for Socket.dev, includes Sentry error handling, otherwise identical to the regular `socket` package
0/weekUpdated 3 days agoMIT AND OFL-1.1Unpacked: 21.3 MB
Published by Socket Inc
npm install @socketsecurity/cli-with-sentrySocket CLI
CLI for [Socket.dev] security analysis
Usage
``bash`
npm install -g socket
socket --help
Commands
- socket npm [args...] and socket npx [args...] - Wraps npm/npx with Socket security scanning
- socket fix - Fix CVEs in dependencies
- socket optimize - Optimize dependencies with @socketregistry overrides
- socket cdxgen [command] - Run cdxgen for SBOM generation
Aliases
All aliases support the flags and arguments of the commands they alias.
- socket ci - Alias for socket scan create --report (creates report and exits with error if unhealthy)
Flags
$3
- --json - Output as JSON--markdown
- - Output as Markdown
$3
- --dry-run - Run without uploading--debug
- - Show debug output--help
- - Show help--max-old-space-size
- - Set Node.js memory limit--max-semi-space-size
- - Set Node.js heap size--version
- - Show version
Configuration files
Socket CLI reads socket.yml configuration files.
Supports version 2 format with projectIgnorePaths for excluding files from reports.
Environment variables
- SOCKET_CLI_API_TOKEN - Socket API tokenSOCKET_CLI_CONFIG
- - JSON configuration objectSOCKET_CLI_GITHUB_API_URL
- - GitHub API base URLSOCKET_CLI_GIT_USER_EMAIL
- - Git user email (default: github-actions[bot]@users.noreply.github.com)SOCKET_CLI_GIT_USER_NAME
- - Git user name (default: github-actions[bot])SOCKET_CLI_GITHUB_TOKEN
- - GitHub token with repo access (alias: GITHUB_TOKEN)SOCKET_CLI_NO_API_TOKEN
- - Disable default API tokenSOCKET_CLI_NPM_PATH
- - Path to npm directorySOCKET_CLI_ORG_SLUG
- - Socket organization slugSOCKET_CLI_ACCEPT_RISKS
- - Accept npm/npx risksSOCKET_CLI_VIEW_ALL_RISKS
- - Show all npm/npx risks
Contributing
Run locally:
`
npm install
npm run build
npm exec socket
$3
- SOCKET_CLI_API_BASE_URL - API base URL (default: https://api.socket.dev/v0/)SOCKET_CLI_API_PROXY
- - Proxy for API requests (aliases: HTTPS_PROXY, https_proxy, HTTP_PROXY, http_proxy)SOCKET_CLI_API_TIMEOUT
- - API request timeout in millisecondsSOCKET_CLI_DEBUG
- - Enable debug loggingDEBUG
- - Enable debug package logging
See also
- Socket API Reference
- Socket GitHub App
- @socketsecurity/sdk`
[Socket.dev]: https://socket.dev/
