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
Next
Commands

Application CLI

Application commands manage app lifecycle work: create or remove apps, sync generated surfaces, start local servers, build production artifacts, run typechecks and tests, package mobile apps, and manage local database helpers.
Most commands select an app from the workspace context. Options such as `--write`, `--target`, `--env`, and `--regenerate` control code generation and mobile build behavior.

create-application

Create a new app folder and register it in the workspace application set. The app name is normalized to lowercase kebab-case, and `--start` can immediately run the application after generation.
Signature
Arguments
ArgumentTypeRequiredDefaultDescription
appNameStringyes-Application name. Normalized to lowercase kebab-case.
appName
Type
String
Required
yes
Default
-
Description
Application name. Normalized to lowercase kebab-case.
Options
OptionTypeDefaultEnum / FlagDescription
--startBooleanfalse-Start application after creation.
--start
Type
Boolean
Default
false
Enum / Flag
-
Description
Start application after creation.
Examples

remove-application

Remove an existing application from the workspace. Use this when an app should no longer participate in workspace sync, builds, generated outputs, or deployment workflows.
Signature
Examples

sync

Synchronize dependency and configuration surfaces for a selected app or library. Run it after structural changes, package changes, or generated configuration changes that need to be reflected in the target system.
Signature
Examples

script

Run a custom script inside the selected application environment. The filename is optional, so the command can run the app script flow directly or target a specific script file when provided.
Signature
Arguments
ArgumentTypeRequiredDefaultDescription
filenameStringno-Script filename. Nullable.
filename
Type
String
Required
no
Default
-
Description
Script filename. Nullable.
Examples

build

Build the application for production, including frontend SSR output and backend/runtime artifacts. `--write` refreshes generated code first, while `--fast` and `--quiet` tune build speed and terminal output.
Signature
Options
OptionTypeDefaultEnum / FlagDescription
--writeBooleantrue-Write code generation before running the command.
--fastBooleanfalse-Fast build.
--quietBooleanfalse-Hide build progress output.
--write
Type
Boolean
Default
true
Enum / Flag
-
Description
Write code generation before running the command.
--fast
Type
Boolean
Default
false
Enum / Flag
-
Description
Fast build.
--quiet
Type
Boolean
Default
false
Enum / Flag
-
Description
Hide build progress output.
Notes
NameDescription
shorttrue
short
Description
true
Examples

typecheck

Run TypeScript type checking for the selected application. The command can regenerate code before checking, clear the typecheck cache with `--clean`, or reuse incremental cache with `--incremental`.
Signature
Options
OptionTypeDefaultEnum / FlagDescription
--writeBooleantrue-Write code generation before running the command.
--cleanBooleanfalse-Clear typecheck cache before running.
--incrementalBooleantrue-Reuse TypeScript incremental cache.

test

Prepare generated surfaces and run tests for the selected app, library, or package target. Keep `--write` enabled when tests depend on generated routes, stores, services, or type surfaces being current.
Signature
Options
OptionTypeDefaultEnum / FlagDescription
--writeBooleantrue-Write code generation before running the command.
--write
Type
Boolean
Default
true

build-ios

Build the iOS native project for an Akan application through Capacitor. Use `--target` to choose a mobile target, `--env` to bind the backend environment, and `--regenerate` when native project files must be recreated.
Signature
Options
OptionTypeDefaultEnum / FlagDescription
--targetString--Mobile target name or all.
--envStringdebuglocal | debug | develop | mainBackend environment.

build-android

Build the Android native project for an Akan application through Capacitor. Use `--target` for the mobile target, `--env` for the backend environment, and `--regenerate` when native project files need a fresh generation.
Signature
Options
OptionTypeDefaultEnum / FlagDescription
--targetString--Mobile target name or all.
--envStringdebuglocal | debug | develop | mainBackend environment.

start

Start the local development server for frontend SSR and backend runtime together. `--open` launches the browser after startup, and `--write` keeps generated application surfaces current before serving.
Signature
Options
OptionTypeDefaultEnum / FlagDescription
--openBooleanfalse-Open web browser.
--writeBooleantrue-Write code generation before running the command.

start-ios

Start the iOS app on a simulator or connected device. `--release` switches the mobile operation mode to release, while `--open`, `--env`, and `--target` control simulator launch and target environment.
Signature
Options
OptionTypeDefaultEnum / FlagDescription
--targetString--Mobile target name or all.
--envStringlocallocal | debug | develop | mainBackend environment.

start-android

Start the Android app on an emulator or connected device. The command mirrors the iOS start flow, with environment selection, release mode, emulator opening, code generation, and native regeneration controls.
Signature
Options
OptionTypeDefaultEnum / FlagDescription
--targetString--Mobile target name or all.
--envStringlocallocal | debug | develop | mainBackend environment.

release-ios

Build and package the iOS app for App Store release workflows. The command defaults to the `main` backend environment and requires explicit `--allowLocalRelease` if a local release environment must be allowed.
Signature
Options
OptionTypeDefaultEnum / FlagDescription
--targetString--Mobile target name or all.
--envStringmaindebug | develop | main | localBackend environment.

release-android

Build and package the Android app for Play Store release workflows. `--assembleType` selects APK or AAB output, while environment, target, regeneration, and local-release options control the release artifact.
Signature
Options
OptionTypeDefaultEnum / FlagDescription
--assembleTypeStringapkapk | aabAndroid artifact type.
--targetString--Mobile target name or all.

release-source

Release application source code for mobile OTA-oriented update workflows. Use build number, environment, rebuild, and local flags to describe the source release payload sent through the update process.
Signature
Options
OptionTypeDefaultEnum / FlagDescription
--rebuildBooleanfalse-Rebuild before release source.
--buildNumNumber0-Build number.

codepush

Deploy an over-the-air update for the selected mobile application. The command prompts for the target OS (`ios` or `android`) before running the OTA deployment flow.
Signature
Notes
NameDescription
interactivePrompts for os: ios or android.
interactive
Description
Prompts for os: ios or android.
Examples

dbup

Start local database services for the selected workspace database topology. `--mode` selects single, multiple, or cluster mode so local infrastructure can match the workflow being tested.
Signature
Options
OptionTypeDefaultEnum / FlagDescription
--modeStringmultiplesingle | multiple | clusterDatabase mode.
--mode
Type
String
Default
multiple

dbdown

Stop local database services started for development or verification. Use it after local database-dependent workflows are complete to cleanly shut down the workspace database environment.
Signature
Examples

configure-app

Run the interactive application configuration flow for a selected app. Use it when app settings need to be inspected or updated through prompts rather than manual config edits.
Signature
Notes
NameDescription
interactiveRuns application configuration prompts.
interactive
Description
Runs application configuration prompts.
Examples
Application CLI
create-application
remove-application
sync
script
build
typecheck
test
build-ios
build-android
start
start-ios
start-android
release-ios
release-android
release-source
codepush
dbup
dbdown
configure-app
--write
Type
Boolean
Default
true
Enum / Flag
-
Description
Write code generation before running the command.
--clean
Type
Boolean
Default
false
Enum / Flag
-
Description
Clear typecheck cache before running.
--incremental
Type
Boolean
Default
true
Enum / Flag
-
Description
Reuse TypeScript incremental cache.
Notes
NameDescription
shorttrue
short
Description
true
Examples
Enum / Flag
-
Description
Write code generation before running the command.
Examples
--write
Boolean
true
-
Write code generation before running the command.
--regenerateBooleanfalseflag: -gDelete and regenerate native project.
--target
Type
String
Default
-
Enum / Flag
-
Description
Mobile target name or all.
--env
Type
String
Default
debug
Enum / Flag
local | debug | develop | main
Description
Backend environment.
--write
Type
Boolean
Default
true
Enum / Flag
-
Description
Write code generation before running the command.
--regenerate
Type
Boolean
Default
false
Enum / Flag
flag: -g
Description
Delete and regenerate native project.
Notes
NameDescription
shorttrue
short
Description
true
Examples
--write
Boolean
true
-
Write code generation before running the command.
--regenerateBooleanfalseflag: -gDelete and regenerate native project.
--target
Type
String
Default
-
Enum / Flag
-
Description
Mobile target name or all.
--env
Type
String
Default
debug
Enum / Flag
local | debug | develop | main
Description
Backend environment.
--write
Type
Boolean
Default
true
Enum / Flag
-
Description
Write code generation before running the command.
--regenerate
Type
Boolean
Default
false
Enum / Flag
flag: -g
Description
Delete and regenerate native project.
Notes
NameDescription
shorttrue
short
Description
true
Examples
--open
Type
Boolean
Default
false
Enum / Flag
-
Description
Open web browser.
--write
Type
Boolean
Default
true
Enum / Flag
-
Description
Write code generation before running the command.
Notes
NameDescription
shorttrue
short
Description
true
Examples
--openBooleanfalse-Open iOS simulator.
--releaseBooleanfalse-Release mode.
--writeBooleantrue-Write code generation before running the command.
--regenerateBooleanfalseflag: -gDelete and regenerate native project.
--target
Type
String
Default
-
Enum / Flag
-
Description
Mobile target name or all.
--env
Type
String
Default
local
Enum / Flag
local | debug | develop | main
Description
Backend environment.
--open
Type
Boolean
Default
false
Enum / Flag
-
Description
Open iOS simulator.
--release
Type
Boolean
Default
false
Enum / Flag
-
Description
Release mode.
--write
Type
Boolean
Default
true
Enum / Flag
-
Description
Write code generation before running the command.
--regenerate
Type
Boolean
Default
false
Enum / Flag
flag: -g
Description
Delete and regenerate native project.
Notes
NameDescription
shorttrue
operationrelease when --release is true, otherwise local
short
Description
true
operation
Description
release when --release is true, otherwise local
Examples
--releaseBooleanfalse-Release mode.
--openBooleanfalse-Open android simulator.
--writeBooleantrue-Write code generation before running the command.
--regenerateBooleanfalseflag: -gDelete and regenerate native project.
--target
Type
String
Default
-
Enum / Flag
-
Description
Mobile target name or all.
--env
Type
String
Default
local
Enum / Flag
local | debug | develop | main
Description
Backend environment.
--release
Type
Boolean
Default
false
Enum / Flag
-
Description
Release mode.
--open
Type
Boolean
Default
false
Enum / Flag
-
Description
Open android simulator.
--write
Type
Boolean
Default
true
Enum / Flag
-
Description
Write code generation before running the command.
--regenerate
Type
Boolean
Default
false
Enum / Flag
flag: -g
Description
Delete and regenerate native project.
Notes
NameDescription
shorttrue
operationrelease when --release is true, otherwise local
short
Description
true
operation
Description
release when --release is true, otherwise local
Examples
--writeBooleantrue-Write code generation before running the command.
--regenerateBooleanfalseflag: -gDelete and regenerate native project.
--allowLocalReleaseBooleanfalseflag: -lAllow release with --env local.
--target
Type
String
Default
-
Enum / Flag
-
Description
Mobile target name or all.
--env
Type
String
Default
main
Enum / Flag
debug | develop | main | local
Description
Backend environment.
--write
Type
Boolean
Default
true
Enum / Flag
-
Description
Write code generation before running the command.
--regenerate
Type
Boolean
Default
false
Enum / Flag
flag: -g
Description
Delete and regenerate native project.
--allowLocalRelease
Type
Boolean
Default
false
Enum / Flag
flag: -l
Description
Allow release with --env local.
Examples
--envStringmaindebug | develop | main | localBackend environment.
--writeBooleantrue-Write code generation before running the command.
--regenerateBooleanfalseflag: -gDelete and regenerate native project.
--allowLocalReleaseBooleanfalseflag: -lAllow release with --env local.
--assembleType
Type
String
Default
apk
Enum / Flag
apk | aab
Description
Android artifact type.
--target
Type
String
Default
-
Enum / Flag
-
Description
Mobile target name or all.
--env
Type
String
Default
main
Enum / Flag
debug | develop | main | local
Description
Backend environment.
--write
Type
Boolean
Default
true
Enum / Flag
-
Description
Write code generation before running the command.
--regenerate
Type
Boolean
Default
false
Enum / Flag
flag: -g
Description
Delete and regenerate native project.
--allowLocalRelease
Type
Boolean
Default
false
Enum / Flag
flag: -l
Description
Allow release with --env local.
Examples
--environmentStringdebug-Environment.
--localBooleantrue-Local mode.
--rebuild
Type
Boolean
Default
false
Enum / Flag
-
Description
Rebuild before release source.
--buildNum
Type
Number
Default
0
Enum / Flag
-
Description
Build number.
--environment
Type
String
Default
debug
Enum / Flag
-
Description
Environment.
--local
Type
Boolean
Default
true
Enum / Flag
-
Description
Local mode.
Examples
Enum / Flag
single | multiple | cluster
Description
Database mode.
Examples