Module CLI

Module commands create and maintain domain modules inside an app or library. Use them when adding a new model-backed feature or adding common UI companion files to an existing module.

Module names are normalized with lower-case first-letter style after spaces are removed, matching Akan module file conventions.

create-module

Create a new domain module template inside an app or library. The generator creates the standard Akan module files and can additionally create route-level page files when `--page` is enabled.

Signature

Arguments

Argument	Type	Required	Default	Description
moduleName	String	yes	-	Module name. Spaces are removed and the first letter is lowercased.

moduleName

Type

String

Required

yes

Default

Description

Module name. Spaces are removed and the first letter is lowercased.

Options

Option	Type	Default	Enum / Flag	Description
--page	Boolean	false	-	Create page files with the module.

--page

Type

Boolean

Default

false

Enum / Flag

Description

Create page files with the module.

Examples

remove-module

Remove an existing module from an app or library. Use this when the module's domain definitions, generated connections, and UI companion files should be removed from the target system.

Signature

Examples

create-view

Create a full View component for an existing module. Use it when the module needs a detail-oriented or rich page-level UI surface beyond generated data definitions.

Signature

Examples

create-unit

Create a Unit component for rendering repeated module items. Use it for list rows, cards, or compact displays that consume light module data in application UI.

Signature

Examples

create-template

Create a Template component for module forms and editing UI. Use it when the module needs reusable form structure connected to standard store/form workflows.

Signature

Examples

Module CLI

Module commands create and maintain domain modules inside an app or library. Use them when adding a new model-backed feature or adding common UI companion files to an existing module.

Module names are normalized with lower-case first-letter style after spaces are removed, matching Akan module file conventions.

create-module

Create a new domain module template inside an app or library. The generator creates the standard Akan module files and can additionally create route-level page files when `--page` is enabled.

Signature

Arguments

Argument	Type	Required	Default	Description
moduleName	String	yes	-	Module name. Spaces are removed and the first letter is lowercased.

moduleName

Type

String

Required

yes

Default

Description

Module name. Spaces are removed and the first letter is lowercased.

Options

Option	Type	Default	Enum / Flag	Description
--page	Boolean	false	-	Create page files with the module.

--page

Type

Boolean

Default

false

Enum / Flag

Description

Create page files with the module.

Examples

remove-module

Remove an existing module from an app or library. Use this when the module's domain definitions, generated connections, and UI companion files should be removed from the target system.

Signature

Examples

create-view

Create a full View component for an existing module. Use it when the module needs a detail-oriented or rich page-level UI surface beyond generated data definitions.

Signature

Examples

create-unit

Create a Unit component for rendering repeated module items. Use it for list rows, cards, or compact displays that consume light module data in application UI.

Signature

Examples

create-template

Create a Template component for module forms and editing UI. Use it when the module needs reusable form structure connected to standard store/form workflows.

Signature

Examples