Skip to main content

Add & Update CLI

The kue add command generates new project components (modules, workflows, features, solutions, and transitions), while kue update regenerates the module metadata cache after you make changes to your modules.

Installation​

Install the kue CLI tool globally (the CLI lives in its own repository at github.com/kuetix/kue):

git clone https://github.com/kuetix/kue
cd kue && make install

Commands​

kue update​

Update (regenerate) the module metadata cache before compilation:

kue update [options]

Options:
  --verbose, -v    Verbose mode
  --quiet, -q      Quiet mode

Example:

# Run from your project root directory
cd /path/to/your/engine/project
kue update --verbose

Note: The update command must be run from your project root directory where the modules/ directory is located.

This command scans your modules/ directory for transitions and generates:

  • modules/meta.go - Metadata cache for transitions
  • modules/di.go - Dependency injection configuration
  • modules.json - JSON metadata for all modules

kue add​

The kue add command adds components (modules, workflows, features, solutions, or transitions) to your existing project:

kue add <subcommand> <name> [--output=<path>]

Subcommands:
  module      Add a new module with transitions
  workflow    Add a new workflow
  feature     Add a new feature
  solution    Add a new solution
  transition  Add a transition to an existing or new module

See the CLI Reference for complete kue add documentation.

Complete Workflow Example​

Here's a complete workflow from development to deployment:

# 1. Update cache for your modules
kue update --verbose

# 2. Add a new workflow
kue add workflow MyWorkflow

# 3. Add a new module
kue add module MyModule

# 4. ... develop your workflows and transitions ...

# 5. Rebuild and run your workflow
kue update
make build-cli
./runtime/bin/myapp-cli workflows/common/MyWorkflow.wsl

See Also​