You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-`socket info <package@version>` - looks up issues for a package
27
27
28
-
-`socket report create <path(s)-to-folder-or-file>` - creates a report on [socket.dev](https://socket.dev/)
28
+
-`socket report create <path(s)-to-folder-or-file>` - creates a report on
29
+
[socket.dev](https://socket.dev/)
29
30
30
-
Uploads the specified `package.json` and lock files for JavaScript, Python, and Go dependency manifests.
31
-
If any folder is specified, the ones found in there recursively are uploaded.
31
+
Uploads the specified `package.json` and lock files for JavaScript, Python,
32
+
and Go dependency manifests. If any folder is specified, the ones found in
33
+
there recursively are uploaded.
32
34
33
-
Supports globbing such as `**/package.json`, `**/requirements.txt`, `**/pyproject.toml`, and `**/go.mod`.
35
+
Supports globbing such as `**/package.json`, `**/requirements.txt`,
36
+
`**/pyproject.toml`, and `**/go.mod`.
34
37
35
-
Ignores any file specified in your project's `.gitignore`, the `projectIgnorePaths` in your project's [`socket.yml`](https://docs.socket.dev/docs/socket-yml) and on top of that has a sensible set of [default ignores](https://www.npmjs.com/package/ignore-by-default)
38
+
Ignores any file specified in your project's `.gitignore`, the
39
+
`projectIgnorePaths` in your project's
40
+
[`socket.yml`](https://docs.socket.dev/docs/socket-yml) and on top of that has
-`socket report view <report-id>` - looks up issues and scores from a report
38
45
39
-
-`socket wrapper --enable` and `socket wrapper --disable` - Enables and disables the Socket 'safe-npm' wrapper.
46
+
-`socket wrapper --enable` and `socket wrapper --disable` - Enables and
47
+
disables the Socket 'safe-npm' wrapper.
40
48
41
-
-`socket raw-npm` and `socket raw-npx` - Temporarily disables the Socket 'safe-npm' wrapper.
49
+
-`socket raw-npm` and `socket raw-npx` - Temporarily disables the Socket
50
+
'safe-npm' wrapper.
42
51
43
52
## Aliases
44
53
45
54
All aliases supports flags and arguments of the commands they alias.
46
55
47
-
-`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
56
+
-`socket ci` - alias for `socket report create --view --strict` which creates a
57
+
report and quits with an exit code if the result is unhealthy. Use like eg.
58
+
`socket ci .` for a report for the current folder
48
59
49
60
## Flags
50
61
51
62
### Command specific flags
52
63
53
-
-`--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
64
+
-`--view` - when set on `socket report create` the command will immediately do
65
+
a `socket report view` style view of the created report, waiting for the
66
+
server to complete it
54
67
55
68
### Output flags
56
69
57
-
-`--json` - outputs result as json which you can then pipe into [`jq`](https://stedolan.github.io/jq/) and other tools
58
-
-`--markdown` - outputs result as markdown which you can then copy into an issue, PR or even chat
70
+
-`--json` - outputs result as json which you can then pipe into
71
+
[`jq`](https://stedolan.github.io/jq/) and other tools
72
+
-`--markdown` - outputs result as markdown which you can then copy into an
73
+
issue, PR or even chat
59
74
60
75
## Strictness flags
61
76
62
-
-`--all` - by default only `high` and `critical` issues are included, by setting this flag all issues will be included
63
-
-`--strict` - when set, exits with an error code if report result is deemed unhealthy
77
+
-`--all` - by default only `high` and `critical` issues are included, by
78
+
setting this flag all issues will be included
79
+
-`--strict` - when set, exits with an error code if report result is deemed
80
+
unhealthy
64
81
65
82
### Other flags
66
83
67
-
-`--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
68
-
-`--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?
69
-
-`--help` - prints the help for the current command. All CLI tools should have this flag
70
-
-`--version` - prints the version of the tool. All CLI tools should have this flag
84
+
-`--dry-run` - like all CLI tools that perform an action should have, we have a
85
+
dry run flag. Eg. `socket report create` supports running the command without
86
+
actually uploading anything
87
+
-`--debug` - outputs additional debug output. Great for debugging, geeks and us
88
+
who develop. Hopefully you will never _need_ it, but it can still be fun,
89
+
right?
90
+
-`--help` - prints the help for the current command. All CLI tools should have
91
+
this flag
92
+
-`--version` - prints the version of the tool. All CLI tools should have this
93
+
flag
71
94
72
95
## Configuration files
73
96
74
-
The 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.
97
+
The CLI reads and uses data from a
98
+
[`socket.yml` file](https://docs.socket.dev/docs/socket-yml) in the folder you
99
+
run it in. It supports the version 2 of the `socket.yml` file format and makes
100
+
use of the `projectIgnorePaths` to excludes files when creating a report.
75
101
76
102
## Environment variables
77
103
@@ -81,15 +107,21 @@ The CLI reads and uses data from a [`socket.yml` file](https://docs.socket.dev/d
81
107
82
108
### Environment variables for development
83
109
84
-
-`SOCKET_SECURITY_API_BASE_URL` - if set, this will be the base for all API-calls. Defaults to `https://api.socket.dev/v0/`
85
-
-`SOCKET_SECURITY_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
110
+
-`SOCKET_SECURITY_API_BASE_URL` - if set, this will be the base for all
111
+
API-calls. Defaults to `https://api.socket.dev/v0/`
112
+
-`SOCKET_SECURITY_API_PROXY` - if set to something like
0 commit comments