Cleanup readme and commands

Author: jdalton

README.md

@@ -34,43 +34,21 @@ socket --help
 
 All aliases support the flags and arguments of the commands they alias.
 
-- `socket ci` - alias for `socket report create --view --strict` which creates a
-  report for the current directory and quits with an exit code if the result is unhealthy.
+- `socket ci` - alias for `socket scan create --report` which creates a report for the current directory and quits with an exit code if the result is unhealthy.
 
 ## Flags
 
-### Command specific flags
-
-- `--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
-
 ### 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 chat.
-
-## Strictness flags
-
-- `--all` - by default only `high` and `critical` issues are included, by
-  setting this flag all issues will be included
-- `--strict` - when set, exits with an error code if report result is deemed
-  unhealthy
+- `--json` - Outputs result as JSON which can be piped into [`jq`](https://stedolan.github.io/jq/) and other tools.
+- `--markdown` - Outputs result as Markdown which can be copied into issues, pull requests, or chats.
 
 ### Other flags
 
-- `--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
-- `--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
+- `--dry-run` - Run a command without uploading anything.
+- `--debug` - Output additional debug.
+- `--help` - Prints the help for a command.
+- `--version` - Prints the Socket CLI version.
 
 ## Configuration files
 
@@ -106,13 +84,10 @@ To run dev locally you can run these steps
 
 ```
 npm install
-npm run build:dist
+npm run build
 npm exec socket
 ```
 
-That should invoke it from local sources. If you make changes you run
-`build:dist` again.
-
 ### Environment variables for development
 
 - `DEBUG` - Enable debug logging based on the [`debug`](https://socket.dev/npm/package/debug) package.
@@ -127,12 +102,12 @@ That should invoke it from local sources. If you make changes you run
 
 ## Similar projects
 
-- [`@socketsecurity/sdk`](https://github.com/SocketDev/socket-sdk-js) - The SDK used by Socket CLI
+- [`@socketsecurity/sdk`](https://github.com/SocketDev/socket-sdk-js) - The SDK used by Socket CLI.
 
 ## See also
 
 - [Announcement blog post](https://socket.dev/blog/announcing-socket-cli-preview)
-- [Socket API Reference](https://docs.socket.dev/reference) - The API used by Socket CLI
-- [Socket GitHub App](https://github.com/apps/socket-security) - The plug-and-play GitHub App
+- [Socket API Reference](https://docs.socket.dev/reference) - The API used by Socket CLI.
+- [Socket GitHub App](https://github.com/apps/socket-security) - The plug-and-play GitHub App.
 
 [Socket.dev]: https://socket.dev/

src/commands/ci/cmd-ci.mts

@@ -19,7 +19,8 @@ const config: CliCommandConfig = {
     ...commonFlags,
     autoManifest: {
       type: 'boolean',
-      default: false, // dev tools is not likely to be set up so this is safer
+      // Dev tools in CI environments are not likely to be set up, so this is safer.
+      default: false,
       description:
         'Auto generate manifest files where detected? See autoManifest flag in `socket scan create`',
     },
@@ -32,10 +33,9 @@ const config: CliCommandConfig = {
       ${getFlagListOutput(config.flags)}
 
     This command is intended to use in CI runs to allow automated systems to
-    accept or reject a current build. When the scan does not pass your security
-    policy, the exit code will be non-zero.
-
-    It will use the default org for the Socket API token.
+    accept or reject a current build. It will use the default org of the
+    Socket API token. The exit code will be non-zero when the scan does not pass
+    your security policy.
 
     The --autoManifest flag does the same as the one from \`socket scan create\`
     but is not enabled by default since the CI is less likely to be set up with

src/commands/ci/handle-ci.mts

@@ -7,10 +7,6 @@ import { serializeResultJson } from '../../utils/serialize-result-json.mts'
 import { handleCreateNewScan } from '../scan/handle-create-new-scan.mts'
 
 export async function handleCi(autoManifest: boolean): Promise<void> {
-  // ci: {
-  //   description: 'Alias for "report create --view --strict"',
-  //     argv: ['report', 'create', '--view', '--strict']
-  // }
   const orgSlugCResult = await getDefaultOrgSlug()
   if (!orgSlugCResult.ok) {
     process.exitCode = orgSlugCResult.code ?? 1