Quick Start

curl -fsSL https://raw.githubusercontent.com/SocketDev/socket-cli/main/install.sh| bash

pnpm install -g socketsocket --help

Core Commands

Organization & Repository Management

Authentication & Configuration

Aliases

Flags

Output flags

Other flags

Configuration files

Environment variables

Contributing

git clone https://github.com/SocketDev/socket-cli.gitcd socket-clipnpm installpnpm run buildpnpmexec socket --version

Building locally

Quick start (easiest)

# Build only what changed (recommended for development)pnpm run build

============================================================Socket CLI Build System============================================================→ Yoga WASM: skipped (up to date)→ CLI Package: building...✓ CLI Package: built (12.3s)→ SEA Binary: building...✓ SEA Binary: built (45.1s)============================================================Build Summary============================================================Built:    2Skipped:  1Total:    57.4s✓ Build completed successfully

Force rebuild

# Force rebuild all packagespnpm run build --force

Single target builds

# Build only CLI packagepnpm run build --target cli# Build SEA binarypnpm run build --target sea# Build specific platform binary (combined syntax)pnpm run build --target darwin-arm64# Build specific platform binary (separate flags - matches node-sea-builder)pnpm run build --platform darwin --arch arm64

Multiple target builds

# Build multiple specific targets sequentiallypnpm run build --targets cli,sea,darwin-arm64# Build multiple targets in parallel (faster)pnpm run build --targets cli,sea,darwin-arm64 --parallel

Platform binaries

# Build all platforms sequentially (safer for limited resources)pnpm run build --platforms# Build all platforms in parallel (much faster, requires more CPU/RAM)pnpm run build --platforms --parallel

Advanced: Direct package builds

# Build ONNX Runtime WASM (for AI features)pnpm --filter @socketsecurity/onnxruntime run build# Build Yoga WASM (for terminal layouts)pnpm --filter @socketsecurity/yoga run build# Build CLI package (TypeScript + bundling)pnpm --filter @socketsecurity/cli run build# Build SEA binary (Node.js Single Executable)pnpm --filter @socketbin/node-sea-builder-builder run build

All build options

pnpm run build --help

Development environment variables

Debug logging categories

DEBUG=cache socket scan# Cache debugging onlyDEBUG=network,cache socket scan# Multiple categoriesDEBUG=* socket scan# All categoriesSOCKET_CLI_DEBUG=1 socket scan# Default categories

Developer API

Progress indicators

import{startSpinner,updateSpinnerProgress}from'./src/utils/spinner.mts'conststop=startSpinner('Processing files')for(leti=0;i<files.length;i++){updateSpinnerProgress(i+1,files.length,'files')awaitprocessFile(files[i])}stop()// Output: ⠋ Processing files ████████████░░░░░░░░ 60% (12/20 files)

Table formatting

import{formatTable,formatSimpleTable}from'./src/utils/output-formatting.mts'importcolorsfrom'yoctocolors-cjs'// Bordered table with box-drawing charactersconstdata=[{name:'lodash',version:'4.17.21',issues:0},{name:'react',version:'18.2.0',issues:2}]constcolumns=[{key:'name',header:'Package'},{key:'version',header:'Version',align:'center'},{key:'issues',header:'Issues',align:'right',color:(v)=>v==='0' ?colors.green(v) :colors.red(v)}]console.log(formatTable(data,columns))// Output:// ┌─────────┬─────────┬────────┐// │ Package │ Version │ Issues │// ├─────────┼─────────┼────────┤// │ lodash  │ 4.17.21 │      0 │// │ react   │ 18.2.0  │      2 │// └─────────┴─────────┴────────┘// Simple table without bordersconsole.log(formatSimpleTable(data,columns))// Output:// Package  Version  Issues// ───────  ───────  ──────// lodash   4.17.21       0// react    18.2.0        2

Performance monitoring

import{perfTimer,measure,perfCheckpoint,printPerformanceSummary}from'./src/utils/performance.mts'// Simple operation timingconststop=perfTimer('fetch-packages')awaitfetchPackages()stop({count:50})// Function measurementconst{ result, duration}=awaitmeasure('parse-manifest',async()=>{returnparseManifest(file)})console.log(`Parsed in${duration}ms`)// Track complex operation progressperfCheckpoint('start-scan')perfCheckpoint('analyze-dependencies',{count:100})perfCheckpoint('detect-issues',{issueCount:5})perfCheckpoint('end-scan')// Print performance summaryprintPerformanceSummary()// Performance Summary:// fetch-packages: 1 calls, avg 234ms (min 234ms, max 234ms, total 234ms)// parse-manifest: 5 calls, avg 12ms (min 8ms, max 20ms, total 60ms)

Intelligent caching strategies

import{getCacheStrategy,getRecommendedTtl,warmCaches}from'./src/utils/cache-strategies.mts'// Get recommended TTL for an endpointconstttl=getRecommendedTtl('/npm/lodash/4.17.21/score')// Returns: 900000 (15 minutes for stable package info)// Check cache strategyconststrategy=getCacheStrategy('/scans/abc123')// Returns: { ttl: 120000, volatile: true } (2 minutes for active scans)// Warm critical caches on startupawaitwarmCaches(sdk,['/users/me','/organizations/my-org/settings'])

Enhanced error handling

import{InputError,AuthError,getRecoverySuggestions}from'./src/utils/errors.mts'// Throw errors with recovery suggestionsthrownewInputError('Invalid package name','Must be in format: @scope/name',['Use npm package naming conventions','Check for typos in the package name'])thrownewAuthError('Token expired',['Run `socket login` to re-authenticate','Generate a new token at https://socket.dev/dashboard'])// Extract and display recovery suggestionstry{awaitoperation()}catch(error){constsuggestions=getRecoverySuggestions(error)if(suggestions.length>0){console.error('How to fix:')suggestions.forEach(s=>console.error(`  -${s}`))}}

See also