kqgen

May 29, 2025 ยท View on GitHub

A fast and flexible CLI for generating Angular components and services. Includes presets for tables, filters and for REST/GraphQL services.


๐Ÿš€ Installation

Global

npm install -g kqgen
# or
pnpm add -g kqgen
# or
bun add -g kqgen

Temporary usage (without global install)

npx kqgen <command> ...

โšก๏ธ Basic Usage

kqgen <command> <full/path/to/name> [options]

Examples

kqgen ng:component dashboard/home/user
kqgen ng:component shared/avatar --bare
kqgen ng:component dashboard/products --type=table
kqgen ng:component shared/quick-search --type=filter
kqgen ng:component shared/user-form --type=add-dialog
kqgen ng:service auth shared/services --rest
kqgen ng:service product shared/services --gql
kqgen init

๐ŸŽ›๏ธ Component Presets and Types

  • --type=table, -t, -tt Table component (Angular Material, paginator & sort)
  • --type=filter, -tf Standalone filter component
  • --type=add-dialog, -tad Form in Angular Material dialog
  • --bare, -b, -B Only the base file (no services/models/interfaces folders)
  • If no --type is provided, the default preset is used

๐Ÿšฆ Service Options

  • --rest, -r REST service
  • --gql, -g GraphQL service (with base queries)
  • --none, -n Empty service (structure only)

(If not specified, a prompt will be shown)


๐ŸŽจ Global Customization

Edit gen.config.js in your project root to change colors and styles for generated components:

// gen.config.js
export default {
  theme: {
    primaryColor: "#377bc8",
    secondaryColor: "#7c3aed",
    borderRadius: "8px",
  },
};

You can quickly generate this config with:

kqgen init

๐Ÿ“ Notes

  • All commands generate files inside src/app/ by default (unless run from another subfolder).
  • If no type is specified for service or component, an interactive prompt appears.
  • Use kqgen help, kqgen --help or kqgen -h to display help.
  • Works on Linux, Mac, and Windows.
  • Inspired by the speed and flexibility of modern code generators.

๐Ÿค Contributions

Pull requests, feature ideas, and issues are welcome at KilloconQ. Want new presets? Request or contribute them!