#cli()

Bootstrap and run a CLI application. Registers commands, parses arguments, loads config, runs middleware, and invokes the matched handler.

Import from maltty.

import { cli } from 'maltty'

cli({
  name: 'my-app',
  version: '1.0.0',
  description: 'My CLI tool',
  commands: { deploy, migrate },
  middleware: [timing],
  help: {
    header: 'my-app - deploy and migrate with ease',
    footer: 'Docs: https://my-app.dev',
  },
  dirs: { local: '.my-app', global: '.my-app' },
})

#CliOptions

#CliHelpOptions

header only appears when the bare invocation has nothing to run. Registering a default command makes the bare invocation dispatch to that handler instead, so header is never shown.

#DirsConfig

Overrides directory names for file-backed stores (auth credentials, config). Both default to .<name> when omitted.

#Commands option

The commands field accepts several forms:

Autoload registers an index file at the root of the directory as the default command rather than as a command named index.

#defineConfig()

Helper for defining a maltty.config.ts file with type checking:

import { defineConfig } from 'maltty/config'

export default defineConfig({
  build: { out: 'dist' },
})

#Module augmentation

Extend maltty's interfaces via TypeScript declaration merging for project-wide type safety:

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

export const configSchema = z.object({
  apiUrl: z.string().url(),
  org: z.string().min(1),
})

declare module 'maltty' {
  interface MalttyArgs {
    verbose: boolean
  }
  interface MalttyStore {
    token: string
  }
}

declare module 'maltty/config' {
  interface ConfigRegistry extends ConfigType<typeof configSchema> {}
}

#Sub-exports

#References

• command()
• middleware()
• screen()
• Configuration
• Lifecycle