image
Akan.js
English
DocsConventionsReferencesCheatsheet
image
Akan.js
Released under the MIT License
Official Akan.js Consulting onAkansoft
Copyright © 2026 Akan.js All rights reserved.
System managed bybassman
CLI Reference
• Commands
• Workspace
• Application
• Library
• Module
• Scalar
• Package
• Page
• Cloud
AkanJS Reference
• akanjs/base
• akanjs/common
• akanjs/constant
• akanjs/fetch
• akanjs/signal
• akanjs/server
• akanjs/client
• akanjs/webkit
UI Reference
• Overview
• Core
• Display
• Forms
• Overlays
• System
CLI Reference
• Commands
• Workspace
• Application
• Library
• Module
• Scalar
• Package
• Page
• Cloud
AkanJS Reference
• akanjs/base
• akanjs/common
• akanjs/constant
• akanjs/fetch
• akanjs/signal
• akanjs/server
• akanjs/client
• akanjs/webkit
UI Reference
• Overview
• Core
• Display
• Forms
• Overlays
• System
Previous
Module
Next
Package

Scalar CLI

Scalar commands create and remove scalar types inside an app or library. A scalar is a reusable data type or value object, not a database-backed document model.
The scalar name is normalized after spaces are removed, matching Akan scalar file conventions.

create-scalar

Create a new scalar type for reusable value objects or simple data shapes that do not need DB persistence. The generator normalizes the scalar name and creates the scalar files used by constants, documents, dictionaries, and typed business code.
Signature
Arguments
ArgumentTypeRequiredDefaultDescription
scalarNameStringyes-Scalar name. Spaces are removed and the first letter is lowercased.
scalarName
Type
String
Required
yes
Default
-
Description
Scalar name. Spaces are removed and the first letter is lowercased.
Options
OptionTypeDefaultEnum / FlagDescription
--aiBooleanfalse-Use AI to create scalar before normal scalar creation.
--ai
Type
Boolean
Default
false
Enum / Flag
-
Description
Use AI to create scalar before normal scalar creation.
Notes
NameDescription
executionWhen --ai is true, createScalarWithAi runs before createScalar.
execution
Description
When --ai is true, createScalarWithAi runs before createScalar.
Examples

remove-scalar

Remove an existing scalar type from an app or library. Use it after checking usages, because scalar definitions are often imported by modules, dictionaries, templates, and service payload types.
Signature
Arguments
ArgumentTypeRequiredDefaultDescription
scalarNameStringyes-Scalar name to remove.
scalarName
Type
String
Required
yes
Default
-
Description
Scalar name to remove.
Examples
Scalar CLI
create-scalar
remove-scalar