Skip to content

Commit b16189f

Browse files
committed
Improve README organization and use pnpm in examples
1 parent d82b9f2 commit b16189f

File tree

1 file changed

+34
-11
lines changed

1 file changed

+34
-11
lines changed

README.md

Lines changed: 34 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,51 @@
88

99
CLI for [Socket.dev] security analysis
1010

11-
## Usage
11+
## Quick Start
1212

1313
```bash
14-
npm install -g socket
14+
pnpm install -g socket
1515
socket --help
1616
```
1717

18-
## Commands
19-
20-
- `socket npm [args...]` and `socket npx [args...]` - Wraps npm/npx with Socket security scanning
18+
## Core Commands
2119

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
2225
- `socket fix` - Fix CVEs in dependencies
23-
2426
- `socket optimize` - Optimize dependencies with [`@socketregistry`](https://github.com/SocketDev/socket-registry) overrides
25-
2627
- `socket cdxgen [command]` - Run [cdxgen](https://cyclonedx.github.io/cdxgen/#/?id=getting-started) for SBOM generation
2728

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+
2845
## Aliases
2946

3047
All aliases support the flags and arguments of the commands they alias.
3148

3249
- `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`
3356

3457
## Flags
3558

@@ -70,10 +93,10 @@ Supports version 2 format with `projectIgnorePaths` for excluding files from rep
7093

7194
Run locally:
7295

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
77100
```
78101

79102
### Development environment variables

0 commit comments

Comments
 (0)