vyriy

Main Vyriy CLI package for creating and operating calm projects.

Purpose

Use this package when a Vyriy project needs a small focused module for vyriy behavior.

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 vyriy

With Yarn:

yarn add -D vyriy

Usage

npm install -g vyriy
vyriy create
vyriy doctor

Public API

The package is expected to expose the following main surface:

• vyriy CLI
• create command
• doctor command
• preset commands

Parameters and options

• project name — Name of the generated workspace.
• preset — Selected project type.
• target directory — Output directory.
• doctor — Checks local Node/Yarn/tooling expectations.
• dry-run — Shows generated file plan without writing.

Examples

Minimal usage

import * as module from 'vyriy';

console.info(module);

Use inside a Vyriy package

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

Keep the boundary explicit

// Prefer importing from the package root unless a documented subpath is required.
import {} from /* named export */ '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.