MCL Command Help

Syntax

Metoriq.Cli --help

Metoriq.Cli --version

Examples

Metoriq.Cli --help

Syntax

Metoriq.Cli setup init

Metoriq.Cli setup status

Examples

Metoriq.Cli setup status

Syntax

Metoriq.Cli tenants list

Metoriq.Cli tenants create <tenantKey> <name> <tenantAdminKey> <tenantAdminEmail> <tenantAdminPassword> [licensePlan]

Metoriq.Cli tenants disable <tenantKey>

Metoriq.Cli tenants enable <tenantKey>

Metoriq.Cli tenants admins list <tenantKey>

Metoriq.Cli tenants admin set-password <tenantKey> <tenantAdminKey> <newPassword>

Examples

Metoriq.Cli tenants create acme "ACME Corporation" tenantadmin tenantadmin@acme.com "TenantAdmin123!" trial

Syntax

Metoriq.Cli tenants provision-file <path>

Examples

Metoriq.Cli tenants provision-file ./tenant-provisioning.json

Notes

• This is a platform operation, not an MCL command. It creates the tenant, license, initial environment, workspace profile, and owner user transactionally.

Syntax

Metoriq.Cli tenants license show <tenantKey>

Metoriq.Cli tenants license alter <tenantKey> '<json>'

Metoriq.Cli tenants license alter-file <tenantKey> <path>

Examples

Metoriq.Cli tenants license alter-file acme ./license.json

Notes

• License changes are intentionally external to MCL and generate TENANT_LICENSE audit events.

Syntax

Metoriq.Cli connect <tenantKey> <userKey> <password>

Metoriq.Cli run <tenantKey> <userKey> <password>

Metoriq.Cli run <tenantKey> <userKey> <password> <script.mcl>

Examples

Metoriq.Cli connect acme tenantadmin "TenantAdmin123!"

Metoriq.Cli run acme tenantadmin "TenantAdmin123!" setup-dev.mcl

Syntax

HELP;

HELP <TOPIC>;

Examples

HELP;

HELP CONNECTION;

HELP WORKSPACE;

HELP READDATA;

HELP WRITEDATA;

HELP TRANSFORMATION;

HELP DATAFLOW;

HELP ACTION;

Notes

• Current topics include ENVIRONMENT, SCHEMA, CONNECTOR, CONNECTION, WORKSPACE, READDATA, WRITEDATA, TRANSFORMATION, DATAFLOW, ACTION, USER, ROLE, and SESSION.

Syntax

USE ENVIRONMENT KEY <environmentKey>;

Examples

USE ENVIRONMENT KEY dev;

Syntax

LEAVE ENVIRONMENT;

Examples

LEAVE ENVIRONMENT;

Syntax

CLEAR;

EXIT;

QUIT;

Examples

CLEAR;

EXIT;

Syntax

CREATE ENVIRONMENT KEY <key> PROPERTIES JSON `<json>`;

ALTER ENVIRONMENT KEY <key> PROPERTIES FILE "<path>";

COPY ENVIRONMENT KEY <sourceKey> TO KEY <targetKey>;

Examples

CREATE ENVIRONMENT KEY dev PROPERTIES JSON `{ "name": "Development" }`;

Syntax

SHOW ENVIRONMENTS;

DETAIL ENVIRONMENT KEY <key>;

DESCRIBE ENVIRONMENT PROPERTIES;

Examples

SHOW ENVIRONMENTS;

Syntax

GENERATE <ACTION> ENVIRONMENT KEY <key>;

Examples

GENERATE ALTER ENVIRONMENT KEY dev;

Syntax

ENABLE ENVIRONMENT KEY <key>;

DISABLE ENVIRONMENT KEY <key>;

DELETE ENVIRONMENT KEY <key>;

DELETE ENVIRONMENT KEY <key> CASCADE;

Examples

DISABLE ENVIRONMENT KEY dev;

Syntax

DEPENDENTS ENVIRONMENT KEY <key>;

Examples

DEPENDENTS ENVIRONMENT KEY dev;

Syntax

SHOW SCHEMAS;

SHOW SCHEMA KEY <schemaKey>;

SHOW SCHEMA KEY <schemaKey> OBJECTS;

DETAIL SCHEMA KEY <schemaKey>;

DESCRIBE SCHEMA PROPERTIES;

Examples

SHOW SCHEMA KEY public OBJECTS;

Syntax

CREATE SCHEMA KEY <schemaKey> PROPERTIES JSON `<json>`;

ALTER SCHEMA KEY <schemaKey> PROPERTIES FILE "<path>";

DELETE SCHEMA KEY <schemaKey>;

Examples

CREATE SCHEMA KEY finance PROPERTIES JSON `{ "name": "Finance" }`;

Notes

• The reserved public schema is created automatically and cannot be renamed or deleted.

Syntax

SHOW CONNECTOR TYPES;

Examples

SHOW CONNECTOR TYPES;

Syntax

DETAIL CONNECTOR TYPE KEY <typeKey>;

Examples

DETAIL CONNECTOR TYPE KEY postgresql;

Syntax

CREATE CONNECTION KEY <connectionKey> TYPE <typeKey> PROPERTIES JSON `<json>`;

CREATE CONNECTION KEY <schemaKey>.<connectionKey> TYPE <typeKey> PROPERTIES FILE "<path>";

Examples

CREATE CONNECTION KEY public.source_db TYPE postgresql PROPERTIES JSON `{ "name": "Source DB", "host": "localhost", "port": 5432, "database": "source_db", "username": "postgres", "password": "postgres", "ssl_mode": "disable" }`;

Notes

• password is removed from persisted properties_json and represented as secret_reference: "connection:password".
• connection_string must not contain Password or Pwd.

Syntax

ALTER CONNECTION KEY <connectionKey> PROPERTIES JSON `<json>`;

ALTER CONNECTION KEY <schemaKey>.<connectionKey> PROPERTIES FILE "<path>";

Examples

ALTER CONNECTION KEY public.source_db PROPERTIES JSON `{ "description": "Source DB rotated", "password": "new-secret" }`;

Notes

• Omitting password preserves the current secret.

Syntax

SHOW CONNECTIONS;

DETAIL CONNECTION KEY <connectionKey>;

DETAIL CONNECTION KEY <schemaKey>.<connectionKey>;

Examples

DETAIL CONNECTION KEY public.source_db;

Syntax

GENERATE CREATE CONNECTION KEY <schemaKey>.<connectionKey>;

GENERATE ALTER CONNECTION KEY <schemaKey>.<connectionKey>;

GENERATE ENABLE CONNECTION KEY <schemaKey>.<connectionKey>;

GENERATE DISABLE CONNECTION KEY <schemaKey>.<connectionKey>;

GENERATE DELETE CONNECTION KEY <schemaKey>.<connectionKey>;

GENERATE DETAIL CONNECTION KEY <schemaKey>.<connectionKey>;

Examples

GENERATE CREATE CONNECTION KEY public.source_db;

Syntax

TEST CONNECTION KEY <connectionKey>;

TEST CONNECTION KEY <schemaKey>.<connectionKey>;

Examples

TEST CONNECTION KEY public.source_db;

Notes

• TEST CONNECTION does not read or write data and does not generate audit in the initial cut.

Syntax

ENABLE CONNECTION KEY <schemaKey>.<connectionKey>;

DISABLE CONNECTION KEY <schemaKey>.<connectionKey>;

DELETE CONNECTION KEY <schemaKey>.<connectionKey>;

Examples

DISABLE CONNECTION KEY public.source_db;

Syntax

CONFIGURE WORKSPACE PROFILE PROPERTIES JSON `<json>`;

CONFIGURE WORKSPACE PROFILE PROPERTIES FILE "<path>";

Examples

CONFIGURE WORKSPACE PROFILE PROPERTIES JSON `{ "name": "DEV Workspace", "provider": "postgresql", "host": "localhost", "port": 5432, "database": "metoriq_workspace", "username": "postgres", "password": "postgres", "ssl_mode": "disable", "managed_by_metoriq": false, "provisioning_mode": "existing_database" }`;

Notes

• The first supported operational mode is existing_database.

Syntax

SHOW WORKSPACE PROFILE;

DETAIL WORKSPACE PROFILE;

DESCRIBE WORKSPACE PROFILE PROPERTIES;

Examples

SHOW WORKSPACE PROFILE;

Syntax

TEST WORKSPACE PROFILE;

Examples

TEST WORKSPACE PROFILE;

Notes

• Successful tests mark the profile ready; failed tests mark it failed.

Syntax

PURGE WORKSPACE ARTIFACTS DRY RUN;

PURGE WORKSPACE ARTIFACTS FOR RUN "<run_id>";

PURGE WORKSPACE ARTIFACTS OLDER THAN "<duration>";

Examples

PURGE WORKSPACE ARTIFACTS DRY RUN;

PURGE WORKSPACE ARTIFACTS OLDER THAN "2h";

Notes

• Purge only targets registered artifacts that follow Metoriq workspace naming conventions.
• Manual purge generates WORKSPACE_ARTIFACTS audit events when artifacts are removed.

Syntax

CREATE READDATA KEY <readDataKey> USING CONNECTION <connectionKey> PROPERTIES JSON `<json>`;

CREATE READDATA KEY <schemaKey>.<readDataKey> USING CONNECTION <schemaKey>.<connectionKey> PROPERTIES FILE "<path>";

ALTER READDATA KEY <schemaKey>.<readDataKey> PROPERTIES JSON `<json>`;

ALTER READDATA KEY <schemaKey>.<readDataKey> PROPERTIES FILE "<path>";

Examples

CREATE READDATA KEY public.dim_brand USING CONNECTION public.source_db PROPERTIES JSON `{ "name": "Dim Brand", "mode": "query", "query": "SELECT * FROM dbo.\"Dim_Brand\"", "preview_limit": 20 }`;

CREATE READDATA KEY public.dim_category USING CONNECTION public.source_db PROPERTIES JSON `{ "name": "Dim Category", "mode": "query", "query_file": "./sql/dim_category.sql", "preview_limit": 20 }`;

Notes

• query_file is expanded by the authoring client and only query is persisted.

Syntax

SHOW READDATA;

DETAIL READDATA KEY <schemaKey>.<readDataKey>;

Examples

DETAIL READDATA KEY public.dim_brand;

Syntax

DESCRIBE READDATA KEY <schemaKey>.<readDataKey> OUTPUT;

Examples

DESCRIBE READDATA KEY public.dim_brand OUTPUT;

Syntax

PREVIEW READDATA KEY <schemaKey>.<readDataKey>;

PREVIEW READDATA KEY <schemaKey>.<readDataKey> LIMIT <rows>;

Examples

PREVIEW READDATA KEY public.dim_brand LIMIT 5;

Notes

• LIMIT is a one-time override between 1 and 1000.

Syntax

EXECUTE READDATA KEY <schemaKey>.<readDataKey>;

Examples

EXECUTE READDATA KEY public.dim_brand;

Notes

• Requires a ready WORKSPACE PROFILE in the active environment.
• Creates a run_id, a physical metoriq_run_* schema, a raw_* table, and registered workspace artifacts.

Syntax

GENERATE CREATE READDATA KEY <schemaKey>.<readDataKey>;

GENERATE ALTER READDATA KEY <schemaKey>.<readDataKey>;

GENERATE DESCRIBE READDATA KEY <schemaKey>.<readDataKey>;

GENERATE DETAIL READDATA KEY <schemaKey>.<readDataKey>;

GENERATE PREVIEW READDATA KEY <schemaKey>.<readDataKey>;

Examples

GENERATE CREATE READDATA KEY public.dim_brand;

Syntax

CREATE WRITEDATA KEY <writeDataKey> USING CONNECTION <connectionKey> PROPERTIES JSON `<json>`;

CREATE WRITEDATA KEY <schemaKey>.<writeDataKey> USING CONNECTION <schemaKey>.<connectionKey> PROPERTIES FILE "<path>";

ALTER WRITEDATA KEY <schemaKey>.<writeDataKey> PROPERTIES JSON `<json>`;

ALTER WRITEDATA KEY <schemaKey>.<writeDataKey> PROPERTIES FILE "<path>";

Examples

CREATE WRITEDATA KEY public.write_dim_brand USING CONNECTION public.target_db PROPERTIES JSON `{ "name": "Write Dim Brand", "source": "{{public.dim_brand}}", "target_table": "dbo.dim_brand", "mode": "append", "column_mapping": { "Cod_Brand": "cod_brand", "Desc_Brand": "desc_brand" } }`;

Notes

• source must use {{schema.object}} and can resolve to READDATA or TRANSFORMATION.
• append is the only implemented mode in Milestone 011.

Syntax

SHOW WRITEDATA;

DETAIL WRITEDATA KEY <schemaKey>.<writeDataKey>;

DESCRIBE WRITEDATA PROPERTIES;

Examples

DETAIL WRITEDATA KEY public.write_dim_brand;

Syntax

CHECK WRITEDATA KEY <schemaKey>.<writeDataKey>;

Examples

CHECK WRITEDATA KEY public.write_dim_brand;

Notes

• CHECK WRITEDATA does not move rows and does not generate audit in this initial cut.

Syntax

GENERATE CREATE WRITEDATA KEY <schemaKey>.<writeDataKey>;

GENERATE ALTER WRITEDATA KEY <schemaKey>.<writeDataKey>;

GENERATE DETAIL WRITEDATA KEY <schemaKey>.<writeDataKey>;

GENERATE CHECK WRITEDATA KEY <schemaKey>.<writeDataKey>;

Examples

GENERATE CREATE WRITEDATA KEY public.write_dim_brand;

Syntax

EXECUTE WRITEDATA KEY <schemaKey>.<writeDataKey>;

Examples

EXECUTE WRITEDATA KEY public.write_dim_brand;

Notes

• Runs mandatory graph preflight before materializing workspace objects or writing rows.

Syntax

CREATE TRANSFORMATION KEY <transformationKey> PROPERTIES JSON `<json>`;

CREATE TRANSFORMATION KEY <schemaKey>.<transformationKey> PROPERTIES FILE "<path>";

ALTER TRANSFORMATION KEY <schemaKey>.<transformationKey> PROPERTIES JSON `<json>`;

ALTER TRANSFORMATION KEY <schemaKey>.<transformationKey> PROPERTIES FILE "<path>";

Examples

CREATE TRANSFORMATION KEY public.dim_brand_category PROPERTIES JSON `{ "name": "Dim Brand Category", "mode": "sql_view", "query": "SELECT c.cod_category, c.desc_category, b.cod_brand, b.desc_brand FROM {{public.dim_category}} c JOIN {{public.dim_brand}} b ON c.cod_category = b.cod_category", "preview_limit": 20, "primary_key": ["cod_brand"] }`;

Notes

• query_file is expanded during authoring and only query is persisted.
• Queries reference READDATA or TRANSFORMATION producers with placeholders such as {{public.dim_brand}}.

Syntax

SHOW TRANSFORMATIONS;

DETAIL TRANSFORMATION KEY <schemaKey>.<transformationKey>;

DESCRIBE TRANSFORMATION KEY <schemaKey>.<transformationKey> OUTPUT;

DESCRIBE TRANSFORMATION PROPERTIES;

Examples

DESCRIBE TRANSFORMATION KEY public.dim_brand_category OUTPUT;

Syntax

PREVIEW TRANSFORMATION KEY <schemaKey>.<transformationKey>;

PREVIEW TRANSFORMATION KEY <schemaKey>.<transformationKey> LIMIT <rows>;

Examples

PREVIEW TRANSFORMATION KEY public.dim_brand_category LIMIT 5;

Notes

• Requires a ready WORKSPACE PROFILE.
• Transformation SQL must use normalized RAW column names.

Syntax

GENERATE CREATE TRANSFORMATION KEY <schemaKey>.<transformationKey>;

GENERATE ALTER TRANSFORMATION KEY <schemaKey>.<transformationKey>;

GENERATE DETAIL TRANSFORMATION KEY <schemaKey>.<transformationKey>;

GENERATE DESCRIBE TRANSFORMATION KEY <schemaKey>.<transformationKey>;

GENERATE PREVIEW TRANSFORMATION KEY <schemaKey>.<transformationKey>;

Examples

GENERATE CREATE TRANSFORMATION KEY public.dim_brand_category;

Syntax

CREATE DATAFLOW KEY <dataflowKey> PROPERTIES JSON `<json>`;

CREATE DATAFLOW KEY <schemaKey>.<dataflowKey> PROPERTIES FILE "<path>";

ALTER DATAFLOW KEY <schemaKey>.<dataflowKey> PROPERTIES JSON `<json>`;

ALTER DATAFLOW KEY <schemaKey>.<dataflowKey> PROPERTIES FILE "<path>";

Examples

CREATE DATAFLOW KEY public.load_dimensions PROPERTIES JSON `{ "name": "Load Dimensions", "outputs": ["{{public.write_dim_brand}}", "{{public.write_dim_category}}"] }`;

Notes

• outputs accepts WRITEDATA references in this initial cut.

Syntax

SHOW DATAFLOWS;

DETAIL DATAFLOW KEY <schemaKey>.<dataflowKey>;

DESCRIBE DATAFLOW PROPERTIES;

Examples

DETAIL DATAFLOW KEY public.load_dimensions;

Syntax

CHECK DATAFLOW KEY <schemaKey>.<dataflowKey>;

Examples

CHECK DATAFLOW KEY public.load_dimensions;

Notes

• CHECK DATAFLOW does not execute data physically.

Syntax

GENERATE CREATE DATAFLOW KEY <schemaKey>.<dataflowKey>;

GENERATE ALTER DATAFLOW KEY <schemaKey>.<dataflowKey>;

GENERATE DETAIL DATAFLOW KEY <schemaKey>.<dataflowKey>;

GENERATE CHECK DATAFLOW KEY <schemaKey>.<dataflowKey>;

Examples

GENERATE CHECK DATAFLOW KEY public.load_dimensions;

Syntax

EXECUTE DATAFLOW KEY <schemaKey>.<dataflowKey>;

Examples

EXECUTE DATAFLOW KEY public.load_dimensions;

Notes

• Creates a run, workspace artifacts, runtime steps, and structured events.

Syntax

DESCRIBE USER PROPERTIES;

CREATE USER KEY <userKey> PROPERTIES JSON `<json>`;

ALTER USER KEY <userKey> PROPERTIES FILE "<path>";

COPY USER KEY <sourceKey> TO KEY <targetKey>;

SHOW USERS;

DETAIL USER KEY <userKey>;

GENERATE CREATE USER KEY <userKey>;

ENABLE USER KEY <userKey>;

DISABLE USER KEY <userKey>;

DELETE USER KEY <userKey>;

Examples

CREATE USER KEY joao PROPERTIES JSON `{ "display_name": "Joao Silva", "email": "joao@acme.com" }`;

Syntax

SET PASSWORD FOR USER KEY <userKey> TO "<password>";

Examples

SET PASSWORD FOR USER KEY joao TO "Joao123!";

Notes

• The command obeys the tenant password_policy.

Syntax

GRANT ROLE <roleKey> TO USER KEY <userKey> ON ENVIRONMENT KEY <environmentKey>;

REVOKE ROLE <roleKey> FROM USER KEY <userKey> ON ENVIRONMENT KEY <environmentKey>;

SHOW USER KEY <userKey> ROLES;

SHOW ENVIRONMENT KEY <environmentKey> USERS;

SET DEFAULT ENVIRONMENT KEY <environmentKey> FOR USER KEY <userKey>;

Examples

GRANT ROLE designer TO USER KEY joao ON ENVIRONMENT KEY dev;

Syntax

SHOW TENANT SETTINGS;

ALTER TENANT SETTINGS PROPERTIES JSON `<json>`;

ALTER TENANT SETTINGS PROPERTIES FILE "<path>";

EXPORT TENANT SETTINGS TO FILE "<path>";

IMPORT TENANT SETTINGS FROM FILE "<path>";

Examples

ALTER TENANT SETTINGS PROPERTIES JSON `{ "password_policy": { "min_length": 14 } }`;

Syntax

SHOW TENANT LICENSE;

Examples

SHOW TENANT LICENSE;

Notes

• License changes are made by external CLI commands, not MCL.

Syntax

SHOW AUDIT EVENTS;

SHOW AUDIT EVENTS SINCE "<yyyy-MM-dd>";

SHOW AUDIT EVENTS UNTIL "<yyyy-MM-dd>";

SHOW AUDIT EVENTS FOR USER KEY <userKey>;

SHOW AUDIT EVENTS FOR OBJECT <OBJECT_TYPE> KEY <objectKey>;

PURGE AUDIT EVENTS BEFORE "<yyyy-MM-dd>";

Examples

SHOW AUDIT EVENTS FOR OBJECT ENVIRONMENT KEY dev;

Syntax

SHOW TENANT USAGE;

SHOW TENANT USAGE PERIOD "<yyyy-MM>";

Examples

SHOW TENANT USAGE PERIOD "2026-06";

Notes

• Usage aggregates runs, statuses, run types, runtime minutes, rows, events, workspace artifacts, and observed concurrency.

Syntax

SHOW ENVIRONMENT USAGE;

SHOW ENVIRONMENT USAGE PERIOD "<yyyy-MM>";

Examples

SHOW ENVIRONMENT USAGE;

Syntax

CREATE USER KEY <userKey> PROPERTIES JSON `<json>`;

CREATE ENVIRONMENT KEY <environmentKey> PROPERTIES JSON `<json>`;

EXECUTE DATAFLOW KEY <dataflowKey>;

EXECUTE FLOW KEY <flowKey>;

Examples

EXECUTE FLOW KEY public.daily_load;

Notes

• Blocks generate localized human-facing messages and LICENSE_BLOCK audit events.

Syntax

SHOW RUNS;

Examples

SHOW RUNS;

Syntax

SHOW RUN KEY <run_id>;

SHOW RUN KEY <run_id> STEPS;

SHOW RUN KEY <run_id> LOGS;

SHOW RUN KEY <run_id> LOGS LEVEL ERROR;

Examples

SHOW RUN KEY "<run_id>" LOGS LEVEL ERROR;

Notes

• EXECUTE READDATA and PREVIEW TRANSFORMATION register run, step, and event records.

Syntax

SHOW RUN LOG RETENTION POLICY;

Examples

SHOW RUN LOG RETENTION POLICY;

Syntax

PURGE RUN LOGS OLDER THAN "<duration>" DRY RUN;

PURGE RUN LOGS OLDER THAN "<duration>";

PURGE RUN LOGS FOR RUN "<run_id>" DRY RUN;

PURGE RUN LOGS FOR RUN "<run_id>";

Examples

PURGE RUN LOGS OLDER THAN "30d" DRY RUN;

PURGE RUN LOGS FOR RUN "<run_id>";

Notes

• Effective purge generates RUN_LOGS audit events.
• Raw technical logs and custom retention policies remain future work.

Syntax

CREATE ACTION KEY <actionKey> USING CONNECTION <connectionKey> PROPERTIES JSON `<json>`;

CREATE ACTION KEY <schemaKey>.<actionKey> USING CONNECTION <schemaKey>.<connectionKey> PROPERTIES FILE "<path>";

ALTER ACTION KEY <schemaKey>.<actionKey> PROPERTIES JSON `<json>`;

ALTER ACTION KEY <schemaKey>.<actionKey> PROPERTIES FILE "<path>";

Examples

CREATE ACTION KEY public.insert_product_test USING CONNECTION public.source_db PROPERTIES JSON `{ "name": "Insert product test", "mode": "sql_command", "command": "INSERT INTO dbo.\"Dim_Product\"(\"Cod_Product\", \"Desc_Product\") VALUES ('943221', 'Produto Teste')" }`;

CREATE ACTION KEY public.insert_product_test_file USING CONNECTION public.source_db PROPERTIES JSON `{ "name": "Insert product test file", "mode": "sql_command", "command_file": "./sql/insert_product_test.sql" }`;

Notes

• command_file follows the SQL file expansion rule and only command is persisted.

Syntax

SHOW ACTIONS;

DETAIL ACTION KEY <schemaKey>.<actionKey>;

Examples

DETAIL ACTION KEY public.insert_product_test;

Syntax

GENERATE CREATE ACTION KEY <schemaKey>.<actionKey>;

GENERATE ALTER ACTION KEY <schemaKey>.<actionKey>;

GENERATE DETAIL ACTION KEY <schemaKey>.<actionKey>;

Examples

GENERATE CREATE ACTION KEY public.insert_product_test;

Syntax

EXECUTE ACTION KEY <schemaKey>.<actionKey>;

Examples

EXECUTE ACTION KEY public.insert_product_test;

Notes

• Successful SQL returns success; SQL failure returns a controlled error visible in run logs.

Syntax

CREATE TASK KEY <taskKey> TYPE <type> PROPERTIES JSON `<json>`;

CREATE TASK KEY <schemaKey>.<taskKey> TYPE <type> PROPERTIES FILE "<path>";

ALTER TASK KEY <schemaKey>.<taskKey> PROPERTIES JSON `<json>`;

Examples

CREATE TASK KEY public.load_brand TYPE writedata PROPERTIES JSON `{ "name": "Load Brand", "target": "{{public.write_dim_brand}}" }`;

Syntax

SHOW TASKS;

DETAIL TASK KEY <schemaKey>.<taskKey>;

DESCRIBE TASK PROPERTIES;

Examples

SHOW TASKS;

Syntax

GENERATE CREATE TASK KEY <schemaKey>.<taskKey>;

GENERATE ALTER TASK KEY <schemaKey>.<taskKey>;

GENERATE DETAIL TASK KEY <schemaKey>.<taskKey>;

Examples

GENERATE CREATE TASK KEY public.load_brand;

Syntax

CREATE FLOW KEY <flowKey> PROPERTIES JSON `<json>`;

CREATE FLOW KEY <schemaKey>.<flowKey> PROPERTIES FILE "<path>";

ALTER FLOW KEY <schemaKey>.<flowKey> PROPERTIES JSON `<json>`;

Examples

CREATE FLOW KEY public.daily_load PROPERTIES JSON `{ "name": "Daily Load", "tasks": ["{{public.load_dimensions}}"] }`;

Syntax

ADD FLOW TASK KEY <flowKey> TASK KEY <taskKey>;

REMOVE FLOW TASK KEY <flowKey> TASK KEY <taskKey>;

ADD FLOW EDGE KEY <flowKey> FROM TASK KEY <fromTaskKey> TO TASK KEY <toTaskKey> ON <success|error|always>;

REMOVE FLOW EDGE KEY <flowKey> FROM TASK KEY <fromTaskKey> TO TASK KEY <toTaskKey> ON <success|error|always>;

Examples

ADD FLOW EDGE KEY public.daily_load FROM TASK KEY public.load_dimensions TO TASK KEY public.mark_success ON success;

Syntax

SHOW FLOWS;

DETAIL FLOW KEY <schemaKey>.<flowKey>;

SHOW FLOW KEY <schemaKey>.<flowKey> TASKS;

SHOW FLOW KEY <schemaKey>.<flowKey> EDGES;

DESCRIBE FLOW PROPERTIES;

Examples

SHOW FLOW KEY public.daily_load TASKS;

Syntax

CHECK FLOW KEY <schemaKey>.<flowKey>;

Examples

CHECK FLOW KEY public.daily_load;

Syntax

EXECUTE FLOW KEY <schemaKey>.<flowKey>;

Examples

EXECUTE FLOW KEY public.daily_load;

Notes

• Runs CHECK FLOW preflight before executing tasks.
• Task result conditions are success, error, and always.

Syntax

CREATE VARIABLE KEY <variableKey> SCOPE ENVIRONMENT PROPERTIES JSON `<json>`;

CREATE VARIABLE KEY <variableKey> SCOPE FLOW KEY <flowKey> PROPERTIES JSON `<json>`;

CREATE VARIABLE KEY <variableKey> SCOPE TASK KEY <taskKey> PROPERTIES JSON `<json>`;

ALTER VARIABLE KEY <variableKey> PROPERTIES JSON `<json>`;

Examples

CREATE VARIABLE KEY DATA_REF SCOPE ENVIRONMENT PROPERTIES JSON `{ "name": "Data reference", "data_type": "date", "value": "2026-06-23" }`;

Notes

• Supported data types include string, number, boolean, date, datetime, and vector.

Syntax

SHOW VARIABLES;

SHOW VARIABLES SCOPE FLOW KEY <flowKey>;

SHOW VARIABLES SCOPE TASK KEY <taskKey>;

DETAIL VARIABLE KEY <variableKey>;

DELETE VARIABLE KEY <variableKey>;

Examples

SHOW VARIABLES;

SHOW VARIABLES SCOPE FLOW KEY public.daily_load;

Syntax

SET VARIABLE <variableKey> = "<value>";

SET VARIABLE <variableKey> PROPERTIES JSON `<json>`;

UNSET VARIABLE <variableKey>;

Examples

SET VARIABLE DATA_REF = "2026-06-23";

Syntax

SET VARIABLE <variableKey> FROM READDATA KEY <schemaKey>.<readDataKey> COLUMN <columnName>;

Examples

SET VARIABLE FILES FROM READDATA KEY public.pending_xml_files COLUMN file_name;

Notes

• The result is always a vector; one-item vectors behave as scalars during expansion.

Syntax

CHECK FLOW KEY <flowKey> VARIABLES MODE POSITIONAL_FILL_LAST;

EXECUTE FLOW KEY <flowKey> VARIABLES MODE CARTESIAN;

EXECUTE DATAFLOW KEY <dataflowKey> VARIABLES MODE CARTESIAN;

EXECUTE ACTION KEY <actionKey> VARIABLES MODE CARTESIAN;

Examples

EXECUTE FLOW KEY public.import_all VARIABLES MODE CARTESIAN;

Notes

• Default mode is positional_fill_last.
• Cartesian mode is explicit to avoid accidental execution explosions.

Syntax

VERSION;

Examples

VERSION;

Notes

• The current product version is sourced centrally and is aligned with milestone versioning policy.

Syntax

HELP VERSION;

Examples

HELP VERSION;

Syntax

HELP;

VERSION;

SHOW RUN KEY <run_id> LOGS;

Examples

HELP;

Notes

• MCL command syntax, object types, JSON property names, keys, SQL, paths, and technical payloads remain in English/canonical form.
• Supported initial locales are en-US, pt-BR, and es-ES with fallback to English.

Syntax

GET /api/platform/status

POST /api/platform/tenants/provision

Examples

POST /api/platform/tenants/provision

Notes

• Platform endpoints are protected by an operational token and are not user MCL credentials.

Syntax

GET /api/tenants/{tenantKey}/environments

GET /api/tenants/{tenantKey}/environments/{environmentKey}/objects

GET /api/tenants/{tenantKey}/environments/{environmentKey}/runs

GET /api/tenants/{tenantKey}/license/status

Examples

GET /api/tenants/acme/environments/dev/objects

Syntax

POST /api/tenants/{tenantKey}/mcl/execute

Examples

POST /api/tenants/acme/mcl/execute

Syntax

GET /app

Examples

GET /app

Notes

• The first authoring assistants generate reviewable MCL for READDATA and ACTION instead of applying hidden changes.

Syntax

GET /login

POST /login

POST /logout

GET /app

Examples

GET /app

Notes

• The Web surface uses authenticated server-side context instead of exposing operational tokens to the browser.

Syntax

OIDC sign-in model

Server-side session state

Tenant-aware app context

Examples

OIDC sign-in model

Syntax

Read catalog objects

Execute MCL

Run scripts

View diagnostics

Examples

Read catalog objects

Syntax

Browse schemas

Browse CONNECTION, READDATA, WRITEDATA, TRANSFORMATION, DATAFLOW, ACTION, TASK, FLOW

Examples

Browse public schema objects

Syntax

Open script

Execute script

Inspect result tab

Examples

Execute setup-dev.mcl from the Web IDE

Syntax

Result grid

JSON result

Run logs

Server error viewer

Examples

Open run diagnostics after EXECUTE FLOW

Syntax

Visual authoring

FLOW graph viewer

DATAFLOW graph viewer

Object properties authoring

Examples

Inspect DATAFLOW graph

Syntax

metoriq://scripts/...

.mcl

.sql

.json

Examples

metoriq://scripts/dev/load-dimensions.mcl

Syntax

Browse scripts

Pick SQL file

Pick JSON properties file

Examples

Pick metoriq://scripts/sql/dim_brand.sql

Syntax

Managed workspace files

Shared script references

Governed server-side paths

Examples

Reference a shared SQL file from authoring

Syntax

Open managed storage

Inspect folders

Inspect files

Examples

Open managed storage explorer

Syntax

docker compose up

HML update automation

Examples

Run local HML package

Syntax

Workspace status

Provider

Database

Host and port

Next action hint

Examples

Open environment dashboard

Notes

• The card does not expose passwords or connection strings with secrets.

Syntax

CONNECTION

READDATA

WRITEDATA

ACTION

TRANSFORMATION

DATAFLOW

TASK

FLOW

metoriq://scripts/...

Examples

Build a PostgreSQL integration from Web IDE and managed scripts

Syntax

SCHEDULE FLOW KEY <flowKey> ...;

RETRY RUN KEY <run_id>;

CANCEL RUN KEY <run_id>;

Examples

RETRY RUN KEY "<run_id>";