Skip to content

The open alternative to Salesforce, designed for AI.

3.0 KB
Raw Blame

Application tooling

See Contributing for package setup and tests, and the command reference for user-visible behavior.

The twenty CLI owns filesystem operations, source loading, build, typecheck, watching, pull and deployment. Apps use twenty-sdk to define application metadata and runtime behavior. They do not import or depend on the CLI, which is normally installed globally.

Module Responsibility
project Locate the app and resolve its installed SDK and Node requirements
deployment Preview metadata changes, approve them, upload snapshots and sync
source Discover and evaluate trusted app definitions in a disposable worker
manifest Construct and validate metadata, compile translations
bundles Build artifacts and hold immutable snapshots for consumers
typecheck Check source and configuration with the app's TypeScript compiler
client Invoke the app's installed client SDK generator
pull Reconcile remote metadata with source and a target-bound baseline
add Create starter definitions without replacing existing files
dev Watch build inputs and schedule builds and remote apply
exec Execute an installed logic function
function-logs Stream application function logs

The worker isolates process exits, captures bounded output, filters inherited CLI credentials and supports cancellation. It runs trusted developer code and is not a security sandbox. Configurations containing functions stay inside the worker; only serializable requests, results and diagnostics cross IPC.

Snapshots retain files until their consumers finish. Uploads verify containment, size and checksums. Pull and scaffolding stage writes before exposing them to file watchers. Keep these guarantees when simplifying implementation details.

Package boundaries

The CLI imports the app's public SDK authoring exports and invokes its installed client SDK generator. The typecheck documentation describes compiler resolution and project requirements.

Parity tests compare generated source, manifests and bundles with the repository SDK. Command failure and cancellation tests inject tooling fixtures into a bundle of the production worker; real-app tests exercise its compiler and bundler.