features

Features

Documentation for key Commando features.

---

Core Features

• Auto-Discovery - Commands discovered from exports automatically
• Module Metadata - Customize groups with __module__ export
• Subcommand Groups - Organize commands under namespaces
• Commander Integration - Rich CLI via Commander.js

---

How Features Work Together

1. List modules in .commando/config.yml
2. Export commands from module files (auto-discovery)
3. Add __module__ to customize group name (optional)
4. Framework groups commands automatically (subcommand groups)
5. Commander parses and invokes commands (integration)

---

Example

# .commando/config.yml
modules:
  - ./website

// .commando/website.ts
export const __module__ = {
  group: 'website',
  description: 'Website deployment'
};

export const deploy: CommandoCommand = {
  description: 'Deploy website',

  defineCommand: (cmd) => {
    cmd
      .argument('<env>', 'Environment')
      .option('--dry-run', 'Preview');
  },

  execute: async (options, args, context) => {
    const env = args[0];
    console.log(`Deploying to ${env}`);
  }
};

Result: cmdo website deploy staging --dry-run

---

See Also

• docs/command-patterns.md - Quick reference for writing commands
• docs/libraries/ - CLI library reference