Vyriy

create-vyriy

Create package entrypoint for starting Vyriy projects from package managers.

Purpose

This package is the package-manager-facing create entrypoint that delegates to the Vyriy generator.

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 -D create-vyriy

With Yarn:

yarn add -D create-vyriy

Usage

import { createVyriy } from 'create-vyriy';

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

console.info(result);

Public API

The package is expected to expose the following main surface:

  • createVyriy
  • createVyriySync
  • type CreateVyriyOptions

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 'create-vyriy';

console.info(module);

Use inside a Vyriy package

// packages/example/index.ts
export { default as example } from 'create-vyriy';

Keep the boundary explicit

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

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.