Print flags in kebab case

jdalton · jdalton · commit 7beb847baf30 · 2025-08-06T16:51:51.000-04:00
diff --git a/src/commands/audit-log/cmd-audit-log.test.mts b/src/commands/audit-log/cmd-audit-log.test.mts
@@ -44,7 +44,7 @@ describe('socket audit-log', async () => {
             --markdown        Output result as markdown
             --org             Force override the organization slug, overrides the default org from config
             --page            Result page to fetch
-            --perPage         Results per page - default is 30
+            --per-page        Results per page - default is 30
 
           Examples
             $ socket audit-log
diff --git a/src/commands/ci/cmd-ci.test.mts b/src/commands/ci/cmd-ci.test.mts
@@ -20,13 +20,12 @@ describe('socket ci', async () => {
             $ socket ci [options]
 
           Options
-            --autoManifest    Auto generate manifest files where detected? See autoManifest flag in \`socket scan create\`
+            --auto-manifest   Auto generate manifest files where detected? See autoManifest flag in \`socket scan create\`
 
           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
diff --git a/src/commands/cli.test.mts b/src/commands/cli.test.mts
@@ -54,12 +54,14 @@ describe('socket root command', async () => {
           uninstall                 Remove Socket CLI tab completion from your system
           wrapper                   Enable or disable the Socket npm/npx wrapper
 
-        Options       (Note: all CLI commands have these flags even when not displayed in their help)
-
-          --config                 Allows you to temp overrides the internal CLI config
-          --dryRun                 Do input validation for a sub-command and then exit
-          --help                   Give you detailed help information about any sub-command
-          --version                Show version of CLI
+        Options       (Note: All CLI commands have these flags even when not displayed in their help)
+
+          --config                 Override the local config with this JSON
+          --dry-run                Do input validation for a command and exit 0 when input is ok
+          --help                   Print this help
+          --max-old-space-size     Set the max memory size of V8's old memory section in megabytes
+          --max-semi-space-size    Set the maximum semi-space size for V8's scavenge garbage collector in megabytes
+          --version                Print the app version
 
         Examples
           $ socket --help
diff --git a/src/commands/fix/cmd-fix.test.mts b/src/commands/fix/cmd-fix.test.mts
@@ -20,14 +20,14 @@ describe('socket fix', async () => {
             $ socket fix [options] [CWD=.]
 
           Options
-            --autoMerge       Enable auto-merge for pull requests that Socket opens.
+            --auto-merge      Enable auto-merge for pull requests that Socket opens.
                               See GitHub documentation (\\u200bhttps://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository\\u200b) for managing auto-merge for pull requests in your repository.
             --autopilot       Shorthand for --autoMerge --test
             --limit           The number of fixes to attempt at a time (default 10)
-            --minSatisfying   Constrain dependency updates to the minimum satisfying version
+            --min-satisfying  Constrain dependency updates to the minimum satisfying version
             --purl            Provide a list of PURLs (\\u200bhttps://github.com/package-url/purl-spec?tab=readme-ov-file#purl\\u200b) to compute fixes for, as either a comma separated value or as
                               multiple flags, instead of querying the Socket API
-            --rangeStyle      Define how dependency version ranges are updated in package.json (default 'preserve').
+            --range-style     Define how dependency version ranges are updated in package.json (default 'preserve').
                               Available styles:
                                 * caret - Use ^ range for compatible updates (e.g. ^1.2.3)
                                 * gt - Use > to allow any newer version (e.g. >1.2.3)
@@ -38,7 +38,7 @@ describe('socket fix', async () => {
                                 * preserve - Retain the existing version range style as-is
                                 * tilde - Use ~ range for patch/minor updates (e.g. ~1.2.3)
             --test            Verify the fix by running unit tests
-            --testScript      The test script to run for fix attempts (default 'test')
+            --test-script     The test script to run for fix attempts (default 'test')
 
           Examples
             $ socket fix
diff --git a/src/commands/login/attempt-login.mts b/src/commands/login/attempt-login.mts
@@ -31,7 +31,7 @@ export async function attemptLogin(
     message: `Enter your ${terminalLink(
       'Socket.dev API token',
       'https://docs.socket.dev/docs/api-keys',
-    )} (leave blank for a public key)`,
+    )} (leave blank to use a limited public token)`,
   })
 
   if (apiTokenInput === undefined) {
diff --git a/src/commands/login/cmd-login.test.mts b/src/commands/login/cmd-login.test.mts
@@ -25,8 +25,8 @@ describe('socket login', async () => {
           Logs into the Socket API by prompting for an API token
 
           Options
-            --apiBaseUrl      API server to connect to for login
-            --apiProxy        Proxy to use when making connection to API server
+            --api-base-url    API server to connect to for login
+            --api-proxy       Proxy to use when making connection to API server
 
           Examples
             $ socket login
diff --git a/src/commands/manifest/cmd-manifest-gradle.test.mts b/src/commands/manifest/cmd-manifest-gradle.test.mts
@@ -21,7 +21,7 @@ describe('socket manifest gradle', async () => {
 
           Options
             --bin             Location of gradlew binary to use, default: CWD/gradlew
-            --gradleOpts      Additional options to pass on to ./gradlew, see \`./gradlew --help\`
+            --gradle-opts     Additional options to pass on to ./gradlew, see \`./gradlew --help\`
             --verbose         Print debug messages
 
           Uses gradle, preferably through your local project \`gradlew\`, to generate a
diff --git a/src/commands/manifest/cmd-manifest-kotlin.test.mts b/src/commands/manifest/cmd-manifest-kotlin.test.mts
@@ -21,7 +21,7 @@ describe('socket manifest kotlin', async () => {
 
           Options
             --bin             Location of gradlew binary to use, default: CWD/gradlew
-            --gradleOpts      Additional options to pass on to ./gradlew, see \`./gradlew --help\`
+            --gradle-opts     Additional options to pass on to ./gradlew, see \`./gradlew --help\`
             --verbose         Print debug messages
 
           Uses gradle, preferably through your local project \`gradlew\`, to generate a
diff --git a/src/commands/manifest/cmd-manifest-scala.test.mts b/src/commands/manifest/cmd-manifest-scala.test.mts
@@ -22,7 +22,7 @@ describe('socket manifest scala', async () => {
           Options
             --bin             Location of sbt binary to use
             --out             Path of output file; where to store the resulting manifest, see also --stdout
-            --sbtOpts         Additional options to pass on to sbt, as per \`sbt --help\`
+            --sbt-opts        Additional options to pass on to sbt, as per \`sbt --help\`
             --stdout          Print resulting pom.xml to stdout (supersedes --out)
             --verbose         Print debug messages
 
diff --git a/src/commands/manifest/cmd-manifest-setup.test.mts b/src/commands/manifest/cmd-manifest-setup.test.mts
@@ -20,7 +20,7 @@ describe('socket manifest setup', async () => {
             $ socket manifest setup [CWD=.]
 
           Options
-            --defaultOnReadErrorIf reading the socket.json fails, just use a default config? Warning: This might override the existing json file!
+            --default-on-read-error If reading the socket.json fails, just use a default config? Warning: This might override the existing json file!
 
           This command will try to detect all supported ecosystems in given CWD. Then
           it starts a configurator where you can setup default values for certain flags
diff --git a/src/commands/repository/cmd-repository-create.test.mts b/src/commands/repository/cmd-repository-create.test.mts
@@ -26,13 +26,13 @@ describe('socket repository create', async () => {
           The REPO name should be a "slug". Follows the same naming convention as GitHub.
 
           Options
-            --defaultBranch   Repository default branch. Defaults to "main"
+            --default-branch  Repository default branch. Defaults to "main"
             --homepage        Repository url
             --interactive     Allow for interactive elements, asking for input. Use --no-interactive to prevent any input questions, defaulting them to cancel/no.
             --json            Output result as json
             --markdown        Output result as markdown
             --org             Force override the organization slug, overrides the default org from config
-            --repoDescription Repository description
+            --repo-description Repository description
             --visibility      Repository visibility (Default Private)
 
           Examples
diff --git a/src/commands/repository/cmd-repository-list.test.mts b/src/commands/repository/cmd-repository-list.test.mts
@@ -33,7 +33,7 @@ describe('socket repository list', async () => {
             --markdown        Output result as markdown
             --org             Force override the organization slug, overrides the default org from config
             --page            Page number
-            --perPage         Number of results per page
+            --per-page        Number of results per page
             --sort            Sorting option
 
           Examples
diff --git a/src/commands/repository/cmd-repository-update.test.mts b/src/commands/repository/cmd-repository-update.test.mts
@@ -24,13 +24,13 @@ describe('socket repository update', async () => {
             - Permissions: repo:update
 
           Options
-            --defaultBranch   Repository default branch
+            --default-branch  Repository default branch
             --homepage        Repository url
             --interactive     Allow for interactive elements, asking for input. Use --no-interactive to prevent any input questions, defaulting them to cancel/no.
             --json            Output result as json
             --markdown        Output result as markdown
             --org             Force override the organization slug, overrides the default org from config
-            --repoDescription Repository description
+            --repo-description Repository description
             --visibility      Repository visibility (Default Private)
 
           Examples
diff --git a/src/commands/scan/cmd-scan-create.test.mts b/src/commands/scan/cmd-scan-create.test.mts
@@ -23,22 +23,22 @@ describe('socket scan create', async () => {
             - Permissions: full-scans:create
 
           Options
-            --autoManifest    Run \`socket manifest auto\` before collecting manifest files? This would be necessary for languages like Scala, Gradle, and Kotlin, See \`socket manifest auto --help\`.
+            --auto-manifest   Run \`socket manifest auto\` before collecting manifest files? This would be necessary for languages like Scala, Gradle, and Kotlin, See \`socket manifest auto --help\`.
             --branch          Branch name
-            --commitHash      Commit hash
-            --commitMessage   Commit message
+            --commit-hash     Commit hash
+            --commit-message  Commit message
             --committers      Committers
             --cwd             working directory, defaults to process.cwd()
-            --defaultBranch   Set the default branch of the repository to the branch of this full-scan. Should only need to be done once, for example for the "main" or "master" branch.
+            --default-branch  Set the default branch of the repository to the branch of this full-scan. Should only need to be done once, for example for the "main" or "master" branch.
             --interactive     Allow for interactive elements, asking for input. Use --no-interactive to prevent any input questions, defaulting them to cancel/no.
             --json            Output result as json
             --markdown        Output result as markdown
             --org             Force override the organization slug, overrides the default org from config
-            --pullRequest     Commit hash
-            --readOnly        Similar to --dry-run except it can read from remote, stops before it would create an actual report
+            --pull-request    Commit hash
+            --read-only       Similar to --dry-run except it can read from remote, stops before it would create an actual report
             --repo            Repository name
             --report          Wait for the scan creation to complete, then basically run \`socket scan report\` on it
-            --setAsAlertsPage When true and if this is the "default branch" then this Scan will be the one reflected on your alerts page. See help for details. Defaults to true.
+            --set-as-alerts-page When true and if this is the "default branch" then this Scan will be the one reflected on your alerts page. See help for details. Defaults to true.
             --tmp             Set the visibility (true/false) of the scan in your dashboard.
 
           Uploads the specified dependency manifest files for Go, Gradle, JavaScript,
diff --git a/src/commands/scan/cmd-scan-github.test.mts b/src/commands/scan/cmd-scan-github.test.mts
@@ -37,13 +37,13 @@ describe('socket scan github', async () => {
 
           Options
             --all             Apply for all known repos reported by the Socket API. Supersedes \`repos\`.
-            --githubApiUrl    Base URL of the GitHub API (default: https://api.github.com)
-            --githubToken     (required) GitHub token for authentication (or set GITHUB_TOKEN as an environment variable)
+            --github-api-url  Base URL of the GitHub API (default: https://api.github.com)
+            --github-token    (required) GitHub token for authentication (or set GITHUB_TOKEN as an environment variable)
             --interactive     Allow for interactive elements, asking for input. Use --no-interactive to prevent any input questions, defaulting them to cancel/no.
             --json            Output result as json
             --markdown        Output result as markdown
             --org             Force override the organization slug, overrides the default org from config
-            --orgGithub       Alternate GitHub Org if the name is different than the Socket Org
+            --org-github      Alternate GitHub Org if the name is different than the Socket Org
             --repos           List of repos to target in a comma-separated format (e.g., repo1,repo2). If not specified, the script will pull the list from Socket and ask you to pick one. Use --all to use them all.
 
           Examples
diff --git a/src/commands/scan/cmd-scan-list.test.mts b/src/commands/scan/cmd-scan-list.test.mts
@@ -30,15 +30,15 @@ describe('socket scan list', async () => {
           Options
             --branch          Filter to show only scans with this branch name
             --direction       Direction option (\`desc\` or \`asc\`) - Default is \`desc\`
-            --fromTime        From time - as a unix timestamp
+            --from-time       From time - as a unix timestamp
             --interactive     Allow for interactive elements, asking for input. Use --no-interactive to prevent any input questions, defaulting them to cancel/no.
             --json            Output result as json
             --markdown        Output result as markdown
             --org             Force override the organization slug, overrides the default org from config
             --page            Page number - Default is 1
-            --perPage         Results per page - Default is 30
+            --per-page        Results per page - Default is 30
             --sort            Sorting option (\`name\` or \`created_at\`) - default is \`created_at\`
-            --untilTime       Until time - as a unix timestamp
+            --until-time      Until time - as a unix timestamp
 
           Examples
             $ socket scan list
diff --git a/src/commands/scan/cmd-scan-report.test.mts b/src/commands/scan/cmd-scan-report.test.mts
@@ -30,7 +30,7 @@ describe('socket scan report', async () => {
             --license         Also report the license policy status. Default: false
             --markdown        Output result as markdown
             --org             Force override the organization slug, overrides the default org from config
-            --reportLevel     Which policy level alerts should be reported
+            --report-level    Which policy level alerts should be reported
             --short           Report only the healthy status
 
           When no output path is given the contents is sent to stdout.
diff --git a/src/commands/scan/cmd-scan-setup.test.mts b/src/commands/scan/cmd-scan-setup.test.mts
@@ -20,7 +20,7 @@ describe('socket scan setup', async () => {
             $ socket scan setup [options] [CWD=.]
 
           Options
-            --defaultOnReadErrorIf reading the socket.json fails, just use a default config? Warning: This might override the existing json file!
+            --default-on-read-error If reading the socket.json fails, just use a default config? Warning: This might override the existing json file!
 
           Interactive configurator to create a local json file in the target directory
           that helps to set flag defaults for \`socket scan create\`.
diff --git a/src/commands/threat-feed/cmd-threat-feed.test.mts b/src/commands/threat-feed/cmd-threat-feed.test.mts
@@ -36,7 +36,7 @@ describe('socket threat-feed', async () => {
             --markdown        Output result as markdown
             --org             Force override the organization slug, overrides the default org from config
             --page            Page token
-            --perPage         Number of items per page
+            --per-page        Number of items per page
             --pkg             Filter by this package name
             --version         Filter by this package version
 
diff --git a/src/flags.mts b/src/flags.mts
@@ -166,7 +166,7 @@ export const commonFlags: MeowFlags = {
     },
     hidden: true,
     description:
-      "Sets the max memory size of V8's old memory section in megabytes",
+      "Set the max memory size of V8's old memory section in megabytes",
   },
   maxSemiSpaceSize: {
     type: 'number',
@@ -175,7 +175,7 @@ export const commonFlags: MeowFlags = {
     },
     hidden: true,
     description:
-      "Sets the maximum semi-space size for V8's scavenge garbage collector in megabytes",
+      "Set the maximum semi-space size for V8's scavenge garbage collector in megabytes",
   },
   nobanner: {
     // I know this would be `--no-banner` but that doesn't work with cdxgen.
diff --git a/src/utils/meow-with-subcommands.mts b/src/utils/meow-with-subcommands.mts
diff --git a/src/utils/output-formatting.mts b/src/utils/output-formatting.mts
