@socketsecurity/cli 0.1.0 → 0.1.2

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Pelle Wessman
+Copyright (c) 2022 Socket Inc
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,14 +1,57 @@
 # Socket CLI
 
+[![npm version](https://img.shields.io/npm/v/@socketsecurity/cli.svg?style=flat)](https://www.npmjs.com/package/@socketsecurity/cli)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/SocketDev/eslint-config)
+[![Follow @SocketSecurity](https://img.shields.io/twitter/follow/SocketSecurity?style=social)](https://twitter.com/SocketSecurity)
+
+CLI tool for [Socket.dev](https://socket.dev/)
+
+## Usage
+
+```bash
+npm install -g @socketsecurity/cli
+```
+
+```bash
+socket --help
+socket info webtorrent@1.9.1
+socket report create package.json
+```
+
 ## Commands
 
-* `report create` - creates a report
+* `socket info <package@version>` - looks up issues for a package
+* `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
+
+## Flags
+
+### Action flags
+
+* `--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
+
+### Output flags
+
+* `--json` - outputs result as json which you can then pipe into [`jq`](https://stedolan.github.io/jq/) and other tools
+* `--markdown` - outputs result as markdown which you can then copy into an issue, PR or even chat
+
+### Other flags
+
+* `--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?
+* `--help` - prints the help for the current command. All CLI tools should have this flag
+* `--version` - prints the version of the tool. All CLI tools should have this flag
 
 ## Environment variables
 
 * `SOCKET_SECURITY_API_KEY` - if set, this will be used as the API-key
 
+## Contributing
 ### Environment variables for development
 
 * `SOCKET_SECURITY_API_BASE_URL` - if set, this will be the base for all API-calls. Defaults to `https://api.socket.dev/v0/`
 * `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
+
+## See also
+
+* [`@socketsecurity/sdk`]('https://github.com/SocketDev/socket-sdk-js") - the SDK used in this CLI
+* [Socket API Reference](https://docs.socket.dev/reference) - the API used in this CLI
+* [Socket GitHub App](https://github.com/apps/socket-security) - the plug-and-play GitHub App

package/lib/commands/info/index.js

@@ -78,7 +78,6 @@ const run = async (argv, importMeta, { parentName }) => {
 
   const pkgName = rawPkgName.slice(0, versionSeparator)
   const pkgVersion = rawPkgName.slice(versionSeparator + 1)
-  console.log('sdfd', pkgName, pkgVersion)
 
   if (!pkgVersion) {
     throw new InputError('Need to specify a version, like eg: webtorrent@1.0.0')

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@socketsecurity/cli",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "CLI tool for Socket.dev",
-  "homepage": "http://github.com/SocketDev/socket-commando",
+  "homepage": "http://github.com/SocketDev/socket-cli-js",
   "repository": {
     "type": "git",
-    "url": "git://github.com/SocketDev/socket-commando.git"
+    "url": "git://github.com/SocketDev/socket-cli-js.git"
   },
   "keywords": [],
   "author": {