Skip to content

Commit 71f7a46

Browse files
author
Pelle Wessman
committed
Update README to mention new features
1 parent 71fd817 commit 71f7a46

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,21 @@ npm install -g @socketsecurity/cli
1515
```bash
1616
socket --help
1717
socket info [email protected]
18-
socket report create package.json
18+
socket report create package.json --view
19+
socket report view QXU8PmK7LfH608RAwfIKdbcHgwEd_ZeWJ9QEGv05FJUQ
1920
```
2021

2122
## Commands
2223

2324
* `socket info <package@version>` - looks up issues for a package
24-
* `socket report create` - uploads the specified `package.json` and/or `package-lock.json` to create a report on [socket.dev](https://socket.dev/). If only one of a `package.json`/`package-lock.json` has been specified, the other will be automatically found and uploaded if it exists
25+
* `socket report create <path(s)-to-folder-or-file>` - uploads the specified `package.json` and/or `package-lock.json` to create a report on [socket.dev](https://socket.dev/). If only one of a `package.json`/`package-lock.json` has been specified, the other will be automatically found and uploaded if it exists
26+
* `socket report view <report-id>` - looks up issues and scores from a report
2527

2628
## Flags
2729

28-
### Action flags
30+
### Command specific flags
2931

30-
* `--dry-run` - the `socket report create` supports running the command without actually uploading anything. All CLI tools that perform an action should have a dry run flag
32+
* `--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
3133

3234
### Output flags
3335

@@ -36,6 +38,7 @@ socket report create package.json
3638

3739
### Other flags
3840

41+
* `--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
3942
* `--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?
4043
* `--help` - prints the help for the current command. All CLI tools should have this flag
4144
* `--version` - prints the version of the tool. All CLI tools should have this flag
@@ -45,6 +48,7 @@ socket report create package.json
4548
* `SOCKET_SECURITY_API_KEY` - if set, this will be used as the API-key
4649

4750
## Contributing
51+
4852
### Environment variables for development
4953

5054
* `SOCKET_SECURITY_API_BASE_URL` - if set, this will be the base for all API-calls. Defaults to `https://api.socket.dev/v0/`

0 commit comments

Comments
 (0)