Support the SOCKET_CLI_ORG_SLUG env var

Author: jdalton

src/commands/ci/fetch-default-org-slug.mts

@@ -1,5 +1,6 @@
 import { debugFn } from '@socketsecurity/registry/lib/debug'
 
+import constants from '../../constants.mts'
 import { getConfigValueOrUndef } from '../../utils/config.mts'
 import { fetchOrganization } from '../organization/fetch-organization-list.mts'
 
@@ -13,6 +14,13 @@ export async function getDefaultOrgSlug(): Promise<CResult<string>> {
     return { ok: true, data: defaultOrgResult }
   }
 
+  // Lazily access constants.ENV.SOCKET_CLI_ORG_SLUG.
+  const envOrgSlug = constants.ENV.SOCKET_CLI_ORG_SLUG
+  if (envOrgSlug) {
+    debugFn('notice', 'use: org from environment variable', envOrgSlug)
+    return { ok: true, data: envOrgSlug }
+  }
+
   const orgsCResult = await fetchOrganization()
   if (!orgsCResult.ok) {
     return orgsCResult

src/commands/fix/cmd-fix.mts

@@ -188,8 +188,9 @@ async function run(
   const orgSlugCResult = await getDefaultOrgSlug()
   if (!orgSlugCResult.ok) {
     process.exitCode = orgSlugCResult.code ?? 1
-    // Always assume json mode.
-    // logger.log(serializeResultJson(orgSlugCResult))
+    logger.fail(
+      'Unable to resolve a Socket account organization.\nEnsure a Socket API token is specified for the organization using the SOCKET_CLI_API_TOKEN environment variable.',
+    )
     return
   }
 

src/constants.mts

@@ -79,6 +79,7 @@ type ENV = Remap<
       SOCKET_CLI_GIT_USER_NAME: string
       SOCKET_CLI_GITHUB_TOKEN: string
       SOCKET_CLI_NO_API_TOKEN: boolean
+      SOCKET_CLI_ORG_SLUG: string
       SOCKET_CLI_VIEW_ALL_RISKS: boolean
       TERM: string
       XDG_DATA_HOME: string
@@ -248,7 +249,7 @@ const LAZY_ENV = () => {
     __proto__: null,
     // Lazily access registryConstants.ENV.
     ...registryConstants.ENV,
-    // Flag to disable using GitHub's workflow actions/cache.
+    // Variable to disable using GitHub's workflow actions/cache.
     // https://github.com/actions/cache
     DISABLE_GITHUB_CACHE: envAsBoolean(env['DISABLE_GITHUB_CACHE']),
     // The API URL. For example, https://api.github.com.
@@ -329,7 +330,7 @@ const LAZY_ENV = () => {
     // non-roaming application data, like temporary files, cached data, and program
     // settings, that are specific to the current machine and user.
     LOCALAPPDATA: envAsString(env[LOCALAPPDATA]),
-    // Flag to enable the module compile cache for the Node.js instance.
+    // Variable to enable the module compile cache for the Node.js instance.
     // https://nodejs.org/api/cli.html#node_compile_cachedir
     NODE_COMPILE_CACHE:
       // Lazily access constants.SUPPORTS_NODE_COMPILE_CACHE_ENV_VAR.
@@ -350,16 +351,16 @@ const LAZY_ENV = () => {
     // programs are located. When a command is run, the system searches these
     // directories to find the executable.
     PATH: envAsString(env['PATH']),
-    // Flag to accepts risks of safe-npm and safe-npx run.
+    // Variable to accepts risks of safe-npm and safe-npx run.
     SOCKET_CLI_ACCEPT_RISKS: envAsBoolean(env[SOCKET_CLI_ACCEPT_RISKS]),
-    // Flag to change the base URL for all API-calls.
+    // Variable to change the base URL for all API-calls.
     // https://github.com/SocketDev/socket-cli?tab=readme-ov-file#environment-variables-for-development
     SOCKET_CLI_API_BASE_URL:
       envAsString(env['SOCKET_CLI_API_BASE_URL']) ||
       envAsString(env['SOCKET_SECURITY_API_BASE_URL']) ||
       getConfigValueOrUndef('apiBaseUrl') ||
       'https://api.socket.dev/v0/',
-    // Flag to set the proxy all requests are routed through.
+    // Variable to set the proxy all requests are routed through.
     // https://github.com/SocketDev/socket-cli?tab=readme-ov-file#environment-variables-for-development
     SOCKET_CLI_API_PROXY:
       envAsString(env['SOCKET_CLI_API_PROXY']) ||
@@ -370,16 +371,16 @@ const LAZY_ENV = () => {
       envAsString(env['https_proxy']) ||
       envAsString(env['HTTP_PROXY']) ||
       envAsString(env['http_proxy']),
-    // Flag to set the API token.
+    // Variable to set the Socket API token.
     // https://github.com/SocketDev/socket-cli?tab=readme-ov-file#environment-variables
     SOCKET_CLI_API_TOKEN:
       envAsString(env['SOCKET_CLI_API_TOKEN']) ||
       envAsString(env['SOCKET_CLI_API_KEY']) ||
       envAsString(env['SOCKET_SECURITY_API_TOKEN']) ||
       envAsString(env['SOCKET_SECURITY_API_KEY']),
-    // Flag containing a JSON stringified Socket configuration object.
+    // Variable containing a JSON stringified Socket configuration object.
     SOCKET_CLI_CONFIG: envAsString(env['SOCKET_CLI_CONFIG']),
-    // Flag to help debug Socket CLI.
+    // Variable to help debug Socket CLI.
     SOCKET_CLI_DEBUG: envAsBoolean(env['SOCKET_CLI_DEBUG']),
     // The git config user.email used by Socket CLI.
     SOCKET_CLI_GIT_USER_EMAIL:
@@ -398,9 +399,14 @@ const LAZY_ENV = () => {
       envAsString(env['SOCKET_CLI_GITHUB_TOKEN']) ||
       envAsString(env['SOCKET_SECURITY_GITHUB_PAT']) ||
       GITHUB_TOKEN,
-    // Flag to make the default API token `undefined`.
+    // Variable to make the default API token `undefined`.
     SOCKET_CLI_NO_API_TOKEN: envAsBoolean(env['SOCKET_CLI_NO_API_TOKEN']),
-    // Flag to view all risks of safe-npm and safe-npx run.
+    // Variable to specify the Socket organization slug.
+    SOCKET_CLI_ORG_SLUG:
+      envAsString(env['SOCKET_CLI_ORG_SLUG']) ||
+      // Coana CLI accepts the SOCKET_ORG_SLUG environment variable.
+      envAsString(env['SOCKET_ORG_SLUG']),
+    // Variable to view all risks of safe-npm and safe-npx run.
     SOCKET_CLI_VIEW_ALL_RISKS: envAsBoolean(env[SOCKET_CLI_VIEW_ALL_RISKS]),
     // Specifies the type of terminal or terminal emulator being used by the process.
     TERM: envAsString(env['TERM']),