@socketsecurity/cli v0.15.61
Socket CLI
CLI tool for Socket.dev
Usage
npm install -g socket
socket --help
Commands
socket npm [args...]
andsocket npx [args...]
- Wrapsnpm
andnpx
to integrate Socket and preempt installation of alerted packages using the builtin resolution ofnpm
to precisely determine package installations.socket optimize
- Optimize dependencies with@socketregistry
overrides! (👀 our blog post)--pin
- Pin overrides to their latest version.--prod
- Add overrides for only production dependencies.
socket cdxgen [command]
- Call out to cdxgen. See their documentation for commands.
Aliases
All aliases support the flags and arguments of the commands they alias.
socket ci
- alias forsocket 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
Flags
Command specific flags
--view
- when set onsocket report create
the command will immediately do asocket 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 intojq
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 onlyhigh
andcritical
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
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
Configuration files
The CLI reads and uses data from a
socket.yml
file 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_API_TOKEN
- if set, this will be used as the API-key
Contributing
Setup
To run dev locally you can run these steps
npm install
npm run build:dist
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 tohttps://api.socket.dev/v0/
SOCKET_CLI_API_PROXY
- if set to something likehttp://127.0.0.1:9090
, then all request will be proxied through that proxy
Similar projects
@socketsecurity/sdk
- the SDK used in this CLI
See also
- Announcement blog post
- Socket API Reference - the API used in this CLI
- Socket GitHub App - the plug-and-play GitHub App
5 months ago
5 months ago
5 months ago
5 months ago
4 months ago
4 months ago
3 months ago
5 months ago
2 months ago
5 months ago
5 months ago
5 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
3 months ago
6 months ago
3 months ago
6 months ago
6 months ago
6 months ago
3 months ago
6 months ago
3 months ago
6 months ago
3 months ago
6 months ago
3 months ago
3 months ago
4 months ago
3 months ago
4 months ago
3 months ago
4 months ago
3 months ago
4 months ago
3 months ago
3 months ago
4 months ago
3 months ago
3 months ago
3 months ago
4 months ago
6 months ago
3 months ago
6 months ago
4 months ago
4 months ago
3 months ago
4 months ago
3 months ago
4 months ago
3 months ago
4 months ago
3 months ago
5 months ago
3 months ago
5 months ago
5 months ago
3 months ago
6 months ago
3 months ago
5 months ago
3 months ago
5 months ago
3 months ago
5 months ago
3 months ago
5 months ago
6 months ago
4 months ago
4 months ago
4 months ago
4 months ago
3 months ago
3 months ago
4 months ago
3 months ago
4 months ago
5 months ago
4 months ago
4 months ago
4 months ago
4 months ago
3 months ago
5 months ago
3 months ago
5 months ago
3 months ago
5 months ago
3 months ago
5 months ago
3 months ago
5 months ago
3 months ago
5 months ago
3 months ago
5 months ago
3 months ago
5 months ago
5 months ago
5 months ago
3 months ago
3 months ago
3 months ago
5 months ago
3 months ago
5 months ago
3 months ago
5 months ago
3 months ago
5 months ago
3 months ago
3 months ago
5 months ago
3 months ago
5 months ago
3 months ago
5 months ago
5 months ago
3 months ago
5 months ago
5 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
3 months ago
4 months ago
4 months ago
4 months ago
4 months ago
10 months ago
10 months ago
10 months ago
10 months ago
9 months ago
9 months ago
10 months ago
10 months ago
9 months ago
9 months ago
9 months ago
8 months ago
8 months ago
9 months ago
9 months ago
8 months ago
8 months ago
8 months ago
8 months ago
7 months ago
3 months ago
7 months ago
7 months ago
3 months ago
6 months ago
3 months ago
6 months ago
3 months ago
6 months ago
3 months ago
7 months ago
3 months ago
3 months ago
6 months ago
3 months ago
6 months ago
3 months ago
6 months ago
3 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
11 months ago
1 year ago
1 year ago
12 months ago
1 year ago
12 months ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago