Vyriy

@vyriy/script

Script runner utilities for readable deployment and automation flows.

Purpose

Use this package to make operational scripts read like a clear sequence of steps.

Vyriy packages are intentionally small. The goal is to keep the public API explicit, easy to test, and easy to compose with the rest of the Vyriy ecosystem.

Install

With npm:

npm install @vyriy/script

With Yarn:

yarn add @vyriy/script

Usage

import { script } from '@vyriy/script';

const result = await script({
  cwd: process.cwd(),
});

console.info(result);

Public API

The package is expected to expose the following main surface:

  • script
  • scriptSync
  • type ScriptOptions

Parameters and options

  • options — Configuration object for the helper.
  • signal — Optional AbortSignal for cancellation when the operation is async.
  • logger — Optional logger used by scripts/services.
  • cwd — Working directory for filesystem or process related helpers.

Examples

Minimal usage

import * as module from '@vyriy/script';

console.info(module);

Use inside a Vyriy package

// packages/example/index.ts
export { default as example } from '@vyriy/script';

Keep the boundary explicit

// Prefer importing from the package root unless a documented subpath is required.
import {} from /* named export */ '@vyriy/script';

Notes

  • Keep configuration close to the package that owns it.
  • Prefer explicit options over hidden global state.
  • Keep examples small enough to copy into tests or Storybook docs.
  • When adding a new public export, document it in this README and add a focused test.

Related packages

  • @vyriy/config for environment-driven options.
  • @vyriy/script for readable operational flows.
  • @vyriy/handler and @vyriy/server when the package participates in runtime handling.