quick-reference

Rempts Quick Reference

Essential commands and conventions for working with the Rempts CLI framework.

Key Commands

# Development
bun dev                    # Start development mode
bun test                   # Run all tests
bun run build             # Build all packages
bun run clean             # Clean artifacts

# Package-specific
cd packages/core && bun run build
cd packages/cli && bun test
cd apps/web && bun dev

File Conventions

• Naming: Always kebab-case (my-command.ts, not MyCommand.ts)
• Imports: ESM only, use .js extensions for local imports
• Tests: .test.ts suffix in test/ directories
• Exports: Prefer named exports over default

Quick File Templates

Command Definition

import { defineCommand, option } from '@reliverse/rempts'
import { z } from 'zod'

export const myCommand = defineCommand({
  name: 'my-command',
  description: 'Description',
  options: {
    input: option(
      z.string().default('default'),
      { description: 'Input value', short: 'i' }
    )
  },
  handler: async ({ flags, positional, shell, env, cwd, prompt, spinner, colors, context }) => {
    // Implementation - all utilities available
    console.log(relico.green(`Input: ${flags.input}`))
    console.log(`Args: ${positional.join(', ')}`)
    
    // Access plugin store if available
    if (context?.store.someData) {
      console.log(context.store.someData)
    }
  }
})

Test File

import { describe, it, expect } from 'bun:test'
import { testCommand } from '@reliverse/rempts-test'
import { myCommand } from './my-command.js'

describe('My Command', () => {
  it('works', async () => {
    const result = await testCommand(myCommand, {
      flags: { input: 'test' },  // Named options
      args: ['file.txt']         // Positional arguments
    })
    expect(result.exitCode).toBe(0)
    expect(result.stdout).toContain('Input: test')
  })
})

Common Imports

// Core framework
import { defineCommand, defineConfig, option, createCLI } from '@reliverse/rempts'
import { createPlugin } from '@reliverse/rempts/plugin'

// Utilities
import { colors, spinner, prompt } from '@reliverse/rempts-utils'

// Plugins
import { aiAgentPlugin } from '@reliverse/rempts-plugin-ai-detect'
import { configMergerPlugin } from '@reliverse/rempts-plugin-config'

// Testing
import { testCommand } from '@reliverse/rempts-test'