image
Akan.js
English
DocsConventionsReferencesCheatsheet
image
Akan.js
Akan.js v2 docs are now available.View the v1 docs
DocsConventionsReferencesCheatsheet
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
Commands
Next
Application

Workspace CLI

Workspace commands create a new Akan.js workspace and keep the whole repository synchronized. Use them when you are starting a project, fixing generated surfaces, or applying lint across apps and libraries.
The commands below come from `workspace.command.ts`: `create-workspace`, `lint`, `lint-all`, and `sync-all`.

create-workspace

Create a new Akan.js workspace and optionally bootstrap the first application in the same step. The command normalizes names to lowercase kebab-case and uses the selected update tag, install-lib choice, and initialization flag to prepare the repository.
Signature
Arguments
ArgumentTypeRequiredDefaultDescription
workspaceNameStringyes-Organization/workspace name. Normalized to lowercase kebab-case.
workspaceName
Type
String
Required
yes
Default
-
Description
Organization/workspace name. Normalized to lowercase kebab-case.
Options
OptionTypeDefaultEnum / FlagDescription
--appString--Codename of the first application. Normalized to lowercase kebab-case.
--dirStringlocal when USE_AKANJS_PKGS=true, otherwise .-Directory where the workspace is created.
--libsBoolean-false | trueInstall shared and util libraries.
--tagStringlatestlatest | dev | canary | beta | rc | alphaAkan.js update tag used while creating the workspace.
--initBooleantrue-Initialize the workspace after creation.
--app
Type
String
Default
-
Enum / Flag
-
Description
Codename of the first application. Normalized to lowercase kebab-case.
--dir
Type
String
Default
local when USE_AKANJS_PKGS=true, otherwise .
Enum / Flag
-
Description
Directory where the workspace is created.
--libs
Type
Boolean
Default
-
Enum / Flag
false | true
Description
Install shared and util libraries.
--tag
Type
String
Default
latest
Enum / Flag
latest | dev | canary | beta | rc | alpha
Description
Akan.js update tag used while creating the workspace.
--init
Type
Boolean
Default
true
Enum / Flag
-
Description
Initialize the workspace after creation.
Notes
NameDescription
runsOnWorkspaceRootfalse
scriptworkspaceScript.createWorkspace(workspaceName, app, { dirname, installLibs, tag, init })
runsOnWorkspaceRoot
Description
false
script
Description
workspaceScript.createWorkspace(workspaceName, app, { dirname, installLibs, tag, init })
Examples

lint

Run lint and formatting for a selected app, library, or package target. `--fix` defaults to true, so the command applies formatter/linter fixes unless the option is explicitly disabled.
Signature
Options
OptionTypeDefaultEnum / FlagDescription
--fixBooleantrue-Apply formatter/lint fixes.
--fix
Type
Boolean
Default
true
Enum / Flag
-
Description
Apply formatter/lint fixes.
Examples

lint-all

Run lint and formatting across the workspace instead of a single selected target. Use it before broader verification when generated surfaces, app code, and shared libraries should be checked together.
Signature
Options
OptionTypeDefaultEnum / FlagDescription
--fixBooleantrue-Apply formatter/lint fixes.
--fix
Type
Boolean
Default
true
Enum / Flag
-
Description
Apply formatter/lint fixes.
Examples

sync-all

Refresh dependency and configuration surfaces for every app and library in the workspace. Use it when generated configuration looks stale or after changes that affect shared workspace setup.
Signature
Examples
Workspace CLI
create-workspace
lint
lint-all
sync-all