Skip to content

defineGroup()

defineGroup() defines metadata for a command group. Place the default export of this function in a _group.ts file inside a command directory.

import { defineGroup } from "@rune-cli/rune";
export default defineGroup({
description: "Manage projects",
});
  • Type: string
  • Required

A one-line summary shown in --help output when the group is invoked.

  • Type: readonly string[]
  • Optional

Alternative names for this group. Each alias is an additional path segment that routes to this group. Aliases must follow kebab-case rules (lowercase letters, digits, and internal hyphens). The root group cannot have aliases.

  • Type: readonly string[]
  • Optional

Usage examples shown in the Examples: section of --help output. Each entry is a string representing a full command invocation.