Appearance

Welcome to Documentation Portal ​

Explore detailed information about codbex across two main areas, and the open libraries and standards the platform is built with:

  1. Platform: Learn about the codbex Platform and its core features, including languages, engines, artefacts, SDK, widgets, services, and templates.

  2. Tooling: Discover the tools provided by codbex in the Workbench, Git perspective, Databases perspective, Terminal perspective, Processes Workspace perspective, and more.

Feel free to click on each area to access specific documentation sections. Whether you're a developer, administrator, or user, codbex documentation provides comprehensive information to help you make the most of the platform's capabilities.

Libraries and Standards ​

Applications on the codbex platform are described as intent, run on the open-source Eclipse Dirigible runtime through a TypeScript SDK, and render with a component library. Each of these layers is open, has its own documentation site, and can be used on its own.

What it isUse it forLicense
Eclipse DirigibleOpen-source Intent-Driven Development platform, the upstream of every codbex editionThe runtime, engines, generators and Workbench everything else runs onEPL-2.0
Intent FileOpen specification for describing a whole application as intentAuthoring the source of truth an application is generated fromOpen standard
AeroKitServer-side TypeScript SDK (@aerokit/sdk)Services, entities, jobs, integrations and extensionsMIT
HarmoniaUI component library for Alpine.js (@codbex/harmonia)The user interface of generated and hand-written applicationsMIT
BlimpKitUI component library for AngularJSWorkbench perspectives, views and IDE extensionsEPL-2.0

Eclipse Dirigible ​

Eclipse Dirigible is the open-source application platform at the base of the stack, hosted by the Eclipse Foundation and developed in the open by codbex and the community. It is the reference implementation of the Intent File Specification: it turns intent into models, workflows, integrations and a running cloud-native application. The platform bundles a full-stack runtime with JavaScript, TypeScript and Java execution engines, BPMN processes, Apache Camel integrations, OData, messaging, jobs and multitenancy, together with the browser Workbench for in-system programming, where every saved change is live immediately without a build or a restart.

Every codbex edition, from Atlas and Rhea to the Gaia runtime base image, is Eclipse Dirigible packaged and extended for a purpose. The Platform and Tooling sections of this portal document that shared foundation. Improvements made while building codbex products and BusinessIntents are contributed upstream, so the open platform and the commercial editions stay one codebase.

Eclipse Dirigible is open source under the Eclipse Public License 2.0.

Intent File ​

An Intent File (*.intent) is a single, readable YAML document that is the source of truth for a whole application: its entities and relations, business rules, processes, forms, reports, roles and seed data, together with the declarative glue between them, such as notifications, schedules, roll-ups and integrations. A conforming generator reads the file and deterministically produces the model artefacts and, from those, the complete running application. Identical intent yields identical output, so the file is small enough to read, stable enough to diff and version, and structured enough for a person or an AI assistant to propose reviewable changes against.

The format is published as an open, vendor-neutral standard at intentfile.org, where you will find the specification, the DSL reference and worked examples. On the codbex platform, intents are authored with the Intent Editor in the Modeling tooling, which generates the Entity Data Model, processes, forms and reports below them.

AeroKit ​

AeroKit is the server-side TypeScript SDK of the platform, published as @aerokit/sdk. It is modular, with more than thirty specialized modules covering databases, HTTP and REST, components and dependency injection, messaging, caching, security, mail, templates and more, so an application imports only what it needs. It follows a code-as-configuration approach: services, entities, controllers and jobs are declared directly in TypeScript with decorators instead of XML or JSON descriptors, with full type safety and IDE support. Code runs live inside the platform runtime, so a saved controller answers requests immediately, with no build or deployment pipeline in between.

AeroKit is open source under the MIT license.

sh
npm install @aerokit/sdk

Harmonia ​

Harmonia is a modern UI component library for Alpine.js, built with Tailwind CSS v4 and published as @codbex/harmonia. It ships more than seventy production-ready components, from buttons, inputs and dialogs to calendars, data tables and SVG charts, plus layouts, utilities and opt-in plugins for internationalization and icons. Every component is a plain x-h-* Alpine directive on your markup, accessible by default, and themeable through design tokens with automatic light and dark mode. There is no build step: markup renders and becomes interactive the moment it reaches the browser, which is why Harmonia is the UI layer of the applications the platform generates from intent. Harmonia also ships an agent-readable skill so coding agents can use every component correctly.

Harmonia is open source under the MIT license.

sh
npm install @codbex/harmonia

BlimpKit ​

BlimpKit is a UI component library for AngularJS based on SAP's fundamental-styles. It is the component set the codbex Workbench itself is built with, and the toolkit for extending it: new perspectives, views, editors, dialogs and menus plug into the IDE with the same look and behaviour as the built-in tooling. Use BlimpKit when you are extending the development environment; use Harmonia for the user interface of the applications you build.

BlimpKit is open source under the Eclipse Public License 2.0.