OUTSYSTEMS 11 / COMMAND LINE + AGENTS
Build and change OutSystems 11 modules from the command line or with an AI agent, through Service Studio's typed Model API.
JSON specs. Staged files. Validation before and after save.
oml inspect App.oml --own --only entities
{"entities":[{"name":"ReviewNote"}]}
oml apply App.oml change.json App.staged.oml
{"saved":true}
oml validate App.staged.oml
{"errorCount":0}Illustrative excerpts using documented output fields. Empty fields are omitted.
01 / CAPABILITIES
Work with local OutSystems 11 modules through the installed typed Model API.
Build data, logic, REST APIs, screens, blocks, timers and resources from one JSON spec. Entities get indexes and options; aggregates fetch on demand, cache, time out, sort dynamically and filter groups. Change the CSS and widgets of existing screens without a rebuild.
Use inspect for an overview, describe for logic, and find to locate an element and its producer. Preview renders a screen or block offline, runs its scripts, and can click, type and wait (--click, --type, --wait) before the screenshot; --serve shows a live page. Add --timings to see where a slow command spends its time.
Apply refuses protected deletions, renames, attribute changes and data-changing SQL.
Read layers, dependencies and findings. Export an interactive HTML report and optional JSON.
Export exposed REST APIs as OpenAPI 3.0.3. Review and fill the reported placeholders.
New flows get automatic node layout. Use tidyFlows to move nodes in selected existing flows.
List, extract and pack packages. Inspect .xif files or create extension signatures; C# implementation is separate.
Use 1-Click Publish and Refresh All through Service Studio MCP. Its write tools are Beta.
Use API v2 for tags and deployments. Mock verified only; a real smoke test is still required.
Convert TTF, OTF and WOFF to WOFF2. Convert, resize and shrink images, make favicons and app icons (ICO), trace PNG logos to SVG and shrink SVGs without changing a pixel.
Apply removes CSS and JavaScript comments by default. Required /*! ... */ license notices stay. Long code can come from a file next to the spec.
Use the full skill, short Copilot instructions and ready recipes. Start with the required base module.
oml check reports AI Mentor-like findings for a module, a folder or a LifeTime team: security, performance, maintainability and architecture.
oml doc prints short OutSystems rules by topic. oml warn explains a validation message and its fix. oml doc --search "<words>" lists the 3 most likely sections, each with the command that opens it; oml find --text searches a module's elements. All run locally, with no model and no network.
Blocks declare events, fire them with Trigger Event and get a handler on each instance. Build Reactive emails and send them from server actions.
oml review compares a module before and after a change, by the model's own keys, so a rename stays a rename. It lists the changes in plain words, the production-rule risks and only the new check findings, as Markdown, HTML or release notes. Logic bugs are not covered; 0 findings does not mean the code is correct.
Write a spec for BDDFramework test screens of public server actions: Given/When/Then scenarios in a separate test module, with TODO test values to fill in. Checked only against a stand-in of BDDFramework.
02 / MEASURED EXAMPLE
Both agents added Supplier, save/delete actions and a SupplierList table to the same O11 module, using its existing layout.
Agent A used OutSystems MCP with the official O11 skill. Agent B used oml with the short Copilot instructions and recipes, without an MCP server.
Setup: Codex exec, model gpt-6-luna, medium reasoning effort, one run per agent, October 2026. Service Studio 11.55.92.
| Measure | OutSystems MCP + O11 skill | oml | Difference |
|---|---|---|---|
| Result | 0 errors | 0 errors | Same module content |
| Input tokens | 611,714 | 207,210 | 3.0× fewer |
| Input tokens, not cached | 67,202 | 21,610 | 3.1× fewer |
| Output tokens | 4,474 | 2,780 | 1.6× fewer |
| Time | 185 s | 56 s | 3.3× faster |
| Tool calls | 19 | 10 | 1.9× fewer |
| Failed tool calls | 2 | 0 |
This is one run of one simple task. Results change with the model, the task and the module.
Both results were checked with oml validate and oml describe. Read the benchmark details.
03 / WORKFLOW
A staged change, with review before installation or publishing.
Record the source and baseline errors.
Read existing logic. Find and confirm producer elements.
Read the base-module notes. Write the requested change.
Write to a new staged file.
Review errors, warnings and wiring after reopening.
Show the staged result and its oml review. Wait for approval for each action.
Model validation does not run SQL, HTTP, timers or browser behavior. Test these in the target environment.
04 / REFERENCE
Compact JSON by default. Add --pretty for indented output. Exit codes: 0 success, 1 failure or attention needed, 2 usage or environment.
| Command | Use it for |
|---|---|
oml version | Show CLI version, Service Studio build, runtime and self-test status. |
oml new | Create a module by kind, clone with --template, or use --from-template. |
oml app list | Read applications and modules from .oap or .osp. |
oml app extract | Extract modules and extensions with SHA-256 hashes. |
oml app pack | Pack supplied .oml and .xif files into a new .oap. |
oml extension inspect | Read .xif metadata and signatures. |
oml extension new | Create .xif action and structure signatures; no C# implementation. |
oml templates | Find local template modules and bundles. |
oml inspect | List module contents; --own and --only limit output. |
oml describe | Read element logic or screen outlines; --depth adds called bodies. |
oml find | Find elements in a module, references and local producer files. |
oml census | Read a module overview. |
oml architecture | Export module layers, dependencies and findings to HTML and optional JSON. |
oml check | Report AI Mentor-like findings for a module, folder or LifeTime team to HTML or JSON. |
oml review | Compare two versions of a module: changes in plain words, risks and new check findings, to Markdown, HTML or release notes. |
oml test scaffold | Write a spec for BDDFramework test screens of public server actions, to apply to a separate test module. Checked only against a stand-in of BDDFramework. |
oml openapi | Export exposed REST APIs as OpenAPI 3.0.3 JSON. |
oml tree | Show element paths, expressions, references and connectors. |
oml validate | Group validation errors; --warnings includes warnings. |
oml apply | Build a spec into a staged file, reopen it and validate. |
oml translations export | Export Excel or ResX where supported; file I/O refuses on 11.55.92. |
oml install | Install a zero-error staged file with backup, hash and reopen checks. Confirm first. |
oml studio | Check the Service Studio MCP connection and list open modules. |
oml publish | Run 1-Click Publish through Service Studio MCP. Confirm first. |
oml references | Refresh All references in Service Studio. Confirm first. |
oml lt environments | List LifeTime environments and keys. |
oml lt teams | List LifeTime teams for architecture analysis. |
oml lt team-apps | Resolve application membership for a LifeTime team. |
oml lt apps | List applications, running tags and modifications; filter with --env. |
oml lt tag | Tag a running application. Confirm first. |
oml lt deploy | Create and start a deployment plan; --wait polls status. Confirm first. |
oml lt status | Read deployment status and messages. |
oml lt abort | Abort a deployment, then read status. Confirm first. |
oml lt continue | Continue a deployment, then read status. Confirm first. |
oml font woff2 | Convert a TTF, CFF OTF or WOFF1 file to WOFF2. |
oml font batch | Convert fonts in one folder without recursion. |
oml image | Convert, resize or optimize a raster image or SVG; write ICO; trace a PNG logo to SVG. |
oml image batch | Process images in one folder without recursion. |
oml doc | Print OutSystems rules for agents: a topic or one section. No Service Studio needed. |
oml warn | Explain a validation error or warning by id or title words, with its fix. |
oml api | List installed model type members; supports wildcards. |
oml widgets | List registered widget descriptors. |
oml selftest | Check the installed model build on a disposable module. |
No commands match. Try another word.
05 / SPEC FORMAT
Every top-level key is optional. JSON comments are allowed; trailing commas are not. Expressions use OutSystems syntax.
moduleDescription, JavaScript, PNG icon, user provider and tenancy flags, existing default theme.
entities, structures, exceptionsData model. New entities get an Id. Entity indexes, identifier and options.
staticEntitiesStatic entities with records.
references, referenceAliases, removeUnusedDependenciesElements from producer modules, local names for them, and removal of unused ones.
serverActions, serviceActions, clientActionsActions with inputs, outputs, locals and a flow.
tidyFlowsMove nodes in existing flows selected by element paths or name patterns.
clientVariables, sessionVariables, systemEventsModule state and calls from platform lifecycle events. Module kind limits apply.
onException, globalExceptionHandler, flow exceptionHandlerSeparate exception paths and a Reactive global handler.
flow nodes aggregateSources, joins, filters, sorts, group by (with group filters and sorts), calculated attributes, fetch, cache.
flow node sqlSQL statements with typed parameters and outputs.
restClients, restServicesConsumed and exposed REST APIs.
timers, roles, processes, sitePropertiesPlatform elements, screen access.
screens, blocks (Reactive, Mobile)Screens, blocks, aggregates, actions, events, widgets.
events, triggerEvent, onParametersChangedBlock events: declare on a block, fire with a node, handle on each block instance.
emails, flow node sendEmailReactive emails and sending them from a server action.
screens, blocks (Traditional Web)Web screens with preparation and web widgets.
layout, placeholders, templateLayout blocks and generated list or detail screens.
editsChanges to existing elements.
edits with deleteDeletion of elements created earlier in the same spec. Existing elements are refused (see rules.md).
copyClipboard copy from read-only modules; explicit dependencies; IPP checks.
locales, translate, translationsLocales and module resource translations; file import where the host supports it.
images, scripts, themes, resources, folders, requiredScriptsContent files, styles, folders, and screen/block script requirements.
keepCommentsKeep comments in styleSheet and javaScript (removed by default).
06 / PRODUCTION
The full list from the agent skill. Rules 2, 3, 4, 5 and 6 are also checked by apply. A server action made public gets a PublicServerAction warning (rule 7).
DELETE, UPDATE, TRUNCATE, DROP, ALTER, MERGE. Read-only SQL and INSERT are fine.exposeReadOnly false on a public entity, unless the user asks for that exact change. Make a server action public only when the user agrees (apply warns PublicServerAction). Other elements may be public when the design needs it..oml file with an editor, patch tool, or script. It is a binary package. Change modules only through oml apply.install, publish, references, or a LifeTime deploy, tag, abort, or continue without a clear yes from the user for that exact action.07 / EXPLORE
Read EndUser, Core and Foundation layers, module dependencies and architecture findings.
This demo renders the repository’s architecture sample with the CLI’s own HTML template. Explore modules, search and inspect findings.
Layer assignments are guesses to review. Edges represent imported signatures, not runtime call counts. Static analysis cannot recover dynamic dependencies.
Open architecture demo ↗08 / CONTEXT
O11 uses a local Service Studio MCP server. ODC uses a remote tenant server and Mentor for changes.
| Area | oml | OutSystems MCP, O11 | OutSystems MCP, ODC |
|---|---|---|---|
| Runs | Locally, against an .oml file | Locally, in Service Studio, on the open module | In your ODC tenant |
| How changes are made | JSON spec, built by oml through the typed Model API | Model API code that the agent writes | Mentor, from a text prompt |
| Control | Exact: names, joins, connectors, widgets | Exact, if the agent's code compiles | Whatever Mentor builds |
| Reading a module | inspect, describe, find, tree on the file, no Service Studio window needed | Read tools on the open module | Context lookups on the tenant |
| Validation | Before and after save, per change | Validation tool on the result | Reported by Mentor after the turn |
| Safety rules | skill/rules.md; apply refuses deletes, renames and attribute changes of existing elements, and data-changing SQL | Review in Compare and Merge | Review in ODC Studio |
| Front-end assets | Font to WOFF2; image convert, resize and shrink; ICO; PNG to SVG | No | No |
| Publish | Yes, through the Service Studio MCP server | Yes (Beta) | Yes |
| Deploy between environments | LifeTime API v2 (mock verified; real smoke test required) | No | Yes |
| Needs | Service Studio 11, .NET 8 | Service Studio 11.55.91 or later, module open | ODC tenant, sign-in |
oml uses Service Studio MCP only for publishing and reference refresh. It does not load ODC modules with the O11 loader.
09 / GET STARTED
Use Windows x64, Service Studio 11 and the .NET 8 runtime, or the newer runtime required by your Service Studio.
oml-<version>-win-x64.zip and its .sha256 checksum from GitHub Releases.bin folder to PATH.$env:PATH = 'C:\Tools\oml\bin;' + $env:PATH
oml versionThe archive includes the skill and documentation. Service Studio assemblies are loaded from your installation and are not included.
Install Service Studio 11 and the .NET 8 SDK. Clone the repository, then run these commands from its root.
git clone https://github.com/Topurrra/oml-cli.git
cd oml-cli
dotnet build -c Release src/OmlCli.csproj
$env:PATH = "$PWD\src\bin\Release\net10.0;$env:PATH"
oml versionKeep the build output folder together. For another Service Studio folder, set OML_SERVICE_STUDIO and the build property SS. Build configuration.
Unsigned executables may be blocked by company policy. Teams can build from source instead.
Export your module as App.oml. Inspect it, record baseline validation errors, and save a change spec. Use a new output path for each attempt.
oml inspect App.oml
oml validate App.oml --warnings
oml apply App.oml change.json App.staged.oml
oml describe App.staged.oml ReviewNote
oml validate App.staged.oml --warningsReview problems, newErrors, reopenNewErrors, warnings and newWarnings. Installation needs zero total errors, including baseline errors. Confirm before install or publish. Follow the complete example.
10 / FOLLOW DEVELOPMENT
Follow the project and issues for current work.