image
Akan.js
Docs
DocsConventionsReferencesCheatsheet
English
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
General
• Authorization
• Schema Design
• Edge Computing
• File Management
• Single Sign-On
• DataList & Enum
Interface
• CRUD
• Endpoint
• Form
Observability
• Logging
• Dependency Injection
• Error Handling
• Metrics
Performance
• Caching
• Image Optimization
• Lazy Loading
• Querying
• Queueing
• Realtime
Development
• Documentation
• Script
• Console
• Docker
• Kubernetes
• PWA
General
• Authorization
• Schema Design
• Edge Computing
• File Management
• Single Sign-On
• DataList & Enum
Interface
• CRUD
• Endpoint
• Form
Observability
• Logging
• Dependency Injection
• Error Handling
• Metrics
Performance
• Caching
• Image Optimization
• Lazy Loading
• Querying
• Queueing
• Realtime
Development
• Documentation
• Script
• Console
• Docker
• Kubernetes
• PWA
Next
Authorization

Server Console

Use the Akan server console for interactive inspection and small operator commands against an initialized app runtime.
  • `akan console` is the local development entry.
  • `console.js` is generated by `akan build` and is embedded next to `main.js` in the production dist files.
  • Do not create console files manually inside a running container or pod.

Local Console

Open a local console when you want to inspect services, call small methods, or try a quick query without writing a repeatable script file.
Run locally

Container Console

In Docker or Kubernetes, execute the generated `console.js` that already exists in the built image.
Set `AKAN_CONSOLE=1` on the exec command itself for production-like environments. Avoid keeping it permanently in deployment env.
Docker
Kubernetes

Lifecycle

  • Container console mode starts a separate no-listen server process inside the same container or pod.
  • It shares env, secrets, mounted volumes, network, and database access with the running app container.
  • It does not attach to the already-running `main.js` process or its in-memory state.
  • Console mode must keep scheduler and cron work disabled because it is a second process.

Globals

The console exposes runtime helpers and generated app exports so small commands stay short.
  • `server`, `env`: current server instance and environment.
  • `get`, `service`, `signal`, `adaptor`: lookup helpers for runtime objects.
  • `methods`, `debug`: inspect public methods and runtime registration state.
  • `srv`, `sig`, `db`, `cnst`: generated app exports.
Examples

Safety

  • Print and check the target environment before changing data.
  • Prefer service methods over direct database writes so domain rules still run.
  • For destructive work, write a script with dry-run or confirmation instead of typing many console commands by hand.
  • Keep `AKAN_CONSOLE=1` out of permanent deployment configuration.
Server Console
Local Console
Container Console
Lifecycle
Globals
Safety