Skip to content

Promptrix is a TypeScript-first CLI prompt engine for building interactive terminal applications. It offers type-safe prompts, validation, and composable workflows with a minimal API. Perfect for tools needing user input with zero dependencies.

License

Notifications You must be signed in to change notification settings

anonymByte-404/promptrix

Repository files navigation

Promptrix Logo

The TypeScript-Powered CLI Prompt Engine

Early Development Notice: Promptrix is currently in active development.
npm version License

🚀 Features

  • TypeSafe: Full TypeScript support.
  • Modular: Use only what you need.
  • Cross-Platform: Works on Windows, macOS, and Linux.

📦 Installation

npm install @promptrix/core
# or
pnpm add @promptrix/core
# or
yarn add @promptrix/core

💻 Basic Usage

import { textPrompt } from '@promptrix/core'

(async () => {
  const name: string = await textPrompt({
    message: "Enter your name:",
    validate: (input: string) => input.length > 2 || "Minimum 3 characters"
  })
  console.log(`Hello, ${name}!`)
})()

📂 Packages

Package Description
@promptrix/core Base prompt engine.

📝 License

This project is licensed under the MIT License. See the LICENSE file for more details.

About

Promptrix is a TypeScript-first CLI prompt engine for building interactive terminal applications. It offers type-safe prompts, validation, and composable workflows with a minimal API. Perfect for tools needing user input with zero dependencies.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published