Skip to content

Commit 41ee796

Browse files
author
Pelle Wessman
committed
Extend README
1 parent ac8174f commit 41ee796

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,26 @@
11
# Socket CLI
22

3+
[![npm version](https://img.shields.io/npm/v/@socketsecurity/cli.svg?style=flat)](https://www.npmjs.com/package/@socketsecurity/cli)
4+
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/SocketDev/eslint-config)
5+
[![Follow @SocketSecurity](https://img.shields.io/twitter/follow/SocketSecurity?style=social)](https://twitter.com/SocketSecurity)
6+
7+
CLI tool for [Socket.dev](https://socket.dev/)
8+
9+
## Usage
10+
11+
```bash
12+
npm install -g @socketsecurity/cli
13+
```
14+
15+
```bash
16+
socket --help
17+
socket info [email protected]
18+
socket report create package.json
19+
```
20+
321
## Commands
422

23+
* `info <package@version>` - looks up issues for a package
524
* `report create` - creates a report
625

726
## Environment variables
@@ -12,3 +31,9 @@
1231

1332
* `SOCKET_SECURITY_API_BASE_URL` - if set, this will be the base for all API-calls. Defaults to `https://api.socket.dev/v0/`
1433
* `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
34+
35+
## See also
36+
37+
* [`@socketsecurity/sdk`]('https://github.com/SocketDev/socket-sdk-js") - the SDK used in this CLI
38+
* [Socket API Reference](https://docs.socket.dev/reference) - the API used in this CLI
39+
* [Socket GitHub App](https://github.com/apps/socket-security) - the plug-and-play GitHub App

0 commit comments

Comments
 (0)