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
Copy file name to clipboardExpand all lines: README.md
+53Lines changed: 53 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,6 +57,59 @@ After installation you should have the `socket-basics` CLI available in your env
57
57
58
58
## Quick start
59
59
60
+
Build the container image and run a scan from your current working directory mounted as `/workspace`.
61
+
62
+
1) Build the Docker image (tagged `socket-basics`):
63
+
64
+
```sh
65
+
docker build -t socket-basics .
66
+
```
67
+
68
+
2) Create a `.env` file that enables Jira + Slack and provides Socket credentials. The example below includes the required `SOCKET_ORG` and `SOCKET_SECURITY_API_KEY` variables used in this quick run (replace placeholders with real values or secrets):
3) Run the container mounting the current directory into `/workspace` and pass the CLI flags you provided. This example runs secrets scanning, JavaScript SAST, requests Socket tier1 reporting, and scans the `trickyhu/sigsci-rule-editor` container image:
91
+
92
+
```sh
93
+
docker run --rm -v "$PWD:/workspace" --env-file .env socket-basics \
94
+
--workspace /workspace \
95
+
--repo node_goat_17 \
96
+
--branch main \
97
+
--secrets \
98
+
--console-tabular-enabled \
99
+
--javascript \
100
+
--socket-org socketdev-demo \
101
+
--socket-tier1 \
102
+
--container-images \
103
+
--images trickyhu/sigsci-rule-editor
104
+
```
105
+
106
+
Notes:
107
+
- The container mounts your current project into `/workspace`, so the CLI option `--workspace /workspace` points to that path inside the container.
108
+
- The `.env` file is loaded by `--env-file` to provide credentials and notifier configuration; you can also set secrets via your environment or your CI provider.
109
+
-`SOCKET_ORG` and `SOCKET_SECURITY_API_KEY` in the example are included to show the minimum Socket-related env variables for SCA/Socket integrations. The tool also accepts `INPUT_SOCKET_ORG` / `INPUT_SOCKET_API_KEY` style env vars used elsewhere in this repo if you prefer that naming.
110
+
111
+
Quick local examples (alternate):
112
+
60
113
Run a basic scan from the repository root and print results to stdout:
0 commit comments