Oidis Builder Quick Start

Oidis Builder is the CLI tool that handles building, testing, running, and managing dependencies across all Oidis projects. This page covers the commands you use daily. For the full reference (task catalogue, configuration schema, module system, deployment), see the Builder Reference section.

Daily commands

These five commands cover 90% of daily development:

Command	What it does	When to use
`oidis dev`	Incremental build + watch + hot reload	During active development
`oidis build dev`	Full development build	After pulling changes, switching branches
`oidis test lint`	Run all linters (TypeScript, SASS, JS)	Before committing (also runs as pre-commit hook)
`oidis test unit`	Run unit tests	After changing logic
`oidis install`	Install/update all dependencies from Git	After cloning, or when dependencies change

oidis dev

Starts the development workflow — compiles TypeScript and SASS incrementally, watches for file changes, and triggers hot reload in the browser.

oidis dev

This is the command you keep running in a terminal during development. Press Ctrl+C to stop.

oidis build dev

Runs a complete development build — compiles everything from scratch, copies resources, generates ForceCompile markers.

oidis build dev       # full dev build
oidis rebuild         # alias: clean + build dev
oidis build prod      # production build (minified, obfuscated)

Use rebuild when incremental builds produce stale artifacts (rare but happens after large refactors).

oidis test lint

Validates code formatting, naming conventions, file headers, and license compliance across all source files.

oidis test lint       # all linters
oidis test unit       # unit tests only

tip

The pre-commit hook runs test lint automatically. If the commit is rejected, run oidis test lint to see the exact violations, fix them, and commit again.

oidis install

Clones or updates all dependencies listed in package.conf.jsonp into the dependencies/ directory.

oidis install

danger

oidis install deletes the entire dependencies/ directory before reinstalling. Any uncommitted changes in dependencies/ will be lost. Always commit or sync dependency changes before running this command.

oidis run

Starts the application server (Node.js backend + frontend serving).

oidis run             # start the server
oidis run --dev       # start in development mode

Project configuration

Every Oidis project has a package.conf.jsonp file at the root that configures the Builder. Key sections:

Section	Purpose
`dependencies`	Git repositories to clone as dependencies
`buildTarget`	Output directory and build artifacts
`compilation`	TypeScript and SASS compiler options
`testing`	Test runner configuration
`deploy`	Deployment targets and encryption

For the full configuration reference, see Builder Configuration.

Dependency declaration

Dependencies are declared as Git connection strings:

"dependencies": {
    "io-oidis-commons": "git+https://gitlab.com/oidis/io-oidis-commons.git#develop",
    "io-oidis-services": "git+https://gitlab.com/oidis/io-oidis-services.git#develop"
}

Format: [type]+[url]#[branch-or-tag] where type is git (remote repository) or dir (local clone).

For advanced dependency options (install scripts, custom attributes), see Builder Configuration — Dependencies.

See also: Builder Overview | CLI Reference | First Build

Daily commands​

oidis dev​

oidis build dev​

oidis test lint​

oidis install​

oidis run​

Project configuration​

Dependency declaration​