@socketsecurity/lib

Core utilities for Socket.dev tools: file system, processes, HTTP, env detection, logging, spinners, and more. Tree-shakeable, TypeScript-first, cross-platform.

@socketsecurity/lib is the shared utility layer for every Socket.dev tool: the CLI, SDK, registry, MCP server, and build infrastructure. It exists so we ship one battle-tested implementation of "spawn a child", "fetch JSON with retries", "delete a path safely on Windows + POSIX", etc. - rather than ten subtly different ones across the fleet. Every export is reachable via a subpath import, so tree-shaking keeps your bundle lean.

Install

pnpm add @socketsecurity/lib

Usage

import { Spinner } from '@socketsecurity/lib/spinner/spinner'
import { readJson } from '@socketsecurity/lib/fs/read-json'

const spinner = Spinner({ text: 'Loading…' })
spinner.start()
const pkg = await readJson('./package.json')
spinner.successAndStop(`Loaded ${pkg.name}@${pkg.version}`)

Every export lives under a subpath - pick what you need:

import { spawn } from '@socketsecurity/lib/process/spawn/child'
import { httpJson } from '@socketsecurity/lib/http-request'
import { safeDelete } from '@socketsecurity/lib/fs/safe'

Start with the API reference - every subpath export with a one-line description.

Development

pnpm build            # build
pnpm dev              # watch mode
pnpm install          # install before build
pnpm run cover        # tests with coverage
pnpm run fix          # auto-fix formatting
pnpm run lint         # check style
pnpm test             # run tests

See CLAUDE.md for contributor guidelines.

Documentation map

• Getting Started – install + first examples
• Visual Effects – spinners, loggers, themes
• File System – files, globs, paths, safe deletion
• HTTP Utilities – requests, downloads, retries
• Process Utilities – spawn, IPC, locks
• Package Management – npm/pnpm/yarn detection
• Environment – CI/platform detection, env getters
• Constants – Node versions, npm URLs, platform values
• Examples – real-world patterns
• Troubleshooting – common issues

License

MIT