CLI for Socket.dev security analysis. For user documentation, see the socket package on npm.
- Node.js 25.8.1+ (see
.node-version) - pnpm 10.22+ (see
packageManagerinpackage.json)
git clone https://github.com/SocketDev/socket-cli.git
cd socket-cli
pnpm install
pnpm run build# Run the built CLI node packages/cli/dist/index.js --help # Or use watch mode during development pnpm dev
# Run all tests pnpm test # Run unit tests for a specific file pnpm --filter @socketsecurity/cli run test:unit src/commands/scan/cmd-scan.test.mts # Run with pattern matching pnpm --filter @socketsecurity/cli run test:unit src/commands/scan/cmd-scan.test.mts -t "pattern"
pnpm run check # Run lint + typecheck pnpm run fix # Auto-fix linting and formatting
socket-cli/
├── packages/
│ ├── cli/ # Main CLI package (@socketsecurity/cli)
│ │ ├── src/
│ │ │ ├── commands/ # Command implementations
│ │ │ ├── utils/ # Shared utilities
│ │ │ └── cli.mts # Entry point
│ │ └── dist/ # Built output
│ ├── build-infra/ # Build system and tooling
│ └── package-builder/ # Package generation templates
├── scripts/ # Monorepo scripts
└── test/ # Shared test utilities
| Command | Description |
|---|---|
pnpm run build |
Smart build (skips unchanged) |
pnpm run build --force |
Force rebuild everything |
pnpm run build:cli |
Build CLI package only |
pnpm run build:sea |
Build SEA binaries |
pnpm dev |
Watch mode (auto-rebuild) |
pnpm test |
Run all tests |
pnpm testu |
Update test snapshots |
pnpm run check |
Lint + typecheck |
pnpm run fix |
Auto-fix issues |
SOCKET_CLI_DEBUG=1 node packages/cli/dist/index.js <command>
Key variables for development:
| Variable | Description |
|---|---|
SOCKET_CLI_DEBUG |
Enable debug logging (1) |
SOCKET_CLI_API_TOKEN |
Socket API token |
SOCKET_CLI_ORG_SLUG |
Socket organization slug |
SOCKET_CLI_API_BASE_URL |
Override API endpoint |
SOCKET_CLI_NO_API_TOKEN |
Disable default API token |
docs/build-guide.md— build pipeline, SEA binaries, cache managementdocs/bundle-tools.md— how bundled tools (opengrep, trivy, etc.) are integratedpackages/cli/README.md— CLI package architecturepackages/build-infra/README.md— shared build toolingpackages/package-builder/README.md— template-based package generation
