@qodly/cli

Command-line interface for creating and managing Qodly custom component projects.

Installation

npm install -g @qodly/cli

Or using bun:

bun install -g @qodly/cli

Usage

qodly <command> [options]

Commands

| Command | Alias | Description | | ---------- | -------------------------- | -------------------------------------------------------- | | init | | Initialize a new custom component project | | project | | Initialize a new Qodly project | | generate | g, new, create, gen| Generate a new component | | build | b | Build the project | | migrate | m | Migrate a project to the latest CLI version | | doc | d | Generate documentation for the current project | | version | -v, --version | Show the CLI version | | help | | Show help information |

Examples

Create a new project

qodly init

Generate a new component

qodly generate
# or
qodly g

Build the project

qodly build
# or
qodly b

Generate documentation

qodly doc
# or with custom input/output
qodly doc -f "src/**/*.tsx" -o "docs/api.mdx"

Check CLI version

qodly version
# or
qodly -v

Development

Prerequisites

• Bun (recommended) or Node.js

Setup

bun install

Scripts

| Script | Description | | -------------- | ------------------------------------ | | bun run build| Build the CLI | | bun run lint | Run linter | | bun run format | Format code | | bun run check| Run all checks (lint + format) |

License

ISC