|
8 | 8 |
|
9 | 9 | CLI for [Socket.dev] security analysis |
10 | 10 |
|
11 | | -## Usage |
| 11 | +## Quick Start |
12 | 12 |
|
13 | 13 | ```bash |
14 | | -npm install -g socket |
| 14 | +pnpm install -g socket |
15 | 15 | socket --help |
16 | 16 | ``` |
17 | 17 |
|
18 | | -## Commands |
19 | | - |
20 | | -- `socket npm [args...]` and `socket npx [args...]` - Wraps npm/npx with Socket security scanning |
| 18 | +## Core Commands |
21 | 19 |
|
| 20 | +- `socket npm [args...]` / `socket npx [args...]` - Wrap npm/npx with security scanning |
| 21 | +- `socket pnpm [args...]` / `socket yarn [args...]` - Wrap pnpm/yarn with security scanning |
| 22 | +- `socket pip [args...]` - Wrap pip with security scanning |
| 23 | +- `socket scan` - Create and manage security scans |
| 24 | +- `socket package <name>` - Analyze package security scores |
22 | 25 | - `socket fix` - Fix CVEs in dependencies |
23 | | - |
24 | 26 | - `socket optimize` - Optimize dependencies with [`@socketregistry`](https://github.com/SocketDev/socket-registry) overrides |
25 | | - |
26 | 27 | - `socket cdxgen [command]` - Run [cdxgen](https://cyclonedx.github.io/cdxgen/#/?id=getting-started) for SBOM generation |
27 | 28 |
|
| 29 | +## Organization & Repository Management |
| 30 | + |
| 31 | +- `socket organization` (alias: `org`) - Manage organization settings |
| 32 | +- `socket repository` (alias: `repo`) - Manage repositories |
| 33 | +- `socket dependencies` (alias: `deps`) - View organization dependencies |
| 34 | +- `socket audit-log` (alias: `audit`) - View audit logs |
| 35 | +- `socket analytics` - View organization analytics |
| 36 | +- `socket threat-feed` (alias: `feed`) - View threat intelligence |
| 37 | + |
| 38 | +## Authentication & Configuration |
| 39 | + |
| 40 | +- `socket login` - Authenticate with Socket.dev |
| 41 | +- `socket logout` - Remove authentication |
| 42 | +- `socket whoami` - Show authenticated user |
| 43 | +- `socket config` - Manage CLI configuration |
| 44 | + |
28 | 45 | ## Aliases |
29 | 46 |
|
30 | 47 | All aliases support the flags and arguments of the commands they alias. |
31 | 48 |
|
32 | 49 | - `socket ci` - Alias for `socket scan create --report` (creates report and exits with error if unhealthy) |
| 50 | +- `socket org` - Alias for `socket organization` |
| 51 | +- `socket repo` - Alias for `socket repository` |
| 52 | +- `socket pkg` - Alias for `socket package` |
| 53 | +- `socket deps` - Alias for `socket dependencies` |
| 54 | +- `socket audit` - Alias for `socket audit-log` |
| 55 | +- `socket feed` - Alias for `socket threat-feed` |
33 | 56 |
|
34 | 57 | ## Flags |
35 | 58 |
|
@@ -70,10 +93,10 @@ Supports version 2 format with `projectIgnorePaths` for excluding files from rep |
70 | 93 |
|
71 | 94 | Run locally: |
72 | 95 |
|
73 | | -``` |
74 | | -npm install |
75 | | -npm run build |
76 | | -npm exec socket |
| 96 | +```bash |
| 97 | +pnpm install |
| 98 | +pnpm run build |
| 99 | +pnpm exec socket |
77 | 100 | ``` |
78 | 101 |
|
79 | 102 | ### Development environment variables |
|
0 commit comments