How google/zx works
zx is a JavaScript/TypeScript shell-scripting runtime: users write scripts with a tagged command API, and can run them through a CLI that accepts local, stdin, or remote scripts. The main runtime wraps process execution, streams, and shell command construction; the package also provides convenience helpers, CLI dependency installation, Markdown scripts, and a REPL. The graph reflects the sampled calls and imports plus README capabilities; unsampled implementation details are represented only where their paths are supported.
Main entry points: core.ts Process promises · cli.ts CLI runner · goods.ts Script utilities · index.ts Public API
Components 19
User entrypoints
- CLI runner
src/cli.ts - Script input
- Markdown transform
src/md.ts - Interactive REPL
src/repl.ts - Dependency installer
src/deps.ts
Process runtime
- Public API
src/index.ts - Process promises
src/core.ts - Spawn adapter
src/vendor-core.ts - Logging
src/log.ts - Process errors
src/error.ts
Script helpers
- Script utilities
src/goods.ts - Markdown utilities
src/md.ts - Optional dependencies
src/vendor-extra.ts
Runtime internals
- Platform adapters
src/vendor-core.ts - Shared utilities
src/util.ts - Override registry
src/internals.ts - Version metadata
src/versions.ts
Other components
- Script author
- Shell process
Connections 26
- Script author → CLI runner: runs scripts
README.md - Script author → Public API: writes commands
README.md - Script input → CLI runner: supplies input
src/cli.ts - CLI runner → Markdown transform: transforms Markdown
src/cli.ts - CLI runner → Interactive REPL: starts REPL
src/cli.ts - CLI runner → Dependency installer: installs dependencies
src/cli.ts - CLI runner → Public API: imports runtime API
src/cli.ts - Public API → Process promises: exports process API
src/index.ts - Process promises → Spawn adapter: builds commands
src/core.ts - Spawn adapter → Shell process: executes commands
README.md - Process promises → Logging: emits log events
src/core.ts - Process promises → Process errors: raises failures
src/core.ts - Process promises → Shared utilities: uses utilities
src/core.ts - Script utilities → Process promises: uses command API
src/goods.ts - Script utilities → Shared utilities: uses helpers
src/goods.ts - Script utilities → Optional dependencies: uses fetch and parsing
src/goods.ts - Markdown utilities → Shared utilities: uses helpers
src/md.ts - Dependency installer → Optional dependencies: resolves dependencies
src/deps.ts - Dependency installer → Process promises: runs installer command
src/deps.ts - Optional dependencies → Override registry: registers overrides
src/vendor-extra.ts - Platform adapters → Override registry: registers adapters
src/vendor-core.ts - Logging → Platform adapters: uses terminal formatting
src/log.ts - Process promises → Platform adapters: uses process adapters
src/core.ts - Public API → Script utilities: exports helpers
src/index.ts - Public API → Optional dependencies: exports integrations
src/index.ts - Script utilities → Version metadata: exports versions
src/goods.ts