Skip to content

Commit 22f607f

Browse files
committed
Update commands in readme
1 parent d2edad7 commit 22f607f

File tree

1 file changed

+20
-14
lines changed

1 file changed

+20
-14
lines changed

README.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,36 +21,42 @@ socket wrapper --enable
2121

2222
## Commands
2323

24-
- `socket info <package@version>` - Look up issues for a package.
24+
### Popular Commands
25+
26+
- `socket npm [args...]` and `socket npx [args...]` - Wraps `npm` and `npx` to
27+
integrate Socket and preempt installation of alerted packages using the builtin
28+
resolution of `npm` to precisely determine package installations.
2529

2630
- `socket optimize` - Optimize dependencies with
27-
[`@socketregistry`](https://github.com/SocketDev/socket-registry) overrides
28-
_(👀 [our blog post](https://socket.dev/blog/introducing-socket-optimize)!)_
31+
[`@socketregistry`](https://github.com/SocketDev/socket-registry) overrides!
32+
_(👀 [our blog post](https://socket.dev/blog/introducing-socket-optimize))_
33+
- `--pin` - Pin overrides to their latest version.
34+
- `--prod` - Add overrides for only production dependencies.
2935

30-
- `--pin` - Pin overrides to their latest version
31-
- `--prod` - Only add overrides for production dependencies
36+
### Other Commands
3237

3338
- `socket cdxgen [command]` - Call out to [cdxgen](https://cyclonedx.github.io/cdxgen/#/?id=getting-started).
3439
See [their documentation](https://cyclonedx.github.io/cdxgen/#/CLI?id=getting-help) for commands.
3540

36-
- `socket raw-npm` and `socket raw-npx` - Temporarily disable the Socket
37-
'safe-npm' wrapper.
41+
- `socket info <package@version>` - Look up issues for a package.
42+
43+
- `socket raw-npm [args...]` and `socket raw-npx [args...]` - Temporarily disable
44+
the Socket 'safe-npm' wrapper.
3845

39-
- `socket report create <path(s)-to-folder-or-file>` - creates a report on
46+
- `socket report create <path(s)-to-folder-or-file>` - Create a report on
4047
[Socket.dev](https://socket.dev/)
4148

4249
Upload the specified `package.json` and lock files for JavaScript, Python, and
4350
Go dependency manifests. If any folder is specified, the ones found in there
4451
recursively are uploaded.
4552

46-
Supports globbing such as `**/package.json`, `**/requirements.txt`,
47-
`**/pyproject.toml`, and `**/go.mod`.
53+
Glob patterns such as `**/package.json`, `**/requirements.txt`,
54+
`**/pyproject.toml`, and `**/go.mod` is supported.
4855

49-
Ignores any file specified in your project's `.gitignore`, the
56+
Intuitively ignores files matching your project's `.gitignore`, the
5057
`projectIgnorePaths` in your project's
51-
[`socket.yml`](https://docs.socket.dev/docs/socket-yml) and on top of that has
52-
a sensible set of
53-
[default ignores](https://socket.dev/npm/package/ignore-by-default)
58+
[`socket.yml`](https://docs.socket.dev/docs/socket-yml), and a sensible set of
59+
[default ignore patterns](https://socket.dev/npm/package/ignore-by-default).
5460

5561
- `socket report view <report-id>` - Look up issues and scores from a report.
5662

0 commit comments

Comments
 (0)