#CLI

Developer CLI for maltty projects. Scaffolding, building, diagnostics, and code generation.

#Installation

pnpm add -D @maltty/cli

#Commands

#maltty init

Scaffold a new maltty CLI project. Prompts for project details interactively or accepts them as flags.

maltty init
maltty init --name my-cli --pm pnpm --example

#maltty build

Bundle a maltty CLI project for production using tsdown. Optionally compile to standalone binaries via Bun.

maltty build
maltty build --compile
maltty build --targets darwin-arm64 linux-x64

Supported compile targets: darwin-arm64, darwin-x64, linux-x64, linux-arm64, linux-x64-musl, windows-x64, windows-arm64.

Build options can also be configured in maltty.config.ts:

import { defineConfig } from 'maltty/config'

export default defineConfig({
  entry: './index.ts',
  build: {
    out: './dist',
    target: 'node18',
    minify: false,
    sourcemap: true,
  },
  compile: {
    targets: ['darwin-arm64', 'linux-x64'],
    name: 'my-cli',
  },
})

#maltty dev

Start a maltty CLI project in development mode. Loads the project's maltty.config.ts, starts tsdown in watch mode, and logs rebuild status on each file change.

maltty dev

On the first successful build the spinner stops and a "watching" message is logged. Subsequent rebuilds log a success message. Build options are read from maltty.config.ts (all fields are optional — defaults apply when no config file is found).

#maltty doctor

Diagnose common project issues. Validates config, checks package.json setup, verifies entry points, and catches anything that could cause build or runtime failures.

maltty doctor
maltty doctor --fix

#maltty add command

Add a new command to an existing maltty project. Detects the project root and generates a command file in the configured commands directory.

maltty add command
maltty add command --name deploy --description "Deploy the app" --args

#maltty add middleware

Add a new middleware to an existing maltty project. Generates a middleware file in src/middleware/.

maltty add middleware
maltty add middleware --name auth --description "Require authentication"

#maltty add config

Scaffold a config schema with Zod validation and ConfigType module augmentation in an existing maltty project. Creates src/config.ts with a starter schema and wires up the declare module augmentation.

maltty add config

This generates:

// src/config.ts
import type { ConfigType } from 'maltty'
import { z } from 'zod'

export const configSchema = z.object({
  // Add your config fields here
})

declare module 'maltty' {
  interface CliConfig extends ConfigType<typeof configSchema> {}
}

#maltty commands

Display the command tree for a maltty CLI project. Scans the configured commands directory and prints an ASCII tree of all discovered commands and subcommands.

maltty commands

#maltty stories

Launch the stories viewer TUI. Discovers .stories.tsx / .stories.ts files in the project and renders a browsable tree with live preview and an interactive props editor.

maltty stories
maltty stories --include "src/components/**/*.stories.tsx"

The viewer watches for file changes and hot-reloads stories automatically. Press ? inside the viewer to see keyboard shortcuts.

#Workflows

#New project from scratch

maltty init --name my-cli --pm pnpm --example
cd my-cli
pnpm install
maltty dev

#Add features to an existing project

maltty add command --name deploy --description "Deploy the app" --args
maltty add middleware --name require-auth --description "Require authentication"
maltty add config

#Production build

maltty build
maltty build --compile --targets darwin-arm64 linux-x64

#Diagnose issues

maltty doctor
maltty doctor --fix
maltty commands

#Develop components

maltty stories
maltty stories --include "src/ui/**/*.stories.tsx"

#References

• Core
• Build a CLI
• Configuration