{ "commands": { "ai-policy:create": { "aliases": [], "args": {}, "description": "Create an AI policy variant.\n\nThis endpoint only creates variants, not the default policy. The JSON body must include parentPolicyId, declarationIds, and autonomySliderIds. Use empty arrays to snapshot the parent's currently enabled declarations and sliders.", "examples": [ "<%= config.bin %> ai-policy create --file ai-policy-variant.json", "<%= config.bin %> ai-policy create --file ai-policy-variant.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ai-policy:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create an AI policy variant", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "ai-policy", "create.js" ] }, "ai-policy:disable": { "aliases": [], "args": { "id": { "description": "AI policy ID", "name": "id", "required": true } }, "description": "Disable an AI policy variant by ID.\n\nThis is a soft disable, not a hard delete. The default policy cannot be disabled through this route.", "examples": [ "<%= config.bin %> ai-policy disable " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ai-policy:disable", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Disable an AI policy variant", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "ai-policy", "disable.js" ] }, "ai-policy:get": { "aliases": [], "args": { "id": { "description": "AI policy ID", "name": "id", "required": true } }, "description": "Get an AI policy by ID, including its snapshotted declarations and autonomy sliders.", "examples": [ "<%= config.bin %> ai-policy get ", "<%= config.bin %> ai-policy get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ai-policy:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get an AI policy", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "ai-policy", "get.js" ] }, "ai-policy:list": { "aliases": [], "args": {}, "description": "List AI policies.\n\nIf no policies exist yet, the backend creates a default policy automatically.", "examples": [ "<%= config.bin %> ai-policy list", "<%= config.bin %> ai-policy list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ai-policy:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List AI policies", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "ai-policy", "list.js" ] }, "ai-policy:weight-set": { "aliases": [], "args": { "id": { "description": "AI policy ID", "name": "id", "required": true } }, "description": "Set the selection weight for an AI policy variant.\n\nThis endpoint only updates weight. The default policy cannot be modified through this route.", "examples": [ "<%= config.bin %> ai-policy weight-set --weight 25", "<%= config.bin %> ai-policy weight-set --weight 0 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "weight": { "description": "Non-negative weight used for policy selection", "name": "weight", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ai-policy:weight-set", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Set an AI policy weight", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "ai-policy", "weight-set.js" ] }, "analytics:aggregates": { "aliases": [], "args": {}, "description": "Run an analytics aggregate query.\n\nReads a JSON aggregate query body from stdin or --file.", "examples": [ "<%= config.bin %> analytics aggregates --file aggregates-query.json", "cat aggregates-query.json | <%= config.bin %> analytics aggregates", "<%= config.bin %> analytics aggregates --file aggregates-query.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON aggregate query body (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "analytics:aggregates", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Run an analytics aggregate query", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "analytics", "aggregates.js" ] }, "analytics:automated-insights": { "aliases": [], "args": {}, "description": "Generate automated analytics insights.\n\nReads a JSON analytics query body from stdin or --file.", "examples": [ "<%= config.bin %> analytics automated-insights --file insights-query.json", "cat insights-query.json | <%= config.bin %> analytics automated-insights", "<%= config.bin %> analytics automated-insights --file insights-query.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON analytics query body (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "analytics:automated-insights", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Generate automated analytics insights", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "analytics", "automated-insights.js" ] }, "analytics:query": { "aliases": [], "args": {}, "description": "Execute a SQL query against analytics data (Snowflake SQL dialect).\n\nQuery telemetry data, events, and other analytics tables using Snowflake-compatible SQL.\nUse 'formant analytics tables' to see available tables and their columns.\n\nNote: The analytics engine uses the Snowflake SQL dialect. String comparisons are\ncase-sensitive, use ILIKE for case-insensitive matching, and timestamps should be\nquoted strings (e.g. WHERE time > '2026-01-01'). Large unbounded queries may be\nrejected — always filter by time range for large tables.", "examples": [ "<%= config.bin %> analytics query --sql \"SELECT * FROM query_event WHERE time > '2026-01-01' LIMIT 10\"", "<%= config.bin %> analytics query --sql \"SELECT device_id, avg(value) as avg_val FROM query_numeric WHERE time > '2026-02-01' GROUP BY device_id LIMIT 10\"", "<%= config.bin %> analytics query --sql \"SELECT type, count(*) as cnt FROM query_event WHERE time > '2026-02-01' GROUP BY type ORDER BY cnt DESC LIMIT 5\"", "<%= config.bin %> analytics query --sql \"SELECT * FROM query_event LIMIT 10\" --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "limit": { "char": "l", "description": "Maximum number of rows to return", "name": "limit", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "sql": { "char": "s", "description": "SQL query to execute", "name": "sql", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "type": { "description": "Query type", "name": "type", "default": "advanced", "hasDynamicHelp": false, "multiple": false, "options": [ "stream", "task", "advanced" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "analytics:query", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Execute SQL analytics query", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "analytics", "query.js" ] }, "analytics:streams-filter": { "aliases": [], "args": {}, "description": "Filter analytics streams.\n\nOptionally provide a filter body from stdin or --file.", "examples": [ "<%= config.bin %> analytics streams-filter", "<%= config.bin %> analytics streams-filter --file streams-filter.json", "<%= config.bin %> analytics streams-filter --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON filter body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "analytics:streams-filter", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Filter analytics streams", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "analytics", "streams-filter.js" ] }, "analytics:tables": { "aliases": [], "args": {}, "description": "List available SQL tables for analytics queries.\n\nShows table names, descriptions, and column definitions that can be used\nwith 'formant analytics query'. The analytics engine uses the Snowflake SQL dialect.", "examples": [ "<%= config.bin %> analytics tables", "<%= config.bin %> analytics tables --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "analytics:tables", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List analytics tables", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "analytics", "tables.js" ] }, "analytics:task-reports-filter": { "aliases": [], "args": {}, "description": "Filter analytics task reports.\n\nOptionally provide a filter body from stdin or --file.", "examples": [ "<%= config.bin %> analytics task-reports-filter", "<%= config.bin %> analytics task-reports-filter --file task-reports-filter.json", "<%= config.bin %> analytics task-reports-filter --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON filter body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "analytics:task-reports-filter", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Filter analytics task reports", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "analytics", "task-reports-filter.js" ] }, "annotation:create": { "aliases": [], "args": {}, "description": "Create one or more annotations.\n\nReads JSON from stdin or --file.", "examples": [ "<%= config.bin %> annotation create --file annotation.json", "<%= config.bin %> annotation create --file annotations.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "annotation:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create an annotation", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "annotation", "create.js" ] }, "annotation:delete": { "aliases": [], "args": { "id": { "description": "Annotation ID", "name": "id", "required": true } }, "description": "Delete an annotation by ID.", "examples": [ "<%= config.bin %> annotation delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "annotation:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete an annotation", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "annotation", "delete.js" ] }, "annotation:get": { "aliases": [], "args": { "id": { "description": "Annotation ID", "name": "id", "required": true } }, "description": "Get an annotation by ID.", "examples": [ "<%= config.bin %> annotation get ", "<%= config.bin %> annotation get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "annotation:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get an annotation", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "annotation", "get.js" ] }, "annotation:update": { "aliases": [], "args": { "id": { "description": "Annotation ID", "name": "id", "required": true } }, "description": "Update an annotation.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> annotation update --file changes.json", "echo '{\"note\":\"Updated\"}' | <%= config.bin %> annotation update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "annotation:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update an annotation", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "annotation", "update.js" ] }, "annotation-template:create": { "aliases": [], "args": {}, "description": "Create a new annotation template.\n\nReads JSON from stdin or --file. Pipe output from 'annotation-template get --json' to clone an annotation template.", "examples": [ "<%= config.bin %> annotation-template create --file annotation-template.json", "<%= config.bin %> annotation-template get --json | <%= config.bin %> annotation-template create", "<%= config.bin %> annotation-template list --json | <%= config.bin %> annotation-template create" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "annotation-template:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create an annotation template", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "annotation-template", "create.js" ] }, "annotation-template:delete": { "aliases": [], "args": { "id": { "description": "Annotation template ID (UUID)", "name": "id", "required": true } }, "description": "Delete an annotation template by ID.", "examples": [ "<%= config.bin %> annotation-template delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "annotation-template:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete an annotation template", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "annotation-template", "delete.js" ] }, "annotation-template:disable": { "aliases": [], "args": { "id": { "description": "Annotation template ID (UUID)", "name": "id", "required": true } }, "description": "Disable an annotation template by ID without permanently deleting it.", "examples": [ "<%= config.bin %> annotation-template disable " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "annotation-template:disable", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Disable an annotation template", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "annotation-template", "disable.js" ] }, "annotation-template:get": { "aliases": [], "args": { "id": { "description": "Annotation template ID (UUID)", "name": "id", "required": true } }, "description": "Get detailed information about an annotation template.", "examples": [ "<%= config.bin %> annotation-template get ", "<%= config.bin %> annotation-template get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "annotation-template:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get annotation template details", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "annotation-template", "get.js" ] }, "annotation-template:inspect-spreadsheet": { "aliases": [], "args": {}, "description": "Inspect annotation template spreadsheet content.\n\nReads JSON request body from stdin or --file.", "examples": [ "<%= config.bin %> annotation-template inspect-spreadsheet --file inspect-request.json", "<%= config.bin %> annotation-template inspect-spreadsheet --file inspect-request.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON inspect request body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "annotation-template:inspect-spreadsheet", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Inspect annotation template spreadsheet", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "annotation-template", "inspect-spreadsheet.js" ] }, "annotation-template:list": { "aliases": [], "args": {}, "description": "List all annotation templates in your organization.", "examples": [ "<%= config.bin %> annotation-template list", "<%= config.bin %> annotation-template list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "annotation-template:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List annotation templates", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "annotation-template", "list.js" ] }, "annotation-template:update": { "aliases": [], "args": { "id": { "description": "Annotation template ID (UUID)", "name": "id", "required": true } }, "description": "Update an existing annotation template.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> annotation-template update --file changes.json", "echo '{\"name\":\"new-name\"}' | <%= config.bin %> annotation-template update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "annotation-template:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update an annotation template", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "annotation-template", "update.js" ] }, "api:call": { "aliases": [], "args": { "operationId": { "description": "Operation ID (for example: query.stream-data.query)", "name": "operationId", "required": true } }, "description": "Execute a typed backend operation directly.\n\nUse --path for route params, --query for query params, and --body/--body-file\nfor request payloads.", "examples": [ "<%= config.bin %> api call query.online-devices.list --json", "<%= config.bin %> api call admin.devices.get --path deviceId=dev_123 --json", "<%= config.bin %> api call query.stream-data.query --body-file query.json --json", "<%= config.bin %> api call theopolis.signals.create --body '{\"goal\":\"Investigate\",\"type\":\"manual\"}' --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "body": { "description": "Inline JSON request body", "exclusive": [ "body-file" ], "name": "body", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "body-file": { "description": "Read JSON request body from file path, or \"-\" for stdin", "exclusive": [ "body" ], "name": "body-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "path": { "description": "Path parameter in key=value form (repeatable)", "name": "path", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "query": { "description": "Query parameter in key=value form (repeatable)", "name": "query", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "timeout": { "description": "Request timeout in seconds", "name": "timeout", "default": 120, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "api:call", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Call a typed API operation directly", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "api", "call.js" ] }, "api:describe": { "aliases": [], "args": { "operationId": { "description": "Operation ID (for example: query.stream-data.query)", "name": "operationId", "required": true } }, "description": "Describe one typed backend operation.\n\nShows service target, HTTP method, path template, and required path params.", "examples": [ "<%= config.bin %> api describe query.stream-data.query", "<%= config.bin %> api describe theopolis.signals.create --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "api:describe", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Describe one typed API operation", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "api", "describe.js" ] }, "api:list-operations": { "aliases": [], "args": {}, "description": "List all typed backend operations available to the API fallback commands.", "examples": [ "<%= config.bin %> api list-operations", "<%= config.bin %> api list-operations --target theopolis", "<%= config.bin %> api list-operations --stability stable --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "stability": { "description": "Filter by operation stability", "name": "stability", "hasDynamicHelp": false, "multiple": false, "options": [ "experimental", "stable" ], "type": "option" }, "target": { "description": "Filter by API target service", "name": "target", "hasDynamicHelp": false, "multiple": false, "options": [ "admin", "gateway", "ingest", "query", "theopolis" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "api:list-operations", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List typed API operations", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "api", "list-operations.js" ] }, "auth:login": { "aliases": [], "args": {}, "description": "Store default Formant credentials on this machine.\n\nSaved credentials are used when FORMANT_USER/FORMANT_PASSWORD are not provided\nvia environment variables.", "examples": [ "<%= config.bin %> auth login --user bot@org.iam.formant.io --password \"secret\"", "<%= config.bin %> auth login --user bot@org.iam.formant.io --password \"secret\" --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "password": { "char": "p", "description": "Service account password", "env": "FORMANT_PASSWORD", "name": "password", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "user": { "char": "u", "description": "Service account email", "env": "FORMANT_USER", "name": "user", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "auth:login", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Store default credentials", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "auth", "login.js" ] }, "auth:logout": { "aliases": [], "args": {}, "description": "Remove stored default credentials from this machine.", "examples": [ "<%= config.bin %> auth logout", "<%= config.bin %> auth logout --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "auth:logout", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Remove stored default credentials", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "auth", "logout.js" ] }, "auth:status": { "aliases": [], "args": {}, "description": "Show credential configuration status.\n\nDisplays whether credentials are currently sourced from environment variables or\nthe stored default credentials file.", "examples": [ "<%= config.bin %> auth status", "<%= config.bin %> auth status --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "auth:status", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Show credential source and storage status", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "auth", "status.js" ] }, "autonomy:create": { "aliases": [], "args": {}, "description": "Create one or more autonomy sliders.\n\nReads JSON from stdin or --file.", "examples": [ "<%= config.bin %> autonomy create --file autonomy.json", "<%= config.bin %> autonomy create --file autonomy-sliders.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "autonomy:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create an autonomy slider", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "autonomy", "create.js" ] }, "autonomy:delete": { "aliases": [], "args": { "id": { "description": "Autonomy slider ID", "name": "id", "required": true } }, "description": "Delete an autonomy slider by ID.", "examples": [ "<%= config.bin %> autonomy delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "autonomy:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete an autonomy slider", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "autonomy", "delete.js" ] }, "autonomy:get": { "aliases": [], "args": { "id": { "description": "Autonomy slider ID", "name": "id", "required": true } }, "description": "Get an autonomy slider by ID.", "examples": [ "<%= config.bin %> autonomy get ", "<%= config.bin %> autonomy get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "autonomy:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get an autonomy slider", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "autonomy", "get.js" ] }, "autonomy:list": { "aliases": [], "args": {}, "description": "List autonomy sliders.", "examples": [ "<%= config.bin %> autonomy list", "<%= config.bin %> autonomy list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "autonomy:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List autonomy sliders", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "autonomy", "list.js" ] }, "autonomy:suggestions-generate": { "aliases": [], "args": {}, "description": "Generate autonomy-slider suggestions from feedback and human-approval patterns.\n\nThis may take longer than ordinary CRUD calls because the backend runs an AI analysis job.", "examples": [ "<%= config.bin %> autonomy suggestions-generate", "<%= config.bin %> autonomy suggestions-generate --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "autonomy:suggestions-generate", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Generate autonomy suggestions", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "autonomy", "suggestions-generate.js" ] }, "autonomy:update": { "aliases": [], "args": { "id": { "description": "Autonomy slider ID", "name": "id", "required": true } }, "description": "Update an autonomy slider.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> autonomy update --file changes.json", "echo '{\"level\":\"high\"}' | <%= config.bin %> autonomy update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "autonomy:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update an autonomy slider", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "autonomy", "update.js" ] }, "board-column:create": { "aliases": [], "args": {}, "description": "Create a new board column.\n\nReads JSON from stdin or --file.", "examples": [ "<%= config.bin %> board-column create --file board-column.json", "echo '{\"name\":\"Needs Review\",\"position\":2}' | <%= config.bin %> board-column create" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "board-column:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a board column", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "board-column", "create.js" ] }, "board-column:delete": { "aliases": [], "args": { "id": { "description": "Board column ID (UUID)", "name": "id", "required": true } }, "description": "Delete a board column by ID.", "examples": [ "<%= config.bin %> board-column delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "board-column:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete a board column", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "board-column", "delete.js" ] }, "board-column:get": { "aliases": [], "args": { "id": { "description": "Board column ID (UUID)", "name": "id", "required": true } }, "description": "Get detailed information about a board column.", "examples": [ "<%= config.bin %> board-column get ", "<%= config.bin %> board-column get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "board-column:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get board column details", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "board-column", "get.js" ] }, "board-column:list": { "aliases": [], "args": {}, "description": "List investigation board columns.", "examples": [ "<%= config.bin %> board-column list", "<%= config.bin %> board-column list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "board-column:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List board columns", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "board-column", "list.js" ] }, "board-column:update": { "aliases": [], "args": { "id": { "description": "Board column ID (UUID)", "name": "id", "required": true } }, "description": "Update an existing board column.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> board-column update --file board-column-update.json", "echo '{\"name\":\"Escalated\",\"position\":1}' | <%= config.bin %> board-column update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "board-column:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a board column", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "board-column", "update.js" ] }, "channel:create": { "aliases": [], "args": {}, "description": "Create a new channel.\n\nReads JSON from stdin or --file. Pipe output from 'channel get --json' to clone a channel.", "examples": [ "<%= config.bin %> channel create --file channel.json", "<%= config.bin %> channel get --json | <%= config.bin %> channel create", "<%= config.bin %> channel list --json | <%= config.bin %> channel create" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "channel:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a channel", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "channel", "create.js" ] }, "channel:delete": { "aliases": [], "args": { "id": { "description": "Channel ID (UUID)", "name": "id", "required": true } }, "description": "Delete a channel by ID.", "examples": [ "<%= config.bin %> channel delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "channel:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete a channel", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "channel", "delete.js" ] }, "channel:get": { "aliases": [], "args": { "id": { "description": "Channel ID (UUID)", "name": "id", "required": true } }, "description": "Get detailed information about a channel.", "examples": [ "<%= config.bin %> channel get ", "<%= config.bin %> channel get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "channel:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get channel details", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "channel", "get.js" ] }, "channel:list": { "aliases": [], "args": {}, "description": "List all channels in your organization.", "examples": [ "<%= config.bin %> channel list", "<%= config.bin %> channel list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "channel:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List channels", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "channel", "list.js" ] }, "channel:update": { "aliases": [], "args": { "id": { "description": "Channel ID (UUID)", "name": "id", "required": true } }, "description": "Update an existing channel.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> channel update --file changes.json", "echo '{\"name\":\"new-name\"}' | <%= config.bin %> channel update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "channel:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a channel", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "channel", "update.js" ] }, "channel-monitor:create": { "aliases": [], "args": {}, "description": "Create a channel monitor that binds a Slack, Teams, or SMS channel to a taskflow.\n\nReads JSON from stdin or --file.", "examples": [ "<%= config.bin %> channel-monitor create --file monitor.json", "echo '{\"platform\":\"slack\",\"channelId\":\"C123\",\"channelName\":\"ops\",\"taskFlowId\":\"\"}' | <%= config.bin %> channel-monitor create" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "channel-monitor:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a channel monitor", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "channel-monitor", "create.js" ] }, "channel-monitor:disable": { "aliases": [], "args": { "id": { "description": "Channel monitor ID (UUID)", "name": "id", "required": true } }, "description": "Disable a channel monitor by ID. This is a soft disable, not a hard delete.", "examples": [ "<%= config.bin %> channel-monitor disable " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "channel-monitor:disable", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Disable a channel monitor", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "channel-monitor", "disable.js" ] }, "channel-monitor:get": { "aliases": [], "args": { "id": { "description": "Channel monitor ID (UUID)", "name": "id", "required": true } }, "description": "Get a channel monitor by ID.", "examples": [ "<%= config.bin %> channel-monitor get ", "<%= config.bin %> channel-monitor get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "channel-monitor:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get a channel monitor", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "channel-monitor", "get.js" ] }, "channel-monitor:list": { "aliases": [], "args": {}, "description": "List enabled channel monitors, optionally filtered by platform.", "examples": [ "<%= config.bin %> channel-monitor list", "<%= config.bin %> channel-monitor list --platform slack", "<%= config.bin %> channel-monitor list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "platform": { "description": "Filter by channel platform", "name": "platform", "hasDynamicHelp": false, "multiple": false, "options": [ "slack", "sms", "teams" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "channel-monitor:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List channel monitors", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "channel-monitor", "list.js" ] }, "channel-monitor:update": { "aliases": [], "args": { "id": { "description": "Channel monitor ID (UUID)", "name": "id", "required": true } }, "description": "Update a channel monitor.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> channel-monitor update --file changes.json", "echo '{\"botFilterMode\":\"regex\",\"botFilterPattern\":\"^ops-.*\"}' | <%= config.bin %> channel-monitor update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "channel-monitor:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a channel monitor", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "channel-monitor", "update.js" ] }, "command:create": { "aliases": [], "args": {}, "description": "Create a new command template.\n\nReads JSON from stdin or --file. Pipe output from 'command get --json' to clone a command template.", "examples": [ "<%= config.bin %> command create --file command.json", "<%= config.bin %> command get --json | <%= config.bin %> command create", "<%= config.bin %> command list --json | <%= config.bin %> command create" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "command:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a command template", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "command", "create.js" ] }, "command:delete": { "aliases": [], "args": { "id": { "description": "Command template ID (UUID)", "name": "id", "required": true } }, "description": "Delete a command template by ID.", "examples": [ "<%= config.bin %> command delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "command:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete a command template", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "command", "delete.js" ] }, "command:for-device": { "aliases": [], "args": { "deviceId": { "description": "Device ID (UUID)", "name": "deviceId", "required": true } }, "description": "List command templates available for a specific device.\n\nReturns commands that match the device's tags and filters. Only enabled commands\nthat apply to this device are shown.", "examples": [ "<%= config.bin %> command for-device ", "<%= config.bin %> command for-device --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "command:for-device", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List commands available for a device", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "command", "for-device.js" ] }, "command:get": { "aliases": [], "args": { "id": { "description": "Command template ID (UUID)", "name": "id", "required": true } }, "description": "Get detailed information about a command template.\n\nShows the full template configuration including command string, parameter schema,\ndevice targeting filters, and delivery settings. If the template has structured\nparameters (schema), they are displayed in a readable format.", "examples": [ "<%= config.bin %> command get ", "<%= config.bin %> command get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "command:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get command template details", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "command", "get.js" ] }, "command:history": { "aliases": [], "args": {}, "description": "Query command history for a device.\n\nShows commands that have been sent to a device, including delivery status and responses.\nUse this to check if commands were delivered and executed successfully.", "examples": [ "<%= config.bin %> command history --device ", "<%= config.bin %> command history --device --limit 50", "<%= config.bin %> command history --device --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "device": { "char": "d", "description": "Device ID (UUID)", "name": "device", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit": { "char": "l", "description": "Maximum number of commands to return", "name": "limit", "default": 25, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "command:history", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Query command history", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "command", "history.js" ] }, "command:list": { "aliases": [], "args": {}, "description": "List all command templates defined in your organization.\n\nCommand templates define the commands that can be sent to devices. Each template\nspecifies the command string, parameters, delivery settings, and device targeting.", "examples": [ "<%= config.bin %> command list", "<%= config.bin %> command list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "command:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List command templates", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "command", "list.js" ] }, "command:send": { "aliases": [], "args": { "deviceId": { "description": "Device ID (UUID)", "name": "deviceId", "required": true }, "templateId": { "description": "Command template ID (UUID)", "name": "templateId", "required": true } }, "description": "Send a command to a device using a command template.\n\nFetches the template, validates parameters against its schema, and sends the command\nto the specified device. Use --param flags to override parameter values.\n\nFor templates with structured parameters (schema), parameter names and types are\nvalidated. For unstructured parameters, the raw value is sent as-is.\n\nUse --dry-run to preview the payload without actually sending.", "examples": [ "<%= config.bin %> command send ", "<%= config.bin %> command send --param speed=5 --param mode=fast", "<%= config.bin %> command send --dry-run", "<%= config.bin %> command send --raw-value '{\"x\":1,\"y\":2}'", "<%= config.bin %> command send --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "dry-run": { "description": "Preview the command payload without sending", "name": "dry-run", "allowNo": false, "type": "boolean" }, "param": { "char": "p", "description": "Parameter override (name=value), can be specified multiple times", "name": "param", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "raw-value": { "description": "Send a raw parameter value string (bypasses schema validation)", "name": "raw-value", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "command:send", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Send a command to a device", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "command", "send.js" ] }, "command:update": { "aliases": [], "args": { "id": { "description": "Command template ID (UUID)", "name": "id", "required": true } }, "description": "Update an existing command template.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> command update --file changes.json", "echo '{\"name\":\"new-name\"}' | <%= config.bin %> command update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "command:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a command template", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "command", "update.js" ] }, "comment:create": { "aliases": [], "args": {}, "description": "Create one or more comments.\n\nReads JSON from stdin or --file.", "examples": [ "<%= config.bin %> comment create --file comment.json", "<%= config.bin %> comment create --file comments.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "comment:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a comment", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "comment", "create.js" ] }, "comment:delete": { "aliases": [], "args": { "id": { "description": "Comment ID", "name": "id", "required": true } }, "description": "Delete a comment by ID.", "examples": [ "<%= config.bin %> comment delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "comment:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete a comment", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "comment", "delete.js" ] }, "comment:get": { "aliases": [], "args": { "id": { "description": "Comment ID", "name": "id", "required": true } }, "description": "Get a comment by ID.", "examples": [ "<%= config.bin %> comment get ", "<%= config.bin %> comment get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "comment:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get a comment", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "comment", "get.js" ] }, "comment:update": { "aliases": [], "args": { "id": { "description": "Comment ID", "name": "id", "required": true } }, "description": "Update a comment.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> comment update --file changes.json", "echo '{\"message\":\"Updated\"}' | <%= config.bin %> comment update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "comment:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a comment", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "comment", "update.js" ] }, "config-template:apply": { "aliases": [], "args": { "id": { "description": "Configuration template ID (UUID)", "name": "id", "required": true } }, "description": "Apply a configuration template to devices.\n\nFor each targeted device, this command creates a new configuration version using\nthe template document and preserves the device's current tags. By default, it\napplies only to explicitly selected targets. Use --dry-run to preview changes.", "examples": [ "<%= config.bin %> config-template apply --device ", "<%= config.bin %> config-template apply --tag location=warehouse --tag env=prod", "<%= config.bin %> config-template apply --all --dry-run" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "all": { "description": "Apply to all enabled default devices", "name": "all", "allowNo": false, "type": "boolean" }, "device": { "char": "d", "description": "Target device ID (UUID), can be specified multiple times", "name": "device", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "dry-run": { "description": "Preview target devices without applying changes", "name": "dry-run", "allowNo": false, "type": "boolean" }, "tag": { "char": "t", "description": "Target devices by tag (key=value), can be specified multiple times", "name": "tag", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "config-template:apply", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Apply a config template to devices", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "config-template", "apply.js" ] }, "config-template:create": { "aliases": [], "args": {}, "description": "Create a new config template.\n\nReads JSON from stdin or --file. Pipe output from 'config-template get --json' to clone a config template.", "examples": [ "<%= config.bin %> config-template create --file config-template.json", "<%= config.bin %> config-template get --json | <%= config.bin %> config-template create", "<%= config.bin %> config-template list --json | <%= config.bin %> config-template create" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "config-template:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a config template", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "config-template", "create.js" ] }, "config-template:delete": { "aliases": [], "args": { "id": { "description": "Config template ID (UUID)", "name": "id", "required": true } }, "description": "Delete a config template by ID.", "examples": [ "<%= config.bin %> config-template delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "config-template:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete a config template", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "config-template", "delete.js" ] }, "config-template:get": { "aliases": [], "args": { "id": { "description": "Config template ID (UUID)", "name": "id", "required": true } }, "description": "Get detailed information about a config template.", "examples": [ "<%= config.bin %> config-template get ", "<%= config.bin %> config-template get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "config-template:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get config template details", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "config-template", "get.js" ] }, "config-template:list": { "aliases": [], "args": {}, "description": "List all config templates in your organization.", "examples": [ "<%= config.bin %> config-template list", "<%= config.bin %> config-template list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "config-template:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List config templates", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "config-template", "list.js" ] }, "config-template:update": { "aliases": [], "args": { "id": { "description": "Config template ID (UUID)", "name": "id", "required": true } }, "description": "Update an existing config template.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> config-template update --file changes.json", "echo '{\"name\":\"new-name\"}' | <%= config.bin %> config-template update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "config-template:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a config template", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "config-template", "update.js" ] }, "declaration:create": { "aliases": [], "args": {}, "description": "Create one or more declarations.\n\nDeclarations are organizational mandates or guardrails. Reads JSON from stdin or --file.", "examples": [ "<%= config.bin %> declaration create --file declaration.json", "<%= config.bin %> declaration create --file declarations.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "declaration:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a declaration", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "declaration", "create.js" ] }, "declaration:disable": { "aliases": [], "args": { "id": { "description": "Declaration ID", "name": "id", "required": true } }, "description": "Disable a declaration by ID. This is a soft disable, not a hard delete.", "examples": [ "<%= config.bin %> declaration disable " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "declaration:disable", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Disable a declaration", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "declaration", "disable.js" ] }, "declaration:get": { "aliases": [], "args": { "id": { "description": "Declaration ID", "name": "id", "required": true } }, "description": "Get a declaration by ID.", "examples": [ "<%= config.bin %> declaration get ", "<%= config.bin %> declaration get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "declaration:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get a declaration", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "declaration", "get.js" ] }, "declaration:list": { "aliases": [], "args": {}, "description": "List declarations, optionally filtered by type.", "examples": [ "<%= config.bin %> declaration list", "<%= config.bin %> declaration list --type mandate", "<%= config.bin %> declaration list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "type": { "description": "Filter by declaration type", "name": "type", "hasDynamicHelp": false, "multiple": false, "options": [ "guardrail", "mandate" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "declaration:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List declarations", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "declaration", "list.js" ] }, "declaration:suggestions-generate": { "aliases": [], "args": {}, "description": "Generate declaration suggestions from feedback and human-approval patterns.\n\nThis may take longer than ordinary CRUD calls because the backend runs an AI analysis job.", "examples": [ "<%= config.bin %> declaration suggestions-generate", "<%= config.bin %> declaration suggestions-generate --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "declaration:suggestions-generate", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Generate declaration suggestions", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "declaration", "suggestions-generate.js" ] }, "declaration:update": { "aliases": [], "args": { "id": { "description": "Declaration ID", "name": "id", "required": true } }, "description": "Update a declaration.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> declaration update --file changes.json", "echo '{\"message\":\"Updated mandate\",\"type\":\"mandate\"}' | <%= config.bin %> declaration update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "declaration:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a declaration", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "declaration", "update.js" ] }, "device:apply-config": { "aliases": [], "args": { "id": { "description": "Device ID (UUID)", "name": "id", "required": true } }, "description": "Apply a device configuration document.\n\nCreates a new configuration version and sets it as the desired version for the\ndevice, which is then synced to the agent. Reads JSON from stdin or --file.", "examples": [ "<%= config.bin %> device apply-config --file config.json", "<%= config.bin %> device config --json | <%= config.bin %> device apply-config ", "<%= config.bin %> config-template get --json | jq '{document: .document}' | <%= config.bin %> device apply-config " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "device:apply-config", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Apply a configuration to a device", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "device", "apply-config.js" ] }, "device:config": { "aliases": [], "args": { "id": { "description": "Device ID (UUID)", "name": "id", "required": true } }, "description": "Get the device configuration including stream definitions.\n\nShows the device's current configuration including telemetry streams, commands,\nand other settings.", "examples": [ "<%= config.bin %> device config ", "<%= config.bin %> device config --version 3", "<%= config.bin %> device config --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "version": { "description": "Specific configuration version to fetch (defaults to desired version)", "name": "version", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "device:config", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get device configuration", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "device", "config.js" ] }, "device:count": { "aliases": [], "args": {}, "description": "Count devices.\n\nOptionally provide a filter body from stdin or --file.", "examples": [ "<%= config.bin %> device count", "<%= config.bin %> device count --file device-query.json", "<%= config.bin %> device count --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON filter body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "device:count", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Count devices", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "device", "count.js" ] }, "device:create": { "aliases": [], "args": { "name": { "description": "Name for the new device", "name": "name", "required": true } }, "description": "Create a new device in your fleet.\n\nThe device is created as enabled by default. You can optionally specify tags.", "examples": [ "<%= config.bin %> device create my-robot", "<%= config.bin %> device create my-robot --tag location=warehouse --tag env=prod", "<%= config.bin %> device create my-robot --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "tag": { "char": "t", "description": "Tag to apply (key=value), can be specified multiple times", "name": "tag", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "device:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a new device", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "device", "create.js" ] }, "device:details-get": { "aliases": [], "args": { "id": { "description": "Device ID (UUID)", "name": "id", "required": true } }, "description": "Get detailed device metadata by device ID.", "examples": [ "<%= config.bin %> device details-get ", "<%= config.bin %> device details-get --fill-online-status --fill-last-seen --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "fill-last-seen": { "description": "Request last-seen information when available", "name": "fill-last-seen", "allowNo": false, "type": "boolean" }, "fill-online-status": { "description": "Request online-status information when available", "name": "fill-online-status", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "device:details-get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get device details", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "device", "details-get.js" ] }, "device:details-query": { "aliases": [], "args": {}, "description": "Query device details with a JSON device query body.\n\nOptionally provide a JSON request body from stdin or --file. With no input, the backend default query is used.", "examples": [ "<%= config.bin %> device details-query", "<%= config.bin %> device details-query --file device-query.json", "<%= config.bin %> device details-query --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON device-details query body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "device:details-query", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Query device details", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "device", "details-query.js" ] }, "device:disable": { "aliases": [], "args": { "id": { "description": "Device ID (UUID)", "name": "id", "required": true } }, "description": "Disable a device.", "examples": [ "<%= config.bin %> device disable ", "<%= config.bin %> device disable --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "device:disable", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Disable a device", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "device", "disable.js" ] }, "device:enabled-list": { "aliases": [], "args": {}, "description": "List enabled devices.\n\nOptionally provide a filter body from stdin or --file.", "examples": [ "<%= config.bin %> device enabled-list", "<%= config.bin %> device enabled-list --file device-query.json", "<%= config.bin %> device enabled-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON filter body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "device:enabled-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List enabled devices", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "device", "enabled-list.js" ] }, "device:get": { "aliases": [], "args": { "id": { "description": "Device ID (UUID)", "name": "id", "required": true } }, "description": "Get detailed information about a specific device by its ID.", "examples": [ "<%= config.bin %> device get ", "<%= config.bin %> device get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "device:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get a device by ID", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "device", "get.js" ] }, "device:latest-health-event": { "aliases": [], "args": { "id": { "description": "Device ID (UUID)", "name": "id", "required": true } }, "description": "Get the latest health event for a device.", "examples": [ "<%= config.bin %> device latest-health-event ", "<%= config.bin %> device latest-health-event --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "device:latest-health-event", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get latest device health event", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "device", "latest-health-event.js" ] }, "device:list": { "aliases": [], "args": {}, "description": "List robots and sensors in your fleet. Shows only online devices by default.\n\nUse --include-offline to include offline devices. Use --with-data to show only\ndevices that have ingested data. Each device is enriched with data-based last\nseen timestamp and datapoint count from analytics.", "examples": [ "<%= config.bin %> device list", "<%= config.bin %> device list --include-offline", "<%= config.bin %> device list --with-data", "<%= config.bin %> device list --with-data --days 90", "<%= config.bin %> device list --include-offline --limit 100", "<%= config.bin %> device list --tag location=warehouse", "<%= config.bin %> device list --name robot --dev --json", "<%= config.bin %> device list --name mech-0 --name mech-1 --dev --toon" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "include-offline": { "char": "a", "description": "Include offline devices", "name": "include-offline", "allowNo": false, "type": "boolean" }, "days": { "description": "How many days back to search for last seen data", "name": "days", "default": 30, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit": { "char": "l", "description": "Maximum number of devices to return", "name": "limit", "default": 50, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "char": "n", "description": "Filter devices by name (search), can be specified multiple times", "name": "name", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "with-data": { "char": "w", "description": "Only show devices that have data in the last --days window", "name": "with-data", "allowNo": false, "type": "boolean" }, "tag": { "char": "t", "description": "Filter by tag (key=value), can be specified multiple times", "name": "tag", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "device:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List robots and sensors in your fleet", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "device", "list.js" ] }, "device:provisioning-token-create": { "aliases": [], "args": { "id": { "description": "Device ID (UUID)", "name": "id", "required": true } }, "description": "Create a provisioning token for a device.\n\nOptionally provide request JSON from stdin or --file.", "examples": [ "<%= config.bin %> device provisioning-token-create ", "<%= config.bin %> device provisioning-token-create --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON request body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "device:provisioning-token-create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create device provisioning token", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "device", "provisioning-token-create.js" ] }, "device:rename": { "aliases": [], "args": { "id": { "description": "Device ID (UUID)", "name": "id", "required": true }, "name": { "description": "New name for the device", "name": "name", "required": true } }, "description": "Rename a device by updating its name.", "examples": [ "<%= config.bin %> device rename new-robot-name", "<%= config.bin %> device rename new-robot-name --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "device:rename", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Rename a device", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "device", "rename.js" ] }, "device:streams": { "aliases": [], "args": { "id": { "description": "Device ID (UUID)", "name": "id", "required": true } }, "description": "List telemetry streams for a device with data presence.\n\nShows streams from the device configuration and any streams discovered from\ningested data. Each stream is enriched with presence info from the analytics\nbackend: data point count, last seen time, and a freshness indicator\n(active/recent/stale/dormant).\n\nUnconfigured streams (discovered from data only) are marked with SOURCE \"data\".", "examples": [ "<%= config.bin %> device streams ", "<%= config.bin %> device streams --with-data", "<%= config.bin %> device streams --with-data --days 30", "<%= config.bin %> device streams --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "days": { "description": "How many days back to look for stream data presence", "name": "days", "default": 7, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "with-data": { "char": "w", "description": "Only show streams that have data in the --days window", "name": "with-data", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "device:streams", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List device streams with data presence", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "device", "streams.js" ] }, "device:tag-history-list": { "aliases": [], "args": { "id": { "description": "Device ID (UUID)", "name": "id", "required": true } }, "description": "List tag history entries for a device.", "examples": [ "<%= config.bin %> device tag-history-list ", "<%= config.bin %> device tag-history-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "device:tag-history-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List device tag history", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "device", "tag-history-list.js" ] }, "device:tag": { "aliases": [], "args": { "id": { "description": "Device ID (UUID)", "name": "id", "required": true } }, "description": "Add or update tags on a device.\n\nTags are key-value pairs. If a tag key already exists, its value will be updated.\nSpecify one or more tags with --tag key=value.", "examples": [ "<%= config.bin %> device tag --tag location=warehouse", "<%= config.bin %> device tag --tag env=prod --tag region=us-east", "<%= config.bin %> device tag --tag location=factory --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "tag": { "char": "t", "description": "Tag to add or update (key=value), can be specified multiple times", "name": "tag", "required": true, "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "device:tag", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Add or update tags on a device", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "device", "tag.js" ] }, "device:tags-list": { "aliases": [], "args": {}, "description": "List device tags from query scope.\n\nOptionally provide a filter body from stdin or --file.", "examples": [ "<%= config.bin %> device tags-list", "<%= config.bin %> device tags-list --file device-query.json", "<%= config.bin %> device tags-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON filter body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "device:tags-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List device tags", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "device", "tags-list.js" ] }, "device:unprovision": { "aliases": [], "args": { "id": { "description": "Device ID (UUID)", "name": "id", "required": true } }, "description": "Unprovision a device.", "examples": [ "<%= config.bin %> device unprovision ", "<%= config.bin %> device unprovision --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "device:unprovision", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Unprovision a device", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "device", "unprovision.js" ] }, "device:untag": { "aliases": [], "args": { "id": { "description": "Device ID (UUID)", "name": "id", "required": true } }, "description": "Remove tags from a device.\n\nSpecify one or more tag keys to remove with --key.", "examples": [ "<%= config.bin %> device untag --key location", "<%= config.bin %> device untag --key env --key region", "<%= config.bin %> device untag --key location --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "key": { "char": "k", "description": "Tag key to remove, can be specified multiple times", "name": "key", "required": true, "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "device:untag", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Remove tags from a device", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "device", "untag.js" ] }, "device:updated-configuration-get": { "aliases": [], "args": { "id": { "description": "Device ID (UUID)", "name": "id", "required": true } }, "description": "Get the updated desired configuration currently generated for a device.", "examples": [ "<%= config.bin %> device updated-configuration-get ", "<%= config.bin %> device updated-configuration-get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "device:updated-configuration-get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get device updated configuration", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "device", "updated-configuration-get.js" ] }, "device:validate-stream-config": { "aliases": [], "args": {}, "description": "Validate one or more stream configurations.\n\nReads JSON from stdin or --file and validates each stream against the admin API\nschema (same validation used by the app). Accepted input shapes:\n- [stream, ...]\n- {\"streams\":[...]}\n- {\"telemetry\":{\"streams\":[...]}}\n- {\"document\":{\"telemetry\":{\"streams\":[...]}}}\n- single stream object {\"name\":\"...\",\"configuration\":{...}}", "examples": [ "<%= config.bin %> device validate-stream-config --file stream.json", "<%= config.bin %> device validate-stream-config --file streams.json", "<%= config.bin %> device config --json | <%= config.bin %> device validate-stream-config" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "device:validate-stream-config", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Validate stream configuration", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "device", "validate-stream-config.js" ] }, "document:list-docs": { "aliases": [], "args": { "set-id": { "description": "Document set ID", "name": "set-id", "required": true } }, "description": "List documents within a document set.", "examples": [ "<%= config.bin %> document list-docs ", "<%= config.bin %> document list-docs --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "document:list-docs", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List documents in a set", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "document", "list-docs.js" ] }, "document:list": { "aliases": [], "args": {}, "description": "List all document sets in your organization.", "examples": [ "<%= config.bin %> document list", "<%= config.bin %> document list --json", "<%= config.bin %> document list --toon" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "document:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List document sets", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "document", "list.js" ] }, "document:query-multi": { "aliases": [], "args": { "question": { "description": "Question to ask across document sets", "name": "question", "required": true } }, "description": "RAG query across multiple document sets. Returns chunk results and optionally an LLM-generated answer.", "examples": [ "<%= config.bin %> document query-multi \"What is X?\" --sets id1,id2", "<%= config.bin %> document query-multi \"How does Y work?\" --sets id1,id2 --no-answer", "<%= config.bin %> document query-multi \"Find Z\" --sets id1 --doc-names file1.pdf,file2.pdf --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "doc-names": { "description": "Filter by document names (comma-separated)", "name": "doc-names", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-answer": { "description": "Skip LLM answer generation, return only chunks", "name": "no-answer", "allowNo": false, "type": "boolean" }, "sets": { "description": "Comma-separated document set IDs", "name": "sets", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "document:query-multi", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Query across multiple document sets", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "document", "query-multi.js" ] }, "document:query": { "aliases": [], "args": { "set-id": { "description": "Document set ID", "name": "set-id", "required": true }, "question": { "description": "Question to ask", "name": "question", "required": true } }, "description": "RAG query a single document set.", "examples": [ "<%= config.bin %> document query \"What is the deployment process?\"", "<%= config.bin %> document query \"How do I configure X?\" --top-k 10", "<%= config.bin %> document query \"Summarize this\" --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "top-k": { "description": "Number of source chunks to return", "name": "top-k", "default": 5, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "document:query", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Query a document set", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "document", "query.js" ] }, "event:annotation-templates-list": { "aliases": [], "args": {}, "description": "List event annotation templates.\n\nOptionally provide a filter body from stdin or --file.", "examples": [ "<%= config.bin %> event annotation-templates-list", "<%= config.bin %> event annotation-templates-list --file event-filter.json", "<%= config.bin %> event annotation-templates-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON filter body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event:annotation-templates-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List event annotation templates", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event", "annotation-templates-list.js" ] }, "event:count": { "aliases": [], "args": {}, "description": "Count events.\n\nOptionally provide a filter body from stdin or --file.", "examples": [ "<%= config.bin %> event count", "<%= config.bin %> event count --file event-filter.json", "<%= config.bin %> event count --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON filter body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event:count", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Count events", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event", "count.js" ] }, "event:counts-by-device": { "aliases": [], "args": {}, "description": "Get event counts by device.\n\nOptionally provide a filter body from stdin or --file.", "examples": [ "<%= config.bin %> event counts-by-device", "<%= config.bin %> event counts-by-device --file event-filter.json", "<%= config.bin %> event counts-by-device --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON filter body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event:counts-by-device", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get event counts by device", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event", "counts-by-device.js" ] }, "event:counts": { "aliases": [], "args": {}, "description": "Get event counts.\n\nOptionally provide a filter body from stdin or --file.", "examples": [ "<%= config.bin %> event counts", "<%= config.bin %> event counts --file event-filter.json", "<%= config.bin %> event counts --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON filter body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event:counts", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get event counts", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event", "counts.js" ] }, "event:devices-list": { "aliases": [], "args": {}, "description": "List devices in event query scope.\n\nOptionally provide a filter body from stdin or --file.", "examples": [ "<%= config.bin %> event devices-list", "<%= config.bin %> event devices-list --file event-filter.json", "<%= config.bin %> event devices-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON filter body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event:devices-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List devices in event scope", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event", "devices-list.js" ] }, "event:event-types-list": { "aliases": [], "args": {}, "description": "List event types.\n\nOptionally provide a filter body from stdin or --file.", "examples": [ "<%= config.bin %> event event-types-list", "<%= config.bin %> event event-types-list --file event-filter.json", "<%= config.bin %> event event-types-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON filter body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event:event-types-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List event types", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event", "event-types-list.js" ] }, "event:export-sheet-create": { "aliases": [], "args": {}, "description": "Export event query results to a sheet.\n\nReads JSON request body from stdin or --file.", "examples": [ "<%= config.bin %> event export-sheet-create --file event-export.json", "<%= config.bin %> event export-sheet-create --file event-export.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON request body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event:export-sheet-create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Export event query results to sheet", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event", "export-sheet-create.js" ] }, "event:get": { "aliases": [], "args": { "id": { "description": "Event ID (UUID)", "name": "id", "required": true } }, "description": "Get detailed information about a specific event by its ID.", "examples": [ "<%= config.bin %> event get ", "<%= config.bin %> event get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get an event by ID", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event", "get.js" ] }, "event:histogram": { "aliases": [], "args": {}, "description": "Get an event histogram.\n\nOptionally provide a histogram request body from stdin or --file.", "examples": [ "<%= config.bin %> event histogram", "<%= config.bin %> event histogram --file histogram-query.json", "<%= config.bin %> event histogram --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON histogram request body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event:histogram", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get event histogram", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event", "histogram.js" ] }, "event:list": { "aliases": [], "args": {}, "description": "View important events emitted by devices with optional filters.\n\nEvents are significant occurrences from robots and sensors (e.g., device online/offline,\nerrors, state changes, commands). They can trigger signals for investigation.\n\nEvent types include: triggered-event, datapoint-event, device-online, device-offline,\nintervention-request, intervention-response, teleop-session-record, command-request,\ncommand-response, custom, comment, system, annotation, task-summary, stateful.\n\nSeverities: info, warning, error, critical.", "examples": [ "<%= config.bin %> event list", "<%= config.bin %> event list --device --severity critical", "<%= config.bin %> event list --type device-offline --start 2026-01-01 --end 2026-01-02", "<%= config.bin %> event list --limit 100 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "device": { "char": "d", "description": "Filter by device ID", "name": "device", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "end": { "description": "End time (ISO 8601)", "name": "end", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit": { "char": "l", "description": "Maximum number of events to return", "name": "limit", "default": 25, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "severity": { "description": "Filter by severity", "name": "severity", "hasDynamicHelp": false, "multiple": false, "options": [ "info", "warning", "error", "critical" ], "type": "option" }, "start": { "description": "Start time (ISO 8601)", "name": "start", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "type": { "description": "Filter by event type", "name": "type", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "View events emitted by devices", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event", "list.js" ] }, "event:seek": { "aliases": [], "args": {}, "description": "Seek to an event near a timestamp.\n\nOptionally provide a seek request body from stdin or --file.", "examples": [ "<%= config.bin %> event seek", "<%= config.bin %> event seek --file seek-query.json", "<%= config.bin %> event seek --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON seek request body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event:seek", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Seek to event near a timestamp", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event", "seek.js" ] }, "event:severities-list": { "aliases": [], "args": {}, "description": "List event severities.\n\nOptionally provide a filter body from stdin or --file.", "examples": [ "<%= config.bin %> event severities-list", "<%= config.bin %> event severities-list --file event-filter.json", "<%= config.bin %> event severities-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON filter body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event:severities-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List event severities", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event", "severities-list.js" ] }, "event:stream-names-list": { "aliases": [], "args": {}, "description": "List event stream names.\n\nOptionally provide a filter body from stdin or --file.", "examples": [ "<%= config.bin %> event stream-names-list", "<%= config.bin %> event stream-names-list --file event-filter.json", "<%= config.bin %> event stream-names-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON filter body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event:stream-names-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List event stream names", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event", "stream-names-list.js" ] }, "event:stream-types-list": { "aliases": [], "args": {}, "description": "List event stream types.\n\nOptionally provide a filter body from stdin or --file.", "examples": [ "<%= config.bin %> event stream-types-list", "<%= config.bin %> event stream-types-list --file event-filter.json", "<%= config.bin %> event stream-types-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON filter body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event:stream-types-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List event stream types", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event", "stream-types-list.js" ] }, "event:tags-list": { "aliases": [], "args": {}, "description": "List event tags.\n\nOptionally provide a filter body from stdin or --file.", "examples": [ "<%= config.bin %> event tags-list", "<%= config.bin %> event tags-list --file event-filter.json", "<%= config.bin %> event tags-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON filter body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event:tags-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List event tags", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event", "tags-list.js" ] }, "event:users-list": { "aliases": [], "args": {}, "description": "List event users.\n\nOptionally provide a filter body from stdin or --file.", "examples": [ "<%= config.bin %> event users-list", "<%= config.bin %> event users-list --file event-filter.json", "<%= config.bin %> event users-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON filter body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event:users-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List event users", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event", "users-list.js" ] }, "event:view-create": { "aliases": [], "args": {}, "description": "Create a view scoped to event query results.\n\nReads JSON request body from stdin or --file.", "examples": [ "<%= config.bin %> event view-create --file event-view.json", "<%= config.bin %> event view-create --file event-view.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON request body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event:view-create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create event-scoped view", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event", "view-create.js" ] }, "event-trigger:create": { "aliases": [], "args": {}, "description": "Create a new event trigger.\n\nReads JSON from stdin or --file. Use --full when cloning from 'event-trigger get --json'.", "examples": [ "<%= config.bin %> event-trigger create --file trigger.json", "<%= config.bin %> event-trigger get --full --json | <%= config.bin %> event-trigger create" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event-trigger:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create an event trigger", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event-trigger", "create.js" ] }, "event-trigger:disable": { "aliases": [], "args": { "id": { "description": "Event trigger ID (UUID)", "name": "id", "required": true } }, "description": "Disable an event trigger by ID without permanently deleting it.", "examples": [ "<%= config.bin %> event-trigger disable " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event-trigger:disable", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Disable an event trigger", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event-trigger", "disable.js" ] }, "event-trigger:get": { "aliases": [], "args": { "id": { "description": "Event trigger ID (UUID)", "name": "id", "required": true } }, "description": "Get detailed information about an event trigger.\n\nShows the full trigger configuration including conditions, exit conditions, commands\nit executes, and device targeting filters.", "examples": [ "<%= config.bin %> event-trigger get ", "<%= config.bin %> event-trigger get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event-trigger:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get event trigger details", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event-trigger", "get.js" ] }, "event-trigger:list": { "aliases": [], "args": {}, "description": "List all event trigger rules in your organization.\n\nEvent triggers monitor device data and generate events/signals when conditions are met.\nThey can trigger investigations, send notifications, or execute commands.", "examples": [ "<%= config.bin %> event-trigger list", "<%= config.bin %> event-trigger list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event-trigger:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List event trigger rules", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event-trigger", "list.js" ] }, "event-trigger:update": { "aliases": [], "args": { "id": { "description": "Event trigger ID (UUID)", "name": "id", "required": true } }, "description": "Update an existing event trigger.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> event-trigger update --file changes.json", "echo '{\"message\":\"new-message\"}' | <%= config.bin %> event-trigger update --stdin" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event-trigger:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update an event trigger", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event-trigger", "update.js" ] }, "event-trigger-group:create": { "aliases": [], "args": {}, "description": "Create a new event trigger group.\n\nReads JSON from stdin or --file.", "examples": [ "<%= config.bin %> event-trigger-group create --file event-trigger-group.json", "echo '{\"phoneNumbers\":[],\"deviceIds\":[],\"eventTriggers\":[],\"tags\":{}}' | <%= config.bin %> event-trigger-group create" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event-trigger-group:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create an event trigger group", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event-trigger-group", "create.js" ] }, "event-trigger-group:disable": { "aliases": [], "args": { "id": { "description": "Event trigger group ID (UUID)", "name": "id", "required": true } }, "description": "Disable an event trigger group by ID without permanently deleting it.", "examples": [ "<%= config.bin %> event-trigger-group disable " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event-trigger-group:disable", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Disable an event trigger group", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event-trigger-group", "disable.js" ] }, "event-trigger-group:get": { "aliases": [], "args": { "id": { "description": "Event trigger group ID (UUID)", "name": "id", "required": true } }, "description": "Get detailed information about an event trigger group.", "examples": [ "<%= config.bin %> event-trigger-group get ", "<%= config.bin %> event-trigger-group get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event-trigger-group:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get event trigger group details", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event-trigger-group", "get.js" ] }, "event-trigger-group:list": { "aliases": [], "args": {}, "description": "List all event trigger groups in your organization.", "examples": [ "<%= config.bin %> event-trigger-group list", "<%= config.bin %> event-trigger-group list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event-trigger-group:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List event trigger groups", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event-trigger-group", "list.js" ] }, "event-trigger-group:update": { "aliases": [], "args": { "id": { "description": "Event trigger group ID (UUID)", "name": "id", "required": true } }, "description": "Update an existing event trigger group.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> event-trigger-group update --file changes.json", "echo '{\"name\":\"new-name\"}' | <%= config.bin %> event-trigger-group update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "event-trigger-group:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update an event trigger group", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "event-trigger-group", "update.js" ] }, "file:begin-upload": { "aliases": [], "args": {}, "description": "Begin a multipart cloud-file upload.\n\nReturns a storage file ID, upload ID, part URLs, and part size. Complete the upload with 'file complete-upload'.", "examples": [ "<%= config.bin %> file begin-upload --name report.csv --size 1048576", "<%= config.bin %> file begin-upload --name report.csv --size 1048576 --content-type text/csv --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "name": { "char": "n", "description": "File name", "name": "name", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "size": { "char": "s", "description": "File size in bytes", "name": "size", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "content-type": { "char": "t", "description": "Optional MIME type", "name": "content-type", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force-overwrite": { "description": "Overwrite an existing file with the same name if supported", "name": "force-overwrite", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "file:begin-upload", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Begin a file upload", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "file", "begin-upload.js" ] }, "file:complete-upload": { "aliases": [], "args": {}, "description": "Complete a multipart cloud-file upload.\n\nUse the file ID and upload ID returned by 'file begin-upload', along with one --etag per uploaded part.", "examples": [ "<%= config.bin %> file complete-upload --file-id --upload-id --etag ", "<%= config.bin %> file complete-upload --file-id --upload-id --etag --etag --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file-id": { "description": "Storage file ID returned by file begin-upload", "name": "file-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "upload-id": { "description": "Upload ID returned by file begin-upload", "name": "upload-id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "etag": { "description": "Multipart upload ETag for each uploaded part (repeatable)", "name": "etag", "required": true, "hasDynamicHelp": false, "multiple": true, "type": "option" }, "force-overwrite": { "description": "Overwrite an existing file with the same name if supported", "name": "force-overwrite", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "file:complete-upload", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Complete a file upload", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "file", "complete-upload.js" ] }, "file:delete": { "aliases": [], "args": { "id": { "description": "File record ID (not the storage fileId)", "name": "id", "required": true } }, "description": "Delete a cloud file by record ID.", "examples": [ "<%= config.bin %> file delete ", "<%= config.bin %> file delete --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "file:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete a file", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "file", "delete.js" ] }, "file:get": { "aliases": [], "args": { "id": { "description": "File record ID (not the storage fileId)", "name": "id", "required": true } }, "description": "Get a cloud file by record ID.", "examples": [ "<%= config.bin %> file get ", "<%= config.bin %> file get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "file:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get a file", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "file", "get.js" ] }, "file:list": { "aliases": [], "args": {}, "description": "List cloud files in your organization.", "examples": [ "<%= config.bin %> file list", "<%= config.bin %> file list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "file:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List files", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "file", "list.js" ] }, "file:query": { "aliases": [], "args": {}, "description": "Resolve one or more storage file IDs to signed URLs.", "examples": [ "<%= config.bin %> file query --file-id ", "<%= config.bin %> file query --file-id --file-id --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file-id": { "char": "i", "description": "Storage fileId UUID to resolve to a signed URL (repeatable)", "name": "file-id", "required": true, "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "file:query", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Query file URLs", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "file", "query.js" ] }, "file:update": { "aliases": [], "args": { "id": { "description": "File record ID (not the storage fileId)", "name": "id", "required": true } }, "description": "Update a cloud file.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> file update --file changes.json", "echo '{\"name\":\"renamed.csv\"}' | <%= config.bin %> file update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "file:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a file", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "file", "update.js" ] }, "file:url-get": { "aliases": [], "args": { "id": { "description": "File record ID (not the storage fileId)", "name": "id", "required": true } }, "description": "Get a signed download URL for a cloud file by record ID.", "examples": [ "<%= config.bin %> file url-get ", "<%= config.bin %> file url-get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "file:url-get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get a file URL", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "file", "url-get.js" ] }, "fleet:create": { "aliases": [], "args": {}, "description": "Create a new fleet (device group).\n\nReads JSON from stdin or --file. Pipe output from 'fleet get --json' to clone a fleet.", "examples": [ "<%= config.bin %> fleet create --file fleet.json", "<%= config.bin %> fleet get --json | <%= config.bin %> fleet create", "<%= config.bin %> fleet list --json | <%= config.bin %> fleet create" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "fleet:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a fleet", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "fleet", "create.js" ] }, "fleet:delete": { "aliases": [], "args": { "id": { "description": "Fleet ID (UUID)", "name": "id", "required": true } }, "description": "Delete a fleet (device group) by ID.", "examples": [ "<%= config.bin %> fleet delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "fleet:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete a fleet", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "fleet", "delete.js" ] }, "fleet:get": { "aliases": [], "args": { "id": { "description": "Fleet ID (UUID)", "name": "id", "required": true } }, "description": "Get detailed information about a device group (fleet).\n\nShows the full fleet configuration including member devices and settings.", "examples": [ "<%= config.bin %> fleet get ", "<%= config.bin %> fleet get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "fleet:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get fleet details", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "fleet", "get.js" ] }, "fleet:list": { "aliases": [], "args": {}, "description": "List all device groups (fleets) in your organization.\n\nDevice groups allow you to organize and manage sets of devices together.", "examples": [ "<%= config.bin %> fleet list", "<%= config.bin %> fleet list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "fleet:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List device groups", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "fleet", "list.js" ] }, "fleet:update": { "aliases": [], "args": { "id": { "description": "Fleet ID (UUID)", "name": "id", "required": true } }, "description": "Update an existing fleet (device group).\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> fleet update --file changes.json", "echo '{\"name\":\"new-name\"}' | <%= config.bin %> fleet update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "fleet:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a fleet", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "fleet", "update.js" ] }, "ground-truth:create": { "aliases": [], "args": {}, "description": "Create an organization ground truth.\n\nReads JSON from stdin or --file.", "examples": [ "<%= config.bin %> ground-truth create --file ground-truth.json", "<%= config.bin %> ground-truth create --file ground-truth.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ground-truth:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a ground truth", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "ground-truth", "create.js" ] }, "ground-truth:delete": { "aliases": [], "args": { "id": { "description": "Ground truth ID (UUID)", "name": "id", "required": true } }, "description": "Delete a ground truth by ID.", "examples": [ "<%= config.bin %> ground-truth delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ground-truth:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete a ground truth", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "ground-truth", "delete.js" ] }, "ground-truth:get": { "aliases": [], "args": { "id": { "description": "Ground truth ID (UUID)", "name": "id", "required": true } }, "description": "Get a ground truth by ID.", "examples": [ "<%= config.bin %> ground-truth get ", "<%= config.bin %> ground-truth get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ground-truth:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get a ground truth", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "ground-truth", "get.js" ] }, "ground-truth:list": { "aliases": [], "args": {}, "description": "List organization ground truths.", "examples": [ "<%= config.bin %> ground-truth list", "<%= config.bin %> ground-truth list --start-time 2026-01-01T00:00:00Z --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "end-time": { "description": "Filter results ending before this ISO timestamp", "name": "end-time", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "start-time": { "description": "Filter results starting at or after this ISO timestamp", "name": "start-time", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ground-truth:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List ground truths", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "ground-truth", "list.js" ] }, "ground-truth:update": { "aliases": [], "args": { "id": { "description": "Ground truth ID (UUID)", "name": "id", "required": true } }, "description": "Update a ground truth.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> ground-truth update --file changes.json", "echo '{\"reality\":\"updated\"}' | <%= config.bin %> ground-truth update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ground-truth:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a ground truth", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "ground-truth", "update.js" ] }, "ingest:batch": { "aliases": [], "args": {}, "description": "Ingest multiple data points in a single batch request.\n\nReads a JSON file (or stdin) containing a batch ingestion payload and sends all data points\nin a single API request. This is more efficient than sending individual data points when you\nhave multiple values to ingest.\n\nINPUT FORMAT:\nThe input JSON must have the following structure:\n{\n \"items\": [\n {\n \"deviceId\": \"device-uuid\", // Required: Device ID (UUID)\n \"name\": \"stream-name\", // Required: Stream name\n \"type\": \"numeric|text|json|...\", // Required: Data type (see below)\n \"tags\": {\"key\": \"value\"}, // Optional: Tags object (string key-value pairs)\n \"points\": [[timestamp_ms, value]] // Required: Array of [timestamp, value] pairs\n }\n ]\n}\n\nSUPPORTED TYPES AND VALUE FORMATS:\n- numeric: Number value\n Example: \"points\": [[1708272000000, 42.5]]\n\n- text: String value\n Example: \"points\": [[1708272000000, \"hello world\"]]\n\n- json: JSON object encoded as string\n Example: \"points\": [[1708272000000, \"{\\\"x\\\":10,\\\"y\\\":20}\"]]\n\n- image: Object with url (required), size and annotations (optional)\n Example: \"points\": [[1708272000000, {\"url\": \"https://example.com/img.jpg\", \"size\": 102400}]]\n\n- video: Object with url, duration, mimeType (required), size (optional)\n Example: \"points\": [[1708272000000, {\"url\": \"https://example.com/vid.mp4\", \"duration\": 30000, \"mimeType\": \"video/mp4\"}]]\n\n- bitset: Object with keys array and values array (1-1000 pairs)\n Example: \"points\": [[1708272000000, {\"keys\": [\"door\", \"window\"], \"values\": [true, false]}]]\n\n- health: Object with status (required) and clockSkewMs (optional)\n Example: \"points\": [[1708272000000, {\"status\": \"operational\", \"clockSkewMs\": 150}]]\n Valid status values: \"unknown\", \"operational\", \"offline\", \"error\"\n\nEach item can have multiple points (timestamp/value pairs) for the same stream.\nTimestamps are Unix milliseconds (use Date.now() for current time).", "examples": [ "<%= config.bin %> ingest batch --file data.json", "<%= config.bin %> ingest batch --stdin < data.json", "cat payload.json | <%= config.bin %> ingest batch --stdin", "# Example payload.json with multiple types:\n{\n \"items\": [\n {\n \"deviceId\": \"abc-123\",\n \"name\": \"battery_level\",\n \"type\": \"numeric\",\n \"tags\": {\"env\": \"prod\"},\n \"points\": [[1708272000000, 42.5], [1708272060000, 41.8]]\n },\n {\n \"deviceId\": \"abc-123\",\n \"name\": \"status\",\n \"type\": \"text\",\n \"tags\": {\"env\": \"prod\"},\n \"points\": [[1708272000000, \"operational\"]]\n },\n {\n \"deviceId\": \"abc-123\",\n \"name\": \"health\",\n \"type\": \"health\",\n \"tags\": {},\n \"points\": [[1708272000000, {\"status\": \"operational\"}]]\n }\n ]\n}" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file containing batch payload", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON payload from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ingest:batch", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Ingest batch data from file or stdin", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "ingest", "batch.js" ] }, "ingest:bitset": { "aliases": [], "args": {}, "description": "Ingest a bitset data point to a device stream.\n\nSends a bitset (array of named boolean values) to the specified device stream. A bitset\nconsists of parallel arrays of keys (strings) and values (booleans).\n\nBitsets are useful for representing sets of binary states, flags, or boolean sensor readings\nwhere you have multiple named on/off states.\n\nConstraints:\n- Must have 1-1000 key/value pairs\n- Keys must be max 255 characters each\n- Keys and values arrays must have the same length", "examples": [ "<%= config.bin %> ingest bitset --device --stream sensors --keys \"door,window,motion\" --values \"true,false,true\"", "<%= config.bin %> ingest bitset --device --stream flags --keys \"active,paused,error\" --values \"true,false,false\" --tag system=main", "<%= config.bin %> ingest bitset --device --stream states --keys \"a,b\" --values \"false,true\"" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "device": { "char": "d", "description": "Device ID (UUID)", "name": "device", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stream": { "char": "s", "description": "Stream name", "name": "stream", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "keys": { "char": "k", "description": "Comma-separated list of key names (1-1000 keys, max 255 chars each)", "name": "keys", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "values": { "char": "v", "description": "Comma-separated list of boolean values (true/false, must match key count)", "name": "values", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tag": { "char": "t", "description": "Tag as key=value where both are strings (can be specified multiple times)", "name": "tag", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "timestamp": { "description": "Unix timestamp in milliseconds (defaults to now)", "name": "timestamp", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ingest:bitset", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Ingest bitset data", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "ingest", "bitset.js" ] }, "ingest:health": { "aliases": [], "args": {}, "description": "Ingest a health status data point to a device stream.\n\nSends device health status information to the specified stream. Health data consists of:\n- status: One of \"unknown\", \"operational\", \"offline\", or \"error\"\n- clockSkewMs (optional): Clock skew in milliseconds between device and server\n\nHealth streams are used to track device operational state, system health, and time synchronization.", "examples": [ "<%= config.bin %> ingest health --device --stream system_health --status operational", "<%= config.bin %> ingest health --device --stream health --status error --tag component=motor", "<%= config.bin %> ingest health --device --stream sync --status operational --clock-skew 150" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "device": { "char": "d", "description": "Device ID (UUID)", "name": "device", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stream": { "char": "s", "description": "Stream name", "name": "stream", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "description": "Health status (unknown, operational, offline, or error)", "name": "status", "required": true, "hasDynamicHelp": false, "multiple": false, "options": [ "unknown", "operational", "offline", "error" ], "type": "option" }, "clock-skew": { "description": "Clock skew in milliseconds (optional)", "name": "clock-skew", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tag": { "char": "t", "description": "Tag as key=value where both are strings (can be specified multiple times)", "name": "tag", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "timestamp": { "description": "Unix timestamp in milliseconds (defaults to now)", "name": "timestamp", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ingest:health", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Ingest health status data", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "ingest", "health.js" ] }, "ingest:image": { "aliases": [], "args": {}, "description": "Ingest an image URL to a device stream.\n\nSends an image reference (by URL) to the specified device stream. The image must be accessible\nvia HTTP/HTTPS. Formant will fetch and store the image from the provided URL.\n\nImage streams are used for camera feeds, snapshots, diagnostic images, etc.", "examples": [ "<%= config.bin %> ingest image --device --stream camera_front --url https://example.com/image.jpg", "<%= config.bin %> ingest image --device --stream snapshot --url https://example.com/snap.png --size 1024000", "<%= config.bin %> ingest image --device --stream detection --url https://example.com/detect.jpg --tag frame=123" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "device": { "char": "d", "description": "Device ID (UUID)", "name": "device", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stream": { "char": "s", "description": "Stream name", "name": "stream", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "url": { "char": "u", "description": "Image URL (must be http:// or https://)", "name": "url", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "size": { "description": "Image size in bytes (optional)", "name": "size", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tag": { "char": "t", "description": "Tag as key=value where both are strings (can be specified multiple times)", "name": "tag", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "timestamp": { "description": "Unix timestamp in milliseconds (defaults to now)", "name": "timestamp", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ingest:image", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Ingest image data", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "ingest", "image.js" ] }, "ingest:json": { "aliases": [], "args": { "value": { "description": "JSON value to ingest (as a JSON string)", "name": "value", "required": true } }, "description": "Ingest a JSON data point to a device stream.\n\nSends structured JSON data to the specified device stream. The value must be valid JSON.\nJSON streams are used for complex structured data like configuration objects, state machines,\nnested telemetry, etc.\n\nNote: The JSON is sent as a JSON-encoded string to Formant.", "examples": [ "<%= config.bin %> ingest json '{\"x\":1,\"y\":2}' --device --stream position", "<%= config.bin %> ingest json '{\"status\":\"active\",\"mode\":\"auto\"}' --device --stream config", "<%= config.bin %> ingest json '[1,2,3,4,5]' --device --stream array_data" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "device": { "char": "d", "description": "Device ID (UUID)", "name": "device", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stream": { "char": "s", "description": "Stream name", "name": "stream", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tag": { "char": "t", "description": "Tag as key=value where both are strings (can be specified multiple times)", "name": "tag", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "timestamp": { "description": "Unix timestamp in milliseconds (defaults to now)", "name": "timestamp", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ingest:json", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Ingest JSON data", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "ingest", "json.js" ] }, "ingest:numeric": { "aliases": [], "args": { "value": { "description": "Numeric value to ingest", "name": "value", "required": true } }, "description": "Ingest a numeric data point to a device stream.\n\nSends a single numeric value to the specified device stream. The value must be a valid number.\nNumeric streams are commonly used for sensor readings like battery level, temperature, speed, etc.", "examples": [ "<%= config.bin %> ingest numeric 42.5 --device --stream battery_level", "<%= config.bin %> ingest numeric 98.6 --device --stream temperature --tag unit=fahrenheit", "<%= config.bin %> ingest numeric 1500 --device --stream rpm --timestamp 1700000000000" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "device": { "char": "d", "description": "Device ID (UUID)", "name": "device", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stream": { "char": "s", "description": "Stream name", "name": "stream", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tag": { "char": "t", "description": "Tag as key=value where both are strings (can be specified multiple times)", "name": "tag", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "timestamp": { "description": "Unix timestamp in milliseconds (defaults to now)", "name": "timestamp", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ingest:numeric", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Ingest numeric data", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "ingest", "numeric.js" ] }, "ingest:text": { "aliases": [], "args": { "value": { "description": "Text value to ingest", "name": "value", "required": true } }, "description": "Ingest a text data point to a device stream.\n\nSends a single text/string value to the specified device stream. Text streams are commonly\nused for logs, status messages, error messages, and other string data.", "examples": [ "<%= config.bin %> ingest text \"Robot started successfully\" --device --stream status", "<%= config.bin %> ingest text \"Error: sensor offline\" --device --stream errors --tag severity=high", "<%= config.bin %> ingest text \"Checkpoint A reached\" --device --stream waypoints" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "device": { "char": "d", "description": "Device ID (UUID)", "name": "device", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stream": { "char": "s", "description": "Stream name", "name": "stream", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tag": { "char": "t", "description": "Tag as key=value where both are strings (can be specified multiple times)", "name": "tag", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "timestamp": { "description": "Unix timestamp in milliseconds (defaults to now)", "name": "timestamp", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ingest:text", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Ingest text data", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "ingest", "text.js" ] }, "ingest:video": { "aliases": [], "args": {}, "description": "Ingest a video URL to a device stream.\n\nSends a video reference (by URL) to the specified device stream. The video must be accessible\nvia HTTP/HTTPS. You must provide the video duration in milliseconds.\n\nVideo streams are used for recorded video clips, timelapse videos, event recordings, etc.\n\nThe MIME type is auto-detected from the file extension (.mp4, .webm, .mov).", "examples": [ "<%= config.bin %> ingest video --device --stream recordings --url https://example.com/video.mp4 --duration 5000", "<%= config.bin %> ingest video --device --stream clips --url https://example.com/clip.webm --duration 3500 --size 2048000", "<%= config.bin %> ingest video --device --stream event_video --url https://example.com/event.mov --duration 10000 --tag event=collision" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "device": { "char": "d", "description": "Device ID (UUID)", "name": "device", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stream": { "char": "s", "description": "Stream name", "name": "stream", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "url": { "char": "u", "description": "Video URL (must be http:// or https://)", "name": "url", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "duration": { "description": "Video duration in milliseconds (required)", "name": "duration", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "size": { "description": "Video size in bytes (optional)", "name": "size", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tag": { "char": "t", "description": "Tag as key=value where both are strings (can be specified multiple times)", "name": "tag", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "timestamp": { "description": "Unix timestamp in milliseconds (defaults to now)", "name": "timestamp", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "ingest:video", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Ingest video data", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "ingest", "video.js" ] }, "intervention-request:create": { "aliases": [], "args": {}, "description": "Create one or more intervention requests.\n\nReads JSON from stdin or --file.", "examples": [ "<%= config.bin %> intervention-request create --file intervention-request.json", "<%= config.bin %> intervention-request create --file intervention-requests.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "intervention-request:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create an intervention request", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "intervention-request", "create.js" ] }, "intervention-request:get": { "aliases": [], "args": { "id": { "description": "Intervention request ID", "name": "id", "required": true } }, "description": "Get an intervention request by ID.", "examples": [ "<%= config.bin %> intervention-request get ", "<%= config.bin %> intervention-request get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "intervention-request:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get an intervention request", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "intervention-request", "get.js" ] }, "intervention-request:query": { "aliases": [], "args": {}, "description": "Query intervention requests with paging and filters.", "examples": [ "<%= config.bin %> intervention-request query", "<%= config.bin %> intervention-request query --page 1 --limit 25 --order desc", "<%= config.bin %> intervention-request query --intervention-type teleop --status pending --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "intervention-type": { "description": "Filter by intervention type", "name": "intervention-type", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit": { "description": "Maximum number of items to return", "name": "limit", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "order": { "description": "Sort order", "name": "order", "hasDynamicHelp": false, "multiple": false, "options": [ "asc", "desc" ], "type": "option" }, "page": { "description": "Result page number", "name": "page", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "search": { "description": "Search text", "name": "search", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "description": "Filter by response status (repeatable)", "name": "status", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "intervention-request:query", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Query intervention requests", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "intervention-request", "query.js" ] }, "intervention-request:update": { "aliases": [], "args": { "id": { "description": "Intervention request ID", "name": "id", "required": true } }, "description": "Update an intervention request.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> intervention-request update --file changes.json", "echo '{\"message\":\"Updated\"}' | <%= config.bin %> intervention-request update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "intervention-request:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update an intervention request", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "intervention-request", "update.js" ] }, "kv:delete": { "aliases": [], "args": { "key": { "description": "Key to delete", "name": "key", "required": true } }, "description": "Delete a key from the key-value store.\n\nRemoves the key and value from your organization's key-value store.", "examples": [ "<%= config.bin %> kv delete my-key", "<%= config.bin %> kv delete my-key --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "kv:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete key-value", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "kv", "delete.js" ] }, "kv:get": { "aliases": [], "args": { "key": { "description": "Key to retrieve", "name": "key", "required": true } }, "description": "Get a value from the key-value store.\n\nThe key-value store allows devices and applications to store metadata.", "examples": [ "<%= config.bin %> kv get my-key", "<%= config.bin %> kv get my-key --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "kv:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get key-value", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "kv", "get.js" ] }, "kv:list": { "aliases": [], "args": {}, "description": "List all keys in the key-value store.\n\nShows all stored keys in the organization's key-value store. Use --prefix to filter\nkeys that start with a specific prefix, or --keys to query specific keys.", "examples": [ "<%= config.bin %> kv list", "<%= config.bin %> kv list --prefix config", "<%= config.bin %> kv list --keys key1 --keys key2 --keys key3", "<%= config.bin %> kv list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "keys": { "char": "k", "description": "Specific keys to query (can be specified multiple times)", "name": "keys", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "prefix": { "char": "p", "description": "Filter keys by prefix", "name": "prefix", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "kv:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List key-value keys", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "kv", "list.js" ] }, "kv:set": { "aliases": [], "args": { "key": { "description": "Key to set", "name": "key", "required": true }, "value": { "description": "Value to store (JSON string)", "name": "value", "required": true } }, "description": "Set a value in the key-value store.\n\nStores a value associated with a key. The value should be a JSON string.", "examples": [ "<%= config.bin %> kv set my-key '{\"data\": \"value\"}'", "<%= config.bin %> kv set config '{\"setting\": true}'" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "kv:set", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Set key-value", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "kv", "set.js" ] }, "mcp": { "aliases": [], "args": {}, "description": "Start a Model Context Protocol (MCP) stdio server. Exposes every formant command as an MCP tool named formant_, so AI assistants can invoke them directly.", "examples": [ "<%= config.bin %> mcp", "<%= config.bin %> mcp --dev", "<%= config.bin %> mcp --stage" ], "flags": { "dev": { "description": "Target the dev environment for all tool calls", "exclusive": [ "stage" ], "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment for all tool calls", "exclusive": [ "dev" ], "name": "stage", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "mcp", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Start MCP stdio server", "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "mcp", "index.js" ] }, "module:create": { "aliases": [], "args": {}, "description": "Create a new module.\n\nReads JSON from stdin or --file. Pipe output from 'module get --json' to clone a module.", "examples": [ "<%= config.bin %> module create --file module.json", "<%= config.bin %> module get --json | <%= config.bin %> module create", "<%= config.bin %> module list --json | <%= config.bin %> module create" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "module:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a module", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "module", "create.js" ] }, "module:delete": { "aliases": [], "args": { "id": { "description": "Module ID (UUID)", "name": "id", "required": true } }, "description": "Delete a module by ID.", "examples": [ "<%= config.bin %> module delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "module:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete a module", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "module", "delete.js" ] }, "module:get": { "aliases": [], "args": { "id": { "description": "Module ID (UUID)", "name": "id", "required": true } }, "description": "Get detailed information about a module.", "examples": [ "<%= config.bin %> module get ", "<%= config.bin %> module get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "module:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get module details", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "module", "get.js" ] }, "module:list": { "aliases": [], "args": {}, "description": "List all modules in your organization.", "examples": [ "<%= config.bin %> module list", "<%= config.bin %> module list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "module:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List modules", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "module", "list.js" ] }, "module:update": { "aliases": [], "args": { "id": { "description": "Module ID (UUID)", "name": "id", "required": true } }, "description": "Update an existing module.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> module update --file changes.json", "echo '{\"name\":\"new-name\"}' | <%= config.bin %> module update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "module:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a module", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "module", "update.js" ] }, "module-configuration:create": { "aliases": [], "args": {}, "description": "Create a new module configuration.\n\nReads JSON from stdin or --file. Pipe output from 'module-configuration get --json' to clone a module configuration.", "examples": [ "<%= config.bin %> module-configuration create --file module-configuration.json", "<%= config.bin %> module-configuration get --json | <%= config.bin %> module-configuration create", "<%= config.bin %> module-configuration list --json | <%= config.bin %> module-configuration create" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "module-configuration:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a module configuration", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "module-configuration", "create.js" ] }, "module-configuration:delete": { "aliases": [], "args": { "id": { "description": "Module configuration ID (UUID)", "name": "id", "required": true } }, "description": "Delete a module configuration by ID.", "examples": [ "<%= config.bin %> module-configuration delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "module-configuration:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete a module configuration", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "module-configuration", "delete.js" ] }, "module-configuration:get": { "aliases": [], "args": { "id": { "description": "Module configuration ID (UUID)", "name": "id", "required": true } }, "description": "Get detailed information about a module configuration.", "examples": [ "<%= config.bin %> module-configuration get ", "<%= config.bin %> module-configuration get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "module-configuration:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get module configuration details", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "module-configuration", "get.js" ] }, "module-configuration:list": { "aliases": [], "args": {}, "description": "List all module configurations in your organization.", "examples": [ "<%= config.bin %> module-configuration list", "<%= config.bin %> module-configuration list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "module-configuration:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List module configurations", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "module-configuration", "list.js" ] }, "module-configuration:update": { "aliases": [], "args": { "id": { "description": "Module configuration ID (UUID)", "name": "id", "required": true } }, "description": "Update an existing module configuration.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> module-configuration update --file changes.json", "echo '{\"configuration\":{}}' | <%= config.bin %> module-configuration update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "module-configuration:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a module configuration", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "module-configuration", "update.js" ] }, "notification-destination:create": { "aliases": [], "args": {}, "description": "Create a notification destination.\n\nReads JSON from stdin or --file.", "examples": [ "<%= config.bin %> notification-destination create --file destination.json", "<%= config.bin %> notification-destination create --file destination.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "notification-destination:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a notification destination", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "notification-destination", "create.js" ] }, "notification-destination:delete": { "aliases": [], "args": { "id": { "description": "Notification destination ID (UUID)", "name": "id", "required": true } }, "description": "Delete a notification destination by ID.", "examples": [ "<%= config.bin %> notification-destination delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "notification-destination:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete a notification destination", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "notification-destination", "delete.js" ] }, "notification-destination:get": { "aliases": [], "args": { "id": { "description": "Notification destination ID (UUID)", "name": "id", "required": true } }, "description": "Get a notification destination by ID.", "examples": [ "<%= config.bin %> notification-destination get ", "<%= config.bin %> notification-destination get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "notification-destination:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get a notification destination", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "notification-destination", "get.js" ] }, "notification-destination:list": { "aliases": [], "args": {}, "description": "List notification destinations.", "examples": [ "<%= config.bin %> notification-destination list", "<%= config.bin %> notification-destination list --platform slack --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "platform": { "description": "Filter by platform", "name": "platform", "hasDynamicHelp": false, "multiple": false, "options": [ "slack", "teams", "sms" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "notification-destination:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List notification destinations", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "notification-destination", "list.js" ] }, "notification-destination:update": { "aliases": [], "args": { "id": { "description": "Notification destination ID (UUID)", "name": "id", "required": true } }, "description": "Update a notification destination.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> notification-destination update --file changes.json", "echo '{\"destinationName\":\"Updated\"}' | <%= config.bin %> notification-destination update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "notification-destination:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a notification destination", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "notification-destination", "update.js" ] }, "investigation:analytics": { "aliases": [], "args": {}, "description": "Get investigation analytics with time-series data.\n\nReturns aggregated analytics about investigation runs over a time range,\noptionally grouped by result type or signal type.", "examples": [ "<%= config.bin %> investigation analytics --start 2026-01-01 --end 2026-02-01", "<%= config.bin %> investigation analytics --start 2026-01-01 --end 2026-02-01 --interval hourly", "<%= config.bin %> investigation analytics --start 2026-01-01 --end 2026-02-01 --group-by resultType --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "end": { "description": "End time (ISO 8601)", "name": "end", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "group-by": { "description": "Group results by", "name": "group-by", "hasDynamicHelp": false, "multiple": false, "options": [ "resultType", "signalType" ], "type": "option" }, "interval": { "description": "Time interval for aggregation", "name": "interval", "default": "daily", "hasDynamicHelp": false, "multiple": false, "options": [ "daily", "hourly" ], "type": "option" }, "start": { "description": "Start time (ISO 8601)", "name": "start", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:analytics", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get investigation analytics", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "analytics.js" ] }, "investigation:artifacts-list": { "aliases": [], "args": { "id": { "description": "Runtime investigation ID", "name": "id", "required": true } }, "description": "List artifacts attached to a runtime investigation.", "examples": [ "<%= config.bin %> investigation artifacts-list ", "<%= config.bin %> investigation artifacts-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:artifacts-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List investigation artifacts", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "artifacts-list.js" ] }, "investigation:create": { "aliases": [], "args": {}, "description": "Create a new runtime investigation.\n\nReads JSON from stdin or --file.\nRequired fields are typically \"signalId\", \"name\", and \"goal\".", "examples": [ "<%= config.bin %> investigation create --file investigation.json", "<%= config.bin %> investigation create --file investigation.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a runtime investigation", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "create.js" ] }, "investigation:custom-output-fields-create": { "aliases": [], "args": { "id": { "description": "Investigation definition ID", "name": "id", "required": true } }, "description": "Create one or more custom output fields for an investigation.\n\nReads JSON from stdin or --file. Accepts either a single field object or an array of fields.", "examples": [ "<%= config.bin %> investigation custom-output-fields-create --file field.json", "<%= config.bin %> investigation custom-output-fields-create --file fields.json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:custom-output-fields-create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create investigation custom output fields", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "custom-output-fields-create.js" ] }, "investigation:custom-output-fields-list": { "aliases": [], "args": { "id": { "description": "Investigation definition ID", "name": "id", "required": true } }, "description": "List custom output fields configured for an investigation.", "examples": [ "<%= config.bin %> investigation custom-output-fields-list ", "<%= config.bin %> investigation custom-output-fields-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:custom-output-fields-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List investigation custom output fields", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "custom-output-fields-list.js" ] }, "investigation:definition-create": { "aliases": [], "args": {}, "description": "Create an investigation definition.\n\nReads JSON from stdin or --file. Accepts a single definition or an array.", "examples": [ "<%= config.bin %> investigation definition-create --file definition.json", "<%= config.bin %> investigation definition-get --json | <%= config.bin %> investigation definition-create" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:definition-create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create an investigation definition", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "definition-create.js" ] }, "investigation:definition-delete": { "aliases": [], "args": { "id": { "description": "Investigation definition ID", "name": "id", "required": true } }, "description": "Delete an investigation definition by ID.", "examples": [ "<%= config.bin %> investigation definition-delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:definition-delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete an investigation definition", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "definition-delete.js" ] }, "investigation:definition-get": { "aliases": [], "args": { "id": { "description": "Investigation definition ID", "name": "id", "required": true } }, "description": "Get detailed information about a specific investigation definition by ID.", "examples": [ "<%= config.bin %> investigation definition-get ", "<%= config.bin %> investigation definition-get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:definition-get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get an investigation definition by ID", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "definition-get.js" ] }, "investigation:definition-update": { "aliases": [], "args": { "id": { "description": "Investigation definition ID", "name": "id", "required": true } }, "description": "Update an investigation definition.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> investigation definition-update --file definition-update.json", "echo '{\"description\":\"Updated investigation\"}' | <%= config.bin %> investigation definition-update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:definition-update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update an investigation definition", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "definition-update.js" ] }, "investigation:delete": { "aliases": [], "args": { "id": { "description": "Runtime investigation ID", "name": "id", "required": true } }, "description": "Archive a runtime investigation by ID.", "examples": [ "<%= config.bin %> investigation delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Archive a runtime investigation", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "delete.js" ] }, "investigation:edge-add": { "aliases": [], "args": { "taskflow-id": { "description": "Taskflow (investigation) ID", "name": "taskflow-id", "required": true } }, "description": "Add an edge to an investigation graph.\n\nCreates a new edge connecting two nodes. Validates that both source and target\nnodes exist, and that no duplicate edge already exists.", "examples": [ "<%= config.bin %> investigation edge-add --from --to ", "<%= config.bin %> investigation edge-add --from --to --choice \"Battery issue\"" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "choice": { "description": "Choice label (resolved to output index on the source choice node)", "name": "choice", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "from": { "description": "Source node ID", "name": "from", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "id": { "description": "Custom edge ID (auto-generated UUID if omitted)", "name": "id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "to": { "description": "Target node ID", "name": "to", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:edge-add", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Add an edge to an investigation graph", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "edge-add.js" ] }, "investigation:edge-list": { "aliases": [], "args": { "taskflow-id": { "description": "Taskflow (investigation) ID", "name": "taskflow-id", "required": true } }, "description": "List all edges in an investigation graph.\n\nShows a table with ID, SOURCE, TARGET, OUTPUT INDEX, and LABEL for each edge.\nFor choice nodes, the label auto-resolves from the source node's choices array.", "examples": [ "<%= config.bin %> investigation edge-list ", "<%= config.bin %> investigation edge-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:edge-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List edges in an investigation graph", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "edge-list.js" ] }, "investigation:edge-remove": { "aliases": [], "args": { "edge-id": { "description": "Edge ID to remove (or use --from/--to)", "name": "edge-id", "required": false }, "taskflow-id": { "description": "Taskflow (investigation) ID", "name": "taskflow-id", "required": true } }, "description": "Remove an edge from an investigation graph.\n\nIdentify the edge by ID or by --from and --to endpoints.", "examples": [ "<%= config.bin %> investigation edge-remove ", "<%= config.bin %> investigation edge-remove --from --to " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "force": { "description": "Skip confirmation prompt", "name": "force", "allowNo": false, "type": "boolean" }, "from": { "description": "Source node ID (alternative to edge ID)", "name": "from", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "to": { "description": "Target node ID (alternative to edge ID)", "name": "to", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:edge-remove", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Remove an edge from an investigation graph", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "edge-remove.js" ] }, "investigation:execute": { "aliases": [], "args": { "id": { "description": "Investigation definition ID", "name": "id", "required": true } }, "description": "Execute an investigation immediately.\n\nOptionally provide execution input JSON from stdin or --file.", "examples": [ "<%= config.bin %> investigation execute ", "<%= config.bin %> investigation execute --file execute-request.json", "<%= config.bin %> investigation execute --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:execute", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Execute an investigation", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "execute.js" ] }, "investigation:filters-create": { "aliases": [], "args": { "id": { "description": "Investigation definition ID", "name": "id", "required": true } }, "description": "Create one or more filters for an investigation.\n\nReads JSON from stdin or --file. Accepts either a single filter object or an array of filters.", "examples": [ "<%= config.bin %> investigation filters-create --file filter.json", "<%= config.bin %> investigation filters-create --file filters.json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:filters-create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create investigation filters", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "filters-create.js" ] }, "investigation:filters-list": { "aliases": [], "args": { "id": { "description": "Investigation definition ID", "name": "id", "required": true } }, "description": "List filters configured for an investigation.", "examples": [ "<%= config.bin %> investigation filters-list ", "<%= config.bin %> investigation filters-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:filters-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List investigation filters", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "filters-list.js" ] }, "investigation:get": { "aliases": [], "args": { "id": { "description": "Runtime investigation ID", "name": "id", "required": true } }, "description": "Get detailed information about a runtime investigation by ID.", "examples": [ "<%= config.bin %> investigation get ", "<%= config.bin %> investigation get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get a runtime investigation by ID", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "get.js" ] }, "investigation:label-sets-create": { "aliases": [], "args": {}, "description": "Create one or more investigation label sets.\n\nReads JSON from stdin or --file. Accepts either a single label set object or an array of label sets.", "examples": [ "<%= config.bin %> investigation label-sets-create --file label-set.json", "<%= config.bin %> investigation label-sets-create --file label-sets.json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:label-sets-create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create investigation label sets", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "label-sets-create.js" ] }, "investigation:label-sets-delete": { "aliases": [], "args": { "id": { "description": "Label set ID", "name": "id", "required": true } }, "description": "Delete an investigation label set by ID.", "examples": [ "<%= config.bin %> investigation label-sets-delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:label-sets-delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete an investigation label set", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "label-sets-delete.js" ] }, "investigation:label-sets-get": { "aliases": [], "args": { "id": { "description": "Label set ID", "name": "id", "required": true } }, "description": "Get an investigation label set by ID.", "examples": [ "<%= config.bin %> investigation label-sets-get ", "<%= config.bin %> investigation label-sets-get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:label-sets-get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get an investigation label set", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "label-sets-get.js" ] }, "investigation:label-sets-items-create": { "aliases": [], "args": { "id": { "description": "Label set ID", "name": "id", "required": true } }, "description": "Create one or more items in an investigation label set.\n\nReads JSON from stdin or --file. Accepts either a single label-set item object or an array of items.", "examples": [ "<%= config.bin %> investigation label-sets-items-create --file item.json", "<%= config.bin %> investigation label-sets-items-create --file items.json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:label-sets-items-create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create investigation label set items", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "label-sets-items-create.js" ] }, "investigation:label-sets-items-list": { "aliases": [], "args": { "id": { "description": "Label set ID", "name": "id", "required": true } }, "description": "List items in an investigation label set.", "examples": [ "<%= config.bin %> investigation label-sets-items-list ", "<%= config.bin %> investigation label-sets-items-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:label-sets-items-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List investigation label set items", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "label-sets-items-list.js" ] }, "investigation:label-sets-list": { "aliases": [], "args": {}, "description": "List investigation label sets.", "examples": [ "<%= config.bin %> investigation label-sets-list", "<%= config.bin %> investigation label-sets-list --include-items", "<%= config.bin %> investigation label-sets-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "include-items": { "description": "Include label set items in the API response", "name": "include-items", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:label-sets-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List investigation label sets", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "label-sets-list.js" ] }, "investigation:label-sets-update": { "aliases": [], "args": { "id": { "description": "Label set ID", "name": "id", "required": true } }, "description": "Update an investigation label set.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> investigation label-sets-update --file changes.json", "echo '{\"name\":\"Updated label set\"}' | <%= config.bin %> investigation label-sets-update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:label-sets-update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update an investigation label set", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "label-sets-update.js" ] }, "investigation:list": { "aliases": [], "args": {}, "description": "List investigation definitions in your organization.\n\nUse --signal-handler to filter for signal-handler investigations.", "examples": [ "<%= config.bin %> investigation list", "<%= config.bin %> investigation list --signal-handler", "<%= config.bin %> investigation list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "signal-handler": { "description": "Only show investigations that handle signals", "name": "signal-handler", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List investigation definitions", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "list.js" ] }, "investigation:node-add": { "aliases": [], "args": { "taskflow-id": { "description": "Taskflow (investigation) ID", "name": "taskflow-id", "required": true } }, "description": "Add a node to an investigation graph.\n\nCreates a new node using flags for common cases, or --file for full JSON input.\nOptionally wires the node into the graph with --after and --before.", "examples": [ "<%= config.bin %> investigation node-add --type task --persona --goal \"Diagnose issue\"", "<%= config.bin %> investigation node-add --type choice --choices \"Yes,No,Maybe\"", "<%= config.bin %> investigation node-add --type end --prompt \"Summarize findings\"", "<%= config.bin %> investigation node-add --type task --persona --goal \"Step 2\" --after ", "<%= config.bin %> investigation node-add --file node.json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "after": { "description": "Create edge from this node to the new node", "name": "after", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "before": { "description": "Create edge from the new node to this node", "name": "before", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "board-column": { "description": "Board column ID (for set_column nodes)", "name": "board-column", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "choices": { "description": "Comma-separated choice labels (for choice nodes)", "name": "choices", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file with full node definition", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "global-prompt": { "description": "Global prompt (for start nodes)", "name": "global-prompt", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "goal": { "description": "Goal text (for task nodes)", "name": "goal", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "hil": { "description": "Allow human-in-the-loop intervention (for task nodes)", "name": "hil", "allowNo": true, "type": "boolean" }, "hil-instructions": { "description": "Human intervention instructions (for task nodes)", "name": "hil-instructions", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "id": { "description": "Custom node ID (auto-generated UUID if omitted)", "name": "id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "include-signal": { "description": "Include signal context (for task nodes)", "name": "include-signal", "allowNo": true, "type": "boolean" }, "persona": { "description": "Persona ID (for task nodes)", "name": "persona", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "prompt": { "description": "Prompt text (for end nodes)", "name": "prompt", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "type": { "description": "Node type", "name": "type", "hasDynamicHelp": false, "multiple": false, "options": [ "start", "task", "choice", "end", "set_column" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:node-add", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Add a node to an investigation graph", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "node-add.js" ] }, "investigation:node-list": { "aliases": [], "args": { "taskflow-id": { "description": "Taskflow (investigation) ID", "name": "taskflow-id", "required": true } }, "description": "List all nodes in an investigation graph.\n\nShows a table with ID, TYPE, CONFIG summary, and CONNECTIONS for each node.\nTask node persona UUIDs are resolved to human-readable names.", "examples": [ "<%= config.bin %> investigation node-list ", "<%= config.bin %> investigation node-list --type task", "<%= config.bin %> investigation node-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "type": { "description": "Filter by node type", "name": "type", "hasDynamicHelp": false, "multiple": false, "options": [ "start", "task", "choice", "end", "set_column" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:node-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List nodes in an investigation graph", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "node-list.js" ] }, "investigation:node-remove": { "aliases": [], "args": { "node-id": { "description": "Node ID to remove", "name": "node-id", "required": true }, "taskflow-id": { "description": "Taskflow (investigation) ID", "name": "taskflow-id", "required": true } }, "description": "Remove a node from an investigation graph.\n\nRemoves the specified node and all edges connected to it.\nUse --reconnect to splice the node out of the chain (predecessor → successors).", "examples": [ "<%= config.bin %> investigation node-remove ", "<%= config.bin %> investigation node-remove --reconnect", "<%= config.bin %> investigation node-remove --force" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "force": { "description": "Skip confirmation prompt", "name": "force", "allowNo": false, "type": "boolean" }, "reconnect": { "description": "Reconnect predecessor directly to successors (splices node out of chain)", "name": "reconnect", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:node-remove", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Remove a node from an investigation graph", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "node-remove.js" ] }, "investigation:node-update": { "aliases": [], "args": { "node-id": { "description": "Node ID to update", "name": "node-id", "required": true }, "taskflow-id": { "description": "Taskflow (investigation) ID", "name": "taskflow-id", "required": true } }, "description": "Update a node in an investigation graph.\n\nAccepts the same type-specific flags as node-add for partial merge.\nUse --file for full replacement of the node's config via JSON.", "examples": [ "<%= config.bin %> investigation node-update --goal \"New goal\"", "<%= config.bin %> investigation node-update --persona ", "<%= config.bin %> investigation node-update --file node.json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "board-column": { "description": "Board column ID (for set_column nodes)", "name": "board-column", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "choices": { "description": "Comma-separated choice labels (for choice nodes)", "name": "choices", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file with full node config replacement", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "global-prompt": { "description": "Global prompt (for start nodes)", "name": "global-prompt", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "goal": { "description": "Goal text (for task nodes)", "name": "goal", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "hil": { "description": "Allow human-in-the-loop intervention (for task nodes)", "name": "hil", "allowNo": true, "type": "boolean" }, "hil-instructions": { "description": "Human intervention instructions (for task nodes)", "name": "hil-instructions", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "include-signal": { "description": "Include signal context (for task nodes)", "name": "include-signal", "allowNo": true, "type": "boolean" }, "persona": { "description": "Persona ID (for task nodes)", "name": "persona", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "prompt": { "description": "Prompt text (for end nodes)", "name": "prompt", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:node-update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a node in an investigation graph", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "node-update.js" ] }, "investigation:run": { "aliases": [], "args": { "investigationId": { "description": "Investigation definition ID", "name": "investigationId", "required": true }, "runId": { "description": "Run ID", "name": "runId", "required": true } }, "description": "Get detailed investigation run information.\n\nIncludes execution log and optional signal/event tracing.", "examples": [ "<%= config.bin %> investigation run ", "<%= config.bin %> investigation run --log-only", "<%= config.bin %> investigation run --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "log-only": { "description": "Only show the execution log (skip run details)", "name": "log-only", "allowNo": false, "type": "boolean" }, "trace-signal": { "description": "Fetch and display the signal and event information for this run", "name": "trace-signal", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:run", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get investigation run details", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "run.js" ] }, "investigation:runs-labels-create": { "aliases": [], "args": { "id": { "description": "Investigation definition ID", "name": "id", "required": true }, "runId": { "description": "Run ID", "name": "runId", "required": true } }, "description": "Create label(s) for an investigation run.\n\nReads JSON request from stdin or --file.", "examples": [ "<%= config.bin %> investigation runs-labels-create --file labels.json", "<%= config.bin %> investigation runs-labels-create --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:runs-labels-create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create labels for an investigation run", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "runs-labels-create.js" ] }, "investigation:runs-labels-delete": { "aliases": [], "args": { "id": { "description": "Investigation definition ID", "name": "id", "required": true }, "runId": { "description": "Run ID", "name": "runId", "required": true }, "labelId": { "description": "Label ID", "name": "labelId", "required": true } }, "description": "Delete a label from an investigation run.", "examples": [ "<%= config.bin %> investigation runs-labels-delete ", "<%= config.bin %> investigation runs-labels-delete --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:runs-labels-delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete a label from an investigation run", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "runs-labels-delete.js" ] }, "investigation:runs-labels-list": { "aliases": [], "args": { "id": { "description": "Investigation definition ID", "name": "id", "required": true }, "runId": { "description": "Run ID", "name": "runId", "required": true } }, "description": "List labels for an investigation run.", "examples": [ "<%= config.bin %> investigation runs-labels-list ", "<%= config.bin %> investigation runs-labels-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:runs-labels-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List labels for an investigation run", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "runs-labels-list.js" ] }, "investigation:runs-list": { "aliases": [], "args": { "id": { "description": "Investigation definition ID", "name": "id", "required": true } }, "description": "List runs for an investigation definition.\n\nLists actual runs (not evaluation runs). Use \"investigation run\" to inspect a specific run.", "examples": [ "<%= config.bin %> investigation runs-list ", "<%= config.bin %> investigation runs-list --limit 50", "<%= config.bin %> investigation runs-list --details --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "details": { "description": "Include detailed information about each run", "name": "details", "allowNo": false, "type": "boolean" }, "limit": { "char": "l", "description": "Maximum number of runs to return", "name": "limit", "default": 20, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "offset": { "char": "o", "description": "Offset for pagination", "name": "offset", "default": 0, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:runs-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List investigation runs", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "runs-list.js" ] }, "investigation:runs-pause": { "aliases": [], "args": { "id": { "description": "Investigation definition ID", "name": "id", "required": true }, "runId": { "description": "Run ID", "name": "runId", "required": true } }, "description": "Pause a running investigation run.", "examples": [ "<%= config.bin %> investigation runs-pause ", "<%= config.bin %> investigation runs-pause --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:runs-pause", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Pause a running investigation run", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "runs-pause.js" ] }, "investigation:runs-query": { "aliases": [], "args": { "id": { "description": "Investigation definition ID", "name": "id", "required": true } }, "description": "Query runs for an investigation definition.", "examples": [ "<%= config.bin %> investigation runs-query ", "<%= config.bin %> investigation runs-query --limit 50 --offset 0", "<%= config.bin %> investigation runs-query --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "limit": { "char": "l", "description": "Maximum number of runs to return", "name": "limit", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "offset": { "char": "o", "description": "Offset for pagination", "name": "offset", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:runs-query", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Query investigation runs", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "runs-query.js" ] }, "investigation:runs-resume": { "aliases": [], "args": { "id": { "description": "Investigation definition ID", "name": "id", "required": true }, "runId": { "description": "Run ID", "name": "runId", "required": true } }, "description": "Resume a paused investigation run.", "examples": [ "<%= config.bin %> investigation runs-resume ", "<%= config.bin %> investigation runs-resume --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:runs-resume", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Resume a paused investigation run", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "runs-resume.js" ] }, "investigation:runs": { "aliases": [], "args": { "id": { "description": "Investigation definition ID", "name": "id", "required": true } }, "description": "List evaluation runs for an investigation definition.", "examples": [ "<%= config.bin %> investigation runs ", "<%= config.bin %> investigation runs --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:runs", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List investigation eval runs", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "runs.js" ] }, "investigation:stats-duration": { "aliases": [], "args": {}, "description": "Query average run-duration stats for investigations.\n\nProvide investigation IDs with repeated --id flags, or read a JSON request body from stdin or --file.", "examples": [ "<%= config.bin %> investigation stats-duration --id ", "<%= config.bin %> investigation stats-duration --id --id ", "<%= config.bin %> investigation stats-duration --file stats-request.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" }, "id": { "char": "i", "description": "Investigation definition ID to include (repeatable)", "exclusive": [ "file" ], "name": "id", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:stats-duration", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Query investigation run duration stats", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "stats-duration.js" ] }, "investigation:stats-feedback": { "aliases": [], "args": {}, "description": "Query feedback stats for investigations.\n\nProvide investigation IDs with repeated --id flags, or read a JSON request body from stdin or --file.", "examples": [ "<%= config.bin %> investigation stats-feedback --id ", "<%= config.bin %> investigation stats-feedback --id --id ", "<%= config.bin %> investigation stats-feedback --file stats-request.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" }, "id": { "char": "i", "description": "Investigation definition ID to include (repeatable)", "exclusive": [ "file" ], "name": "id", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:stats-feedback", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Query investigation run feedback stats", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "stats-feedback.js" ] }, "investigation:stats": { "aliases": [], "args": {}, "description": "Get investigation statistics for a time range.", "examples": [ "<%= config.bin %> investigation stats --start 2026-01-01 --end 2026-02-01", "<%= config.bin %> investigation stats --start 2026-01-01 --end 2026-02-01 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "end": { "description": "End time (ISO 8601)", "name": "end", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "start": { "description": "Start time (ISO 8601)", "name": "start", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:stats", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get investigation stats", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "stats.js" ] }, "investigation:taskflow-run": { "aliases": [], "args": { "id": { "description": "Runtime investigation ID", "name": "id", "required": true } }, "description": "Get the taskflow run associated with a runtime investigation.", "examples": [ "<%= config.bin %> investigation taskflow-run ", "<%= config.bin %> investigation taskflow-run --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:taskflow-run", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get taskflow run for a runtime investigation", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "taskflow-run.js" ] }, "investigation:transitions": { "aliases": [], "args": { "id": { "description": "Runtime investigation ID", "name": "id", "required": true } }, "description": "Get available transitions for a runtime investigation.", "examples": [ "<%= config.bin %> investigation transitions ", "<%= config.bin %> investigation transitions --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:transitions", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get investigation transitions", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "transitions.js" ] }, "investigation:trigger": { "aliases": [], "args": { "id": { "description": "Investigation definition ID", "name": "id", "required": true } }, "description": "Trigger an investigation run.\n\nStarts a new investigation run and returns a run ID you can use to check results.", "examples": [ "<%= config.bin %> investigation trigger --input \"Robot stopped responding\"", "<%= config.bin %> investigation trigger --input \"Battery draining fast on device X\" --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "input": { "char": "i", "description": "Input text / problem description for the investigation", "name": "input", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "signal-id": { "description": "Optional signal ID to associate with this run", "name": "signal-id", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:trigger", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Trigger an investigation run", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "trigger.js" ] }, "investigation:update": { "aliases": [], "args": { "id": { "description": "Runtime investigation ID", "name": "id", "required": true } }, "description": "Update an existing runtime investigation.\n\nReads JSON from stdin or --file with fields to update.", "examples": [ "<%= config.bin %> investigation update --file investigation-update.json", "echo '{\"description\":\"Updated investigation\"}' | <%= config.bin %> investigation update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a runtime investigation", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "update.js" ] }, "investigation:validate": { "aliases": [], "args": { "taskflow-id": { "description": "Taskflow (investigation) ID", "name": "taskflow-id", "required": true } }, "description": "Validate the structural integrity of an investigation graph.\n\nRuns a series of checks and prints a pass/fail checklist.\nRead-only — does not modify the graph.", "examples": [ "<%= config.bin %> investigation validate ", "<%= config.bin %> investigation validate --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:validate", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Validate an investigation graph", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "validate.js" ] }, "investigation:version-create": { "aliases": [], "args": { "id": { "description": "Investigation definition ID", "name": "id", "required": true } }, "description": "Create a version snapshot for an investigation definition.", "examples": [ "<%= config.bin %> investigation version-create ", "<%= config.bin %> investigation version-create --label \"baseline-v2\"", "<%= config.bin %> investigation version-create --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "label": { "char": "l", "description": "Optional version label", "name": "label", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:version-create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create an investigation version", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "version-create.js" ] }, "investigation:version-delete": { "aliases": [], "args": { "id": { "description": "Investigation definition ID", "name": "id", "required": true }, "version": { "description": "Version number", "name": "version", "required": true } }, "description": "Delete a specific version of an investigation definition.", "examples": [ "<%= config.bin %> investigation version-delete ", "<%= config.bin %> investigation version-delete --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:version-delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete an investigation version", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "version-delete.js" ] }, "investigation:version-get": { "aliases": [], "args": { "id": { "description": "Investigation definition ID", "name": "id", "required": true }, "version": { "description": "Version number", "name": "version", "required": true } }, "description": "Get a specific version of an investigation definition.", "examples": [ "<%= config.bin %> investigation version-get ", "<%= config.bin %> investigation version-get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:version-get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get an investigation version", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "version-get.js" ] }, "investigation:version-list": { "aliases": [], "args": { "id": { "description": "Investigation definition ID", "name": "id", "required": true } }, "description": "List versions for an investigation definition.", "examples": [ "<%= config.bin %> investigation version-list ", "<%= config.bin %> investigation version-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:version-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List investigation versions", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "version-list.js" ] }, "investigation:version-restore": { "aliases": [], "args": { "id": { "description": "Investigation definition ID", "name": "id", "required": true }, "version": { "description": "Version number", "name": "version", "required": true } }, "description": "Restore an investigation definition to a previous version.", "examples": [ "<%= config.bin %> investigation version-restore ", "<%= config.bin %> investigation version-restore --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:version-restore", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Restore an investigation version", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "version-restore.js" ] }, "org:get": { "aliases": [ "org" ], "args": {}, "description": "Get information about your current organization.\n\nOrganization is a singleton resource tied to your authenticated account.\nUse `formant org` (shorthand) or `formant org get`.\nThere is no `org list` command.", "examples": [ "<%= config.bin %> org", "<%= config.bin %> org --json", "<%= config.bin %> org get", "<%= config.bin %> org get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "org:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get your current organization (singleton)", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "org", "get.js" ] }, "persona:delegate-task": { "aliases": [], "args": { "id": { "description": "Persona ID (UUID)", "name": "id", "required": true }, "goal": { "description": "The task goal / instruction for the persona", "name": "goal", "required": true } }, "description": "Delegate a task to a persona for async execution.\n\nCreates a task with the given goal, assigns it to the persona, and queues it to run in the background. Returns immediately with a task ID you can use to check status later via \"persona task-status\".", "examples": [ "<%= config.bin %> persona delegate-task \"Analyze recent device failures and summarize findings\"", "<%= config.bin %> persona delegate-task \"Generate a daily report of fleet health\" --name \"Daily Fleet Report\"", "<%= config.bin %> persona delegate-task \"Check all offline devices\" --dev" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "name": { "char": "n", "description": "Task name (defaults to first 50 chars of goal)", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "persona:delegate-task", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delegate an async task to a persona", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "persona", "delegate-task.js" ] }, "persona:get": { "aliases": [], "args": { "id": { "description": "Persona ID (UUID)", "name": "id", "required": true } }, "description": "Get detailed information about a persona including its integrations and available tools.\n\nUses the user-level persona endpoint which merges org, persona, and user configurations.", "examples": [ "<%= config.bin %> persona get ", "<%= config.bin %> persona get --json", "<%= config.bin %> persona get --dev" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "persona:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get persona details and tools", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "persona", "get.js" ] }, "persona:list": { "aliases": [], "args": {}, "description": "List AI personas available in your organization.\n\nShows both built-in and custom personas with their ID, name, and description.", "examples": [ "<%= config.bin %> persona list", "<%= config.bin %> persona list --json", "<%= config.bin %> persona list --dev" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "persona:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List AI personas", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "persona", "list.js" ] }, "persona:task-status": { "aliases": [], "args": { "taskId": { "description": "Task ID (from delegate-task output)", "name": "taskId", "required": true } }, "description": "Check the status and results of a delegated task.\n\nShows all runs for a task including their status, result summary, and timestamps.", "examples": [ "<%= config.bin %> persona task-status ", "<%= config.bin %> persona task-status --json", "<%= config.bin %> persona task-status --dev" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "persona:task-status", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Check status of a delegated task", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "persona", "task-status.js" ] }, "principle:create": { "aliases": [], "args": {}, "description": "Create one or more principles.\n\nReads JSON from stdin or --file.", "examples": [ "<%= config.bin %> principle create --file principle.json", "<%= config.bin %> principle create --file principles.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "principle:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a principle", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "principle", "create.js" ] }, "principle:disable": { "aliases": [], "args": { "id": { "description": "Principle ID", "name": "id", "required": true } }, "description": "Disable a principle by ID. This is a soft disable, not a hard delete.", "examples": [ "<%= config.bin %> principle disable " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "principle:disable", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Disable a principle", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "principle", "disable.js" ] }, "principle:get": { "aliases": [], "args": { "id": { "description": "Principle ID", "name": "id", "required": true } }, "description": "Get a principle by ID.", "examples": [ "<%= config.bin %> principle get ", "<%= config.bin %> principle get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "principle:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get a principle", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "principle", "get.js" ] }, "principle:list": { "aliases": [], "args": {}, "description": "List organization principles.", "examples": [ "<%= config.bin %> principle list", "<%= config.bin %> principle list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "principle:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List principles", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "principle", "list.js" ] }, "principle:update": { "aliases": [], "args": { "id": { "description": "Principle ID", "name": "id", "required": true } }, "description": "Update a principle.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> principle update --file changes.json", "echo '{\"message\":\"Updated principle\"}' | <%= config.bin %> principle update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "principle:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a principle", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "principle", "update.js" ] }, "role:create": { "aliases": [], "args": {}, "description": "Create a new role.\n\nReads JSON from stdin or --file. Pipe output from 'role get --json' to clone a role.", "examples": [ "<%= config.bin %> role create --file role.json", "<%= config.bin %> role get --json | <%= config.bin %> role create", "<%= config.bin %> role list --json | <%= config.bin %> role create" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "role:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a role", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "role", "create.js" ] }, "role:delete": { "aliases": [], "args": { "id": { "description": "Role ID (UUID)", "name": "id", "required": true } }, "description": "Delete a role by ID.", "examples": [ "<%= config.bin %> role delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "role:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete a role", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "role", "delete.js" ] }, "role:get": { "aliases": [], "args": { "id": { "description": "Role ID (UUID)", "name": "id", "required": true } }, "description": "Get detailed information about a role.", "examples": [ "<%= config.bin %> role get ", "<%= config.bin %> role get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "role:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get role details", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "role", "get.js" ] }, "role:list": { "aliases": [], "args": {}, "description": "List all roles in your organization.", "examples": [ "<%= config.bin %> role list", "<%= config.bin %> role list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "role:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List roles", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "role", "list.js" ] }, "role:update": { "aliases": [], "args": { "id": { "description": "Role ID (UUID)", "name": "id", "required": true } }, "description": "Update an existing role.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> role update --file changes.json", "echo '{\"name\":\"new-name\"}' | <%= config.bin %> role update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "role:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a role", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "role", "update.js" ] }, "query:current-value-get": { "aliases": [], "args": { "id": { "description": "Metadata ID", "name": "id", "required": true } }, "description": "Get current value for a metadata ID.", "examples": [ "<%= config.bin %> query current-value-get ", "<%= config.bin %> query current-value-get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "query:current-value-get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get metadata current value by ID", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "query", "current-value-get.js" ] }, "query:current-value-list": { "aliases": [], "args": {}, "description": "List metadata current values.\n\nOptionally provide a filter body from stdin or --file.", "examples": [ "<%= config.bin %> query current-value-list", "<%= config.bin %> query current-value-list --file metadata-filter.json", "<%= config.bin %> query current-value-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON filter body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "query:current-value-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List metadata current values", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "query", "current-value-list.js" ] }, "query:device-ids-list": { "aliases": [], "args": {}, "description": "List device IDs from metadata.\n\nOptionally provide a filter body from stdin or --file.", "examples": [ "<%= config.bin %> query device-ids-list", "<%= config.bin %> query device-ids-list --file metadata-filter.json", "<%= config.bin %> query device-ids-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON filter body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "query:device-ids-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List metadata device IDs", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "query", "device-ids-list.js" ] }, "query": { "aliases": [], "args": {}, "description": "Query telemetry stream data for a device over a time range.\n\nReturns time-series datapoints for the specified stream(s). Supports aggregation\nfor downsampling large datasets, and --latest-values-only to get only the most recent value.\n\nUse --all-streams with --latest-values-only to automatically discover and query all\nstreams — both from the device configuration and from actual ingested data\n(unconfigured streams included).\n\nStream types: numeric, text, image, video, location, json, bitset, battery, health,\n\"numeric set\", \"point cloud\", localization, \"transform tree\", file.\n\nAggregate levels: second, 5 seconds, 30 seconds, minute, 5 minutes, 30 minutes,\nhour, 4 hours, 12 hours, day, week, month, year.", "examples": [ "<%= config.bin %> query --device --stream battery_level --start 2026-01-01 --end 2026-01-02", "<%= config.bin %> query --device --stream speed --aggregate hour --start 2026-01-01 --end 2026-02-01", "<%= config.bin %> query --device --stream battery_level --stream temperature --start 2026-01-01 --end 2026-01-02", "<%= config.bin %> query --device --device --stream battery_level --start 2026-01-01 --end 2026-01-02", "<%= config.bin %> query --device --stream battery_level --start 2026-01-01 --end 2026-02-01 --latest-values-only", "<%= config.bin %> query --device --all-streams --start 2026-01-01 --end 2026-02-01 --latest-values-only", "<%= config.bin %> query --device --stream temperature --type numeric --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "aggregate": { "char": "a", "description": "Aggregation level for downsampling", "name": "aggregate", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "all-streams": { "description": "Query all streams for the device — from config and from ingested data (requires single --device and --latest-values-only)", "name": "all-streams", "allowNo": false, "type": "boolean" }, "days": { "description": "How many days back to look for unconfigured streams when using --all-streams", "name": "days", "default": 14, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "device": { "char": "d", "description": "Device ID(s), can be specified multiple times", "name": "device", "required": true, "hasDynamicHelp": false, "multiple": true, "type": "option" }, "end": { "description": "End time (ISO 8601)", "name": "end", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "latest-values-only": { "description": "Only return the most recent value per stream", "name": "latest-values-only", "allowNo": false, "type": "boolean" }, "limit": { "char": "l", "description": "Maximum number of datapoints", "name": "limit", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "start": { "description": "Start time (ISO 8601)", "name": "start", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stream": { "char": "s", "description": "Stream name(s), can be specified multiple times", "name": "stream", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "type": { "description": "Filter by stream type", "name": "type", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "query", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Query telemetry stream data", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "query", "index.js" ] }, "query:metadata-find-or-create": { "aliases": [], "args": {}, "description": "Find or create metadata.\n\nReads JSON request body from stdin or --file.", "examples": [ "<%= config.bin %> query metadata-find-or-create --file metadata.json", "<%= config.bin %> query metadata-find-or-create --file metadata.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON metadata body (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "query:metadata-find-or-create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Find or create metadata", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "query", "metadata-find-or-create.js" ] }, "query:metadata-query": { "aliases": [], "args": {}, "description": "Run a metadata query.\n\nReads JSON query body from stdin or --file.", "examples": [ "<%= config.bin %> query metadata-query --file metadata-query.json", "<%= config.bin %> query metadata-query --file metadata-query.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON query body (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "query:metadata-query", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Run metadata query", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "query", "metadata-query.js" ] }, "query:presence-counts": { "aliases": [], "args": {}, "description": "Query grouped stream data presence counts over an interval.\n\nReads a JSON interval query body from stdin or --file.", "examples": [ "<%= config.bin %> query presence-counts --file presence-query.json", "cat presence-query.json | <%= config.bin %> query presence-counts", "<%= config.bin %> query presence-counts --file presence-query.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON interval query body (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "query:presence-counts", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Query grouped stream data presence counts", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "query", "presence-counts.js" ] }, "query:presence": { "aliases": [], "args": {}, "description": "Query stream data presence over an interval.\n\nReads a JSON interval query body from stdin or --file.", "examples": [ "<%= config.bin %> query presence --file presence-query.json", "cat presence-query.json | <%= config.bin %> query presence", "<%= config.bin %> query presence --file presence-query.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON interval query body (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "query:presence", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Query stream data presence", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "query", "presence.js" ] }, "query:seek": { "aliases": [], "args": {}, "description": "Seek to the next or previous timestamp with matching stream presence.\n\nReads a JSON seek query body from stdin or --file.", "examples": [ "<%= config.bin %> query seek --file seek-query.json", "cat seek-query.json | <%= config.bin %> query seek", "<%= config.bin %> query seek --file seek-query.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON seek query body (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "query:seek", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Seek to a timestamp with matching stream presence", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "query", "seek.js" ] }, "query:stream-current-value-device-streams": { "aliases": [], "args": {}, "description": "Query current values grouped by device for specific stream names.\n\nReads a JSON device-stream query body from stdin or --file.", "examples": [ "<%= config.bin %> query stream-current-value-device-streams --file device-stream-query.json", "cat device-stream-query.json | <%= config.bin %> query stream-current-value-device-streams", "<%= config.bin %> query stream-current-value-device-streams --file device-stream-query.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON device-stream query body (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "query:stream-current-value-device-streams", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Query current values grouped by device streams", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "query", "stream-current-value-device-streams.js" ] }, "query:stream-current-value": { "aliases": [], "args": {}, "description": "Query the latest current values for streams.\n\nOptionally provide a JSON current-value query body from stdin or --file.", "examples": [ "<%= config.bin %> query stream-current-value", "<%= config.bin %> query stream-current-value --file stream-current-value-query.json", "<%= config.bin %> query stream-current-value --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON current-value query body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "query:stream-current-value", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Query current values for streams", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "query", "stream-current-value.js" ] }, "query:stream-names-list": { "aliases": [], "args": {}, "description": "List stream names from metadata.\n\nOptionally provide a filter body from stdin or --file.", "examples": [ "<%= config.bin %> query stream-names-list", "<%= config.bin %> query stream-names-list --file metadata-filter.json", "<%= config.bin %> query stream-names-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON filter body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "query:stream-names-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List metadata stream names", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "query", "stream-names-list.js" ] }, "schedule:create": { "aliases": [], "args": {}, "description": "Create a new schedule.\n\nReads JSON from stdin or --file. Pipe output from 'schedule get --json' to clone a schedule.", "examples": [ "<%= config.bin %> schedule create --file schedule.json", "<%= config.bin %> schedule get --json | <%= config.bin %> schedule create", "<%= config.bin %> schedule list --json | <%= config.bin %> schedule create" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "schedule:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a schedule", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "schedule", "create.js" ] }, "schedule:delete": { "aliases": [], "args": { "id": { "description": "Schedule ID (UUID)", "name": "id", "required": true } }, "description": "Delete a schedule by ID.", "examples": [ "<%= config.bin %> schedule delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "schedule:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete a schedule", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "schedule", "delete.js" ] }, "schedule:get": { "aliases": [], "args": { "id": { "description": "Schedule ID (UUID)", "name": "id", "required": true } }, "description": "Get detailed information about a schedule.\n\nShows the full schedule configuration including cron expression, command template,\ninvestigation link, and execution settings.", "examples": [ "<%= config.bin %> schedule get ", "<%= config.bin %> schedule get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "schedule:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get schedule details", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "schedule", "get.js" ] }, "schedule:list": { "aliases": [], "args": {}, "description": "List all schedules in your organization.\n\nSchedules can trigger commands or investigations on a recurring (cron) or one-time basis.", "examples": [ "<%= config.bin %> schedule list", "<%= config.bin %> schedule list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "schedule:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List schedules", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "schedule", "list.js" ] }, "schedule:update": { "aliases": [], "args": { "id": { "description": "Schedule ID (UUID)", "name": "id", "required": true } }, "description": "Update an existing schedule.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> schedule update --file changes.json", "echo '{\"name\":\"new-name\"}' | <%= config.bin %> schedule update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "schedule:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a schedule", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "schedule", "update.js" ] }, "schema:commands": { "aliases": [], "args": {}, "description": "Output machine-readable schemas for all formant commands.\n\nSchemas are generated from oclif command metadata and include args, flags,\nrequired fields, options, exclusivity constraints, and JSON output field profiles.", "examples": [ "<%= config.bin %> schema commands --json", "<%= config.bin %> schema commands --json --field commands.output", "<%= config.bin %> schema commands --topic device --json", "<%= config.bin %> schema commands --command \"device list\" --json", "<%= config.bin %> schema commands --command \"device list\" --json --full" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "command": { "description": "Filter to a specific command (e.g. \"device list\" or \"device:list\")", "name": "command", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "topic": { "description": "Filter by topic (e.g. device, view, config-template)", "name": "topic", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "schema:commands", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List command schemas for tooling and agents", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "schema", "commands.js" ] }, "schema:operation": { "aliases": [], "args": { "operationId": { "description": "Operation ID (for example: query.stream-data.query)", "name": "operationId", "required": true } }, "description": "Show full schema for one backend operation contract.\n\nUse this to inspect route/method/target metadata plus publish-safe OpenAPI-derived\nparameter, request-body, and response schema information for a specific\noperation id from the CLI contract registry.", "examples": [ "<%= config.bin %> schema operation query.stream-data.query --json", "<%= config.bin %> schema operation theopolis.signals.create" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "schema:operation", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Show schema for a single typed operation contract", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "schema", "operation.js" ] }, "schema:operations": { "aliases": [], "args": {}, "description": "Output machine-readable backend operation contracts used by the CLI.\n\nIncludes service target, method, path template, stability, summary, and any\npublish-safe OpenAPI-derived parameter, request-body, and response schema\nmetadata available for each typed operation in the contract registry.", "examples": [ "<%= config.bin %> schema operations --json", "<%= config.bin %> schema operations --target theopolis --json", "<%= config.bin %> schema operations --stability stable", "<%= config.bin %> schema operations --id query.stream-data.query --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "id": { "description": "Filter to one operation id (exact match)", "name": "id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stability": { "description": "Filter by operation stability", "name": "stability", "hasDynamicHelp": false, "multiple": false, "options": [ "experimental", "stable" ], "type": "option" }, "target": { "description": "Filter by API target service", "name": "target", "hasDynamicHelp": false, "multiple": false, "options": [ "admin", "gateway", "ingest", "query", "theopolis" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "schema:operations", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List typed backend operation contracts", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "schema", "operations.js" ] }, "share:create": { "aliases": [], "args": {}, "description": "Create one or more share links.\n\nReads JSON from stdin or --file.", "examples": [ "<%= config.bin %> share create --file share.json", "<%= config.bin %> share create --file shares.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a share", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "share", "create.js" ] }, "share:delete": { "aliases": [], "args": { "code": { "description": "Share code", "name": "code", "required": true } }, "description": "Revoke a share by code.", "examples": [ "<%= config.bin %> share delete ", "<%= config.bin %> share delete --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete a share", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "share", "delete.js" ] }, "share:get": { "aliases": [], "args": { "code": { "description": "Share code", "name": "code", "required": true } }, "description": "Get a share by code.", "examples": [ "<%= config.bin %> share get ", "<%= config.bin %> share get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get a share", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "share", "get.js" ] }, "share:list": { "aliases": [], "args": {}, "description": "List share links in your organization.", "examples": [ "<%= config.bin %> share list", "<%= config.bin %> share list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List shares", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "share", "list.js" ] }, "share:query": { "aliases": [], "args": {}, "description": "Query share links with simple pagination filters.", "examples": [ "<%= config.bin %> share query", "<%= config.bin %> share query --count 10 --offset 20", "<%= config.bin %> share query --has-module --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "count": { "description": "Maximum number of shares to return", "name": "count", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "has-module": { "description": "Only return shares associated with modules when true", "name": "has-module", "allowNo": false, "type": "boolean" }, "offset": { "description": "Result offset", "name": "offset", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:query", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Query shares", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "share", "query.js" ] }, "signal:count": { "aliases": [], "args": {}, "description": "Get counts of signals grouped by type.\n\nReturns total counts and per-type breakdowns (manual, eventTrigger, schedule, slack).", "examples": [ "<%= config.bin %> signal count", "<%= config.bin %> signal count --start 2026-01-01 --end 2026-02-01", "<%= config.bin %> signal count --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "end": { "description": "End time (ISO 8601)", "name": "end", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "start": { "description": "Start time (ISO 8601)", "name": "start", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "signal:count", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get signal counts by type", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "signal", "count.js" ] }, "signal:create": { "aliases": [], "args": { "goal": { "description": "Goal or description for the signal", "name": "goal", "required": true } }, "description": "Create a manual signal.\n\nSignals are points of interest that can trigger AI-powered investigations. Use this to\nmanually create a signal with a goal description, optionally targeting a specific device\nor persona.", "examples": [ "<%= config.bin %> signal create \"Robot arm jammed at joint 3\"", "<%= config.bin %> signal create \"Battery draining fast\" --device ", "<%= config.bin %> signal create \"Investigate sensor anomaly\" --persona ", "<%= config.bin %> signal create \"Test alarm scenario\" --investigation ", "<%= config.bin %> signal create \"Motor overheated\" --investigation --ground-truth \"Should identify motor thermal fault\"" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "device": { "char": "d", "description": "Device ID to associate with this signal", "name": "device", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "ground-truth": { "char": "g", "dependsOn": [ "investigation" ], "description": "Expected outcome (ground truth) for this signal — requires --investigation", "name": "ground-truth", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "investigation": { "char": "i", "description": "Investigation (taskflow) ID this signal targets", "name": "investigation", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "persona": { "char": "p", "description": "Persona ID to handle this signal", "name": "persona", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "signal:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a manual signal", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "signal", "create.js" ] }, "signal:delete": { "aliases": [], "args": { "id": { "description": "Signal ID (UUID)", "name": "id", "required": true } }, "description": "Delete a signal by ID.", "examples": [ "<%= config.bin %> signal delete ", "<%= config.bin %> signal delete --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "signal:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete signal", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "signal", "delete.js" ] }, "signal:get": { "aliases": [], "args": { "id": { "description": "Signal ID (UUID)", "name": "id", "required": true } }, "description": "Get detailed information about a specific signal by its ID.\n\nShows signal details including the triggering event, goal, status, and type (manual, \neventTrigger, schedule, slack). Use --trace to also fetch the event and event trigger \ninformation.", "examples": [ "<%= config.bin %> signal get ", "<%= config.bin %> signal get --trace", "<%= config.bin %> signal get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "trace": { "description": "Fetch and display the triggering event and event trigger information", "name": "trace", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "signal:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get a signal by ID", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "signal", "get.js" ] }, "signal:list": { "aliases": [], "args": {}, "description": "List all signals in your organization.\n\nSignals are points of interest that trigger AI-powered investigations. They can be\ncreated manually, generated from device events, scheduled, or from Slack/Teams integrations.\n\nUse --investigation to also show ground truth (expected outcome) for each signal\nthat has one assigned for that investigation.", "examples": [ "<%= config.bin %> signal list", "<%= config.bin %> signal list --investigation ", "<%= config.bin %> signal list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "investigation": { "char": "i", "description": "Investigation (taskflow) ID — shows ground truth for signals that have one", "name": "investigation", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "signal:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List all signals", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "signal", "list.js" ] }, "signal:query": { "aliases": [], "args": {}, "description": "Query signals by time range and type.\n\nSignal types: manual, eventTrigger, schedule, slack.\n\nUse --investigation to also show ground truth (expected outcome) for each signal.", "examples": [ "<%= config.bin %> signal query --start 2026-01-01", "<%= config.bin %> signal query --start 2026-01-01 --end 2026-02-01 --type eventTrigger", "<%= config.bin %> signal query --start 2026-01-01 --investigation ", "<%= config.bin %> signal query --start 2026-01-01 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "end": { "description": "End time (ISO 8601)", "name": "end", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "investigation": { "char": "i", "description": "Investigation (taskflow) ID — shows ground truth for signals that have one", "name": "investigation", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "start": { "description": "Start time (ISO 8601)", "name": "start", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "type": { "description": "Filter by signal type", "name": "type", "hasDynamicHelp": false, "multiple": false, "options": [ "manual", "eventTrigger", "schedule", "slack" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "signal:query", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Query signals by time range", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "signal", "query.js" ] }, "signal:set-ground-truth": { "aliases": [], "args": { "signalId": { "description": "Signal ID (UUID)", "name": "signalId", "required": true }, "investigationId": { "description": "Investigation (taskflow) ID", "name": "investigationId", "required": true }, "expectedOutcome": { "description": "The expected outcome / ground truth for this signal", "name": "expectedOutcome", "required": true } }, "description": "Assign a ground truth (expected outcome) to a signal for an investigation.\n\nGround truths define what the correct outcome should be when an investigation processes\na given signal. They are used for evaluation and quality measurement of investigation\nworkflows.", "examples": [ "<%= config.bin %> signal set-ground-truth \"The alarm should be dismissed as a false positive\"", "<%= config.bin %> signal set-ground-truth \"Root cause: overheated motor in joint 3\" --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "signal:set-ground-truth", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Assign ground truth to a signal", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "signal", "set-ground-truth.js" ] }, "signal:trigger": { "aliases": [], "args": { "id": { "description": "Signal ID (UUID)", "name": "id", "required": true } }, "description": "Trigger a signal by ID.\n\nOptionally provide a JSON body from stdin or --file.", "examples": [ "<%= config.bin %> signal trigger ", "<%= config.bin %> signal trigger --file trigger-body.json", "<%= config.bin %> signal trigger --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON trigger body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "signal:trigger", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Trigger signal", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "signal", "trigger.js" ] }, "signal:update": { "aliases": [], "args": { "id": { "description": "Signal ID (UUID)", "name": "id", "required": true } }, "description": "Update an existing signal.\n\nReads JSON from stdin or --file with fields to update.", "examples": [ "<%= config.bin %> signal update --file signal-update.json", "echo '{\"goal\":\"Investigate new behavior\"}' | <%= config.bin %> signal update ", "<%= config.bin %> signal update --file signal-update.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON update body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "signal:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update signal", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "signal", "update.js" ] }, "snowflake:cancel": { "aliases": [], "args": { "queryId": { "description": "Snowflake query ID to cancel", "name": "queryId", "required": true } }, "description": "Cancel a running Snowflake query by its query ID.\n\nCalls SYSTEM$CANCEL_QUERY to abort the query. This is best-effort — the query\nmay have already completed or the warehouse may not be able to cancel it.\n\nThe query ID is returned by 'formant snowflake load' and can also be found in\nthe Snowflake Query History UI.\n\nCredentials are read from environment variables:\n SNOWFLAKE_ACCOUNT e.g. myorg-myaccount.snowflakecomputing.com\n SNOWFLAKE_USER username\n SNOWFLAKE_PASSWORD password", "examples": [ "<%= config.bin %> snowflake cancel 01b234cd-0000-abcd-0001-000000000001", "<%= config.bin %> snowflake cancel 01b234cd-0000-abcd-0001-000000000001 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "hidden": true, "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "hidden": true, "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "verbose": { "description": "Print each SQL statement before executing", "name": "verbose", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "snowflake:cancel", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Cancel a running Snowflake query", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "snowflake", "cancel.js" ] }, "snowflake:create-stage": { "aliases": [], "args": { "name": { "description": "Stage name", "name": "name", "required": true } }, "description": "Create a Snowflake external stage pointing to an S3 bucket.\n\nStages let you reference S3 files directly in COPY INTO and INFER_SCHEMA\nwithout uploading them first. Once created, pass the stage name as the FILE\nargument to 'snowflake load' and 'snowflake create-table':\n\n formant snowflake load @my_stage/data.csv --table mydb.public.orders\n formant snowflake create-table @my_stage/data.csv --table mydb.public.orders\n\nAuthentication: provide --aws-key / --aws-secret (or AWS_ACCESS_KEY_ID /\nAWS_SECRET_ACCESS_KEY env vars), or pass --storage-integration to reference a\npre-configured Snowflake storage integration (recommended for production).\n\nSnowflake credentials are read from environment variables:\n SNOWFLAKE_ACCOUNT e.g. myorg-myaccount.snowflakecomputing.com\n SNOWFLAKE_USER username\n SNOWFLAKE_PASSWORD password", "examples": [ "<%= config.bin %> snowflake create-stage my_stage --url s3://my-bucket/data/ --aws-key AKIA... --aws-secret ...", "<%= config.bin %> snowflake create-stage my_stage --url s3://my-bucket/data/ --storage-integration MY_S3_INT", "<%= config.bin %> snowflake create-stage my_stage --url s3://my-bucket/data/ --replace --dry-run" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "hidden": true, "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "hidden": true, "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "aws-key": { "description": "AWS access key ID (or set AWS_ACCESS_KEY_ID env var)", "exclusive": [ "storage-integration" ], "name": "aws-key", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "aws-secret": { "description": "AWS secret access key (or set AWS_SECRET_ACCESS_KEY env var)", "exclusive": [ "storage-integration" ], "name": "aws-secret", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dry-run": { "description": "Print the DDL without executing it", "name": "dry-run", "allowNo": false, "type": "boolean" }, "replace": { "description": "Use CREATE OR REPLACE STAGE", "name": "replace", "allowNo": false, "type": "boolean" }, "storage-integration": { "description": "Snowflake storage integration name (alternative to AWS keys)", "exclusive": [ "aws-key", "aws-secret" ], "name": "storage-integration", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "url": { "description": "S3 URL for the stage (e.g. s3://my-bucket/my-path/)", "name": "url", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "description": "Print each SQL statement before executing", "name": "verbose", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "snowflake:create-stage", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a Snowflake external stage pointing to S3", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "snowflake", "create-stage.js" ] }, "snowflake:create-table": { "aliases": [], "args": { "file": { "description": "Local CSV path or stage reference (e.g. @my_stage/path/to/file.csv)", "name": "file", "required": true } }, "description": "Infer schema from a CSV file and create a Snowflake table.\n\nFILE can be a local path or a stage reference starting with '@':\n\n Local file — uploaded to an internal stage for inference, then removed:\n formant snowflake create-table data.csv --table mydb.public.orders\n\n Stage reference — inferred directly from the stage (no upload step):\n formant snowflake create-table @my_s3_stage/data.csv --table mydb.public.orders\n\nApplies type relaxations to the INFER_SCHEMA output before executing CREATE TABLE:\n\n TIMESTAMP* → TIMESTAMP_NTZ (any variant/precision)\n NUMBER(n,0) → /* original */ INTEGER (whole numbers)\n NUMBER(n,1–3) → /* original */ FLOAT (low-precision decimals)\n NUMBER(n,4+) → /* original */ DOUBLE (high-precision decimals)\n\nThe original inferred type is preserved as a SQL comment beside INTEGER, FLOAT,\nand DOUBLE columns. Use --dry-run to inspect the DDL before creating anything.\n\nCredentials are read from environment variables:\n SNOWFLAKE_ACCOUNT e.g. myorg-myaccount.snowflakecomputing.com\n SNOWFLAKE_USER username\n SNOWFLAKE_PASSWORD password\n SNOWFLAKE_WAREHOUSE (optional)", "examples": [ "<%= config.bin %> snowflake create-table data.csv --table mydb.public.orders", "<%= config.bin %> snowflake create-table data.csv --table mydb.public.orders --dry-run", "<%= config.bin %> snowflake create-table data.csv --table mydb.public.orders --if-not-exists", "<%= config.bin %> snowflake create-table data.csv --table mydb.public.orders --field-delimiter \"\\t\"", "<%= config.bin %> snowflake create-table @my_s3_stage/data.csv --table mydb.public.orders", "<%= config.bin %> snowflake create-table @my_s3_stage/data.csv --table mydb.public.orders --dry-run" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "hidden": true, "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Internal stage for local file uploads (ignored for @stage references)", "name": "stage", "default": "@~/formant_cli_tmp", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "dry-run": { "description": "Print the CREATE TABLE DDL without executing it", "name": "dry-run", "allowNo": false, "type": "boolean" }, "field-delimiter": { "description": "Field delimiter character in the CSV file", "name": "field-delimiter", "default": ",", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "file": { "description": "Specific file name(s) within the stage location for INFER_SCHEMA to sample (repeatable). When set, FILE arg should be a stage prefix (e.g. @my_stage/path/).", "name": "file", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "max-records": { "description": "Maximum number of records per file for INFER_SCHEMA to sample", "name": "max-records", "default": 1000, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "if-not-exists": { "description": "Add IF NOT EXISTS to the CREATE TABLE statement", "name": "if-not-exists", "allowNo": false, "type": "boolean" }, "sheet": { "description": "Sheet name or 0-based index to use from an XLSX file (default: first sheet)", "name": "sheet", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "table": { "description": "Fully qualified target table name (database.schema.table)", "name": "table", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "description": "Print each SQL statement before executing", "name": "verbose", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "snowflake:create-table", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a Snowflake table by inferring schema from a CSV file", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "snowflake", "create-table.js" ] }, "snowflake:list-stage": { "aliases": [], "args": { "stage": { "description": "Stage path to list (default: @~)", "name": "stage", "required": false } }, "description": "List files in a Snowflake internal stage.\n\nCredentials are read from environment variables:\n SNOWFLAKE_ACCOUNT e.g. myorg-myaccount\n SNOWFLAKE_USER username\n SNOWFLAKE_TOKEN PAT token (preferred)\n SNOWFLAKE_WAREHOUSE warehouse name", "examples": [ "<%= config.bin %> snowflake list-stage", "<%= config.bin %> snowflake list-stage @~/formant_cli_tmp", "<%= config.bin %> snowflake list-stage --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "hidden": true, "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "hidden": true, "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "verbose": { "description": "Print each SQL statement before executing", "name": "verbose", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "snowflake:list-stage", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List files in a Snowflake internal stage", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "snowflake", "list-stage.js" ] }, "snowflake:list": { "aliases": [], "args": {}, "description": "List load history for a Snowflake table.\n\nQueries INFORMATION_SCHEMA.COPY_HISTORY for the specified table and returns\nrecent load operations. Use --since to expand the time window.\n\nCredentials are read from environment variables:\n SNOWFLAKE_ACCOUNT e.g. myorg-myaccount.snowflakecomputing.com\n SNOWFLAKE_USER username\n SNOWFLAKE_PASSWORD password", "examples": [ "<%= config.bin %> snowflake list --table mydb.public.orders", "<%= config.bin %> snowflake list --table mydb.public.orders --limit 50 --since 30", "<%= config.bin %> snowflake list --table mydb.public.orders --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "hidden": true, "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "hidden": true, "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "limit": { "description": "Maximum number of records to return", "name": "limit", "default": 20, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "since": { "description": "Number of days of history to include", "name": "since", "default": 7, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "table": { "description": "Fully qualified table name (database.schema.table)", "name": "table", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "description": "Print each SQL statement before executing", "name": "verbose", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "snowflake:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List recent load history for a Snowflake table", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "snowflake", "list.js" ] }, "snowflake:load": { "aliases": [], "args": { "file": { "description": "Local CSV path or stage reference (e.g. @my_stage/path/to/file.csv)", "name": "file", "required": true } }, "description": "Load a CSV file into a Snowflake table using PUT + COPY INTO.\n\nFILE can be a local path or a stage reference starting with '@':\n\n Local file — uploaded to an internal stage, then loaded:\n formant snowflake load data.csv --table mydb.public.orders\n\n Stage reference — loaded directly (no upload step):\n formant snowflake load @my_s3_stage/data.csv --table mydb.public.orders\n formant snowflake load @my_s3_stage/ --table mydb.public.orders --pattern \".*\\.csv\"\n\nUse 'formant snowflake create-stage' to define a named S3 stage.\nThe query ID printed on success can be used with 'formant snowflake status'.\n\nCredentials are read from environment variables:\n SNOWFLAKE_ACCOUNT e.g. myorg-myaccount.snowflakecomputing.com\n SNOWFLAKE_USER username\n SNOWFLAKE_PASSWORD password\n SNOWFLAKE_WAREHOUSE (optional)", "examples": [ "<%= config.bin %> snowflake load data.csv --table mydb.public.orders", "<%= config.bin %> snowflake load data.csv --table mydb.public.orders --skip-header false", "<%= config.bin %> snowflake load data.csv --table mydb.public.orders --field-delimiter \"\\t\"", "<%= config.bin %> snowflake load @my_s3_stage/2026/orders.csv --table mydb.public.orders", "<%= config.bin %> snowflake load @my_s3_stage/ --table mydb.public.orders --pattern \".*\\.csv\"", "<%= config.bin %> snowflake load @my_s3_stage/ --table mydb.public.orders --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "hidden": true, "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Internal stage for local file uploads (ignored for @stage references)", "name": "stage", "default": "@~/formant_cli_tmp", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "field-delimiter": { "description": "Field delimiter character in the CSV file", "name": "field-delimiter", "default": ",", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "pattern": { "description": "Regex pattern for matching files in a stage reference (e.g. \".*\\.csv\"). Only used with @stage paths.", "name": "pattern", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "skip-header": { "description": "Skip the first (header) row", "name": "skip-header", "allowNo": true, "type": "boolean" }, "sheet": { "description": "Sheet name or 0-based index to load from an XLSX file (default: first sheet)", "name": "sheet", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "table": { "description": "Fully qualified target table name (database.schema.table)", "name": "table", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "description": "Print each SQL statement before executing", "name": "verbose", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "snowflake:load", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Load a CSV file into a Snowflake table", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "snowflake", "load.js" ] }, "snowflake:put": { "aliases": [], "args": { "file": { "description": "Local file path (CSV or XLSX)", "name": "file", "required": true } }, "description": "Upload a local file to a Snowflake internal stage.\n\nConverts XLSX files to CSV before uploading. XLSX files are placed in a\nsubfolder named after the source file so sheets from different workbooks\ndon't collide. When --sheet is omitted all sheets are uploaded.\n\n formant snowflake put data.xlsx # all sheets\n formant snowflake put data.xlsx --sheet \"Sheet2\" # single sheet\n formant snowflake create-table @~/formant_cli_tmp/data.xlsx/Sheet2.csv --table mydb.schema.orders\n formant snowflake load @~/formant_cli_tmp/data.xlsx/Sheet2.csv --table mydb.schema.orders\n\nCredentials are read from environment variables:\n SNOWFLAKE_ACCOUNT e.g. myorg-myaccount\n SNOWFLAKE_USER username\n SNOWFLAKE_TOKEN PAT token (preferred)\n SNOWFLAKE_WAREHOUSE warehouse name", "examples": [ "<%= config.bin %> snowflake put data.csv", "<%= config.bin %> snowflake put data.xlsx", "<%= config.bin %> snowflake put data.xlsx --sheet \"Sheet2\"", "<%= config.bin %> snowflake put data.xlsx --sheet 1 --stage @~/my_stage", "<%= config.bin %> snowflake put data.csv --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "hidden": true, "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Internal stage to upload to", "name": "stage", "default": "@~/formant_cli_tmp", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "sheet": { "description": "Sheet name or 0-based index (XLSX only). Omit to upload all sheets.", "name": "sheet", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "description": "Print each SQL statement before executing", "name": "verbose", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "snowflake:put", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Upload a local file (CSV or XLSX) to a Snowflake internal stage", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "snowflake", "put.js" ] }, "snowflake:remove": { "aliases": [], "args": { "path": { "description": "Stage path to remove (e.g. @~/formant_cli_tmp/data.csv). Glob patterns are supported.", "name": "path", "required": true } }, "description": "Remove a file from a Snowflake internal stage.\n\nThe stage path accepts glob patterns to remove multiple files at once:\n\n formant snowflake remove @~/formant_cli_tmp/data.csv\n formant snowflake remove '@~/formant_cli_tmp/data_%.csv'\n\nCredentials are read from environment variables:\n SNOWFLAKE_ACCOUNT e.g. myorg-myaccount\n SNOWFLAKE_USER username\n SNOWFLAKE_TOKEN PAT token (preferred)\n SNOWFLAKE_WAREHOUSE warehouse name", "examples": [ "<%= config.bin %> snowflake remove @~/formant_cli_tmp/data.csv", "<%= config.bin %> snowflake remove '@~/formant_cli_tmp/data_%.csv'", "<%= config.bin %> snowflake remove @~/formant_cli_tmp/data.csv --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "hidden": true, "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "hidden": true, "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "verbose": { "description": "Print each SQL statement before executing", "name": "verbose", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "snowflake:remove", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Remove a file from a Snowflake internal stage", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "snowflake", "remove.js" ] }, "snowflake:status": { "aliases": [], "args": { "queryId": { "description": "Snowflake query ID (returned by snowflake load)", "name": "queryId", "required": true } }, "description": "Get status and details for a Snowflake query by its query ID.\n\nThe query ID is returned by 'formant snowflake load' and can also be found in\nthe Snowflake Query History UI. Queries INFORMATION_SCHEMA.QUERY_HISTORY_BY_ID.\n\nCredentials are read from environment variables:\n SNOWFLAKE_ACCOUNT e.g. myorg-myaccount.snowflakecomputing.com\n SNOWFLAKE_USER username\n SNOWFLAKE_PASSWORD password", "examples": [ "<%= config.bin %> snowflake status 01b234cd-0000-abcd-0001-000000000001", "<%= config.bin %> snowflake status 01b234cd-0000-abcd-0001-000000000001 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "hidden": true, "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "hidden": true, "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "verbose": { "description": "Print each SQL statement before executing", "name": "verbose", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "snowflake:status", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get status of a Snowflake query by ID", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "snowflake", "status.js" ] }, "stream:create": { "aliases": [], "args": {}, "description": "Create a new stream.\n\nReads JSON from stdin or --file. Pipe output from 'stream get --json' to clone a stream.", "examples": [ "<%= config.bin %> stream create --file stream.json", "<%= config.bin %> stream get --json | <%= config.bin %> stream create", "<%= config.bin %> stream list --json | <%= config.bin %> stream create" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "stream:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a stream", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "stream", "create.js" ] }, "stream:delete": { "aliases": [], "args": { "id": { "description": "Stream ID (UUID)", "name": "id", "required": true } }, "description": "Delete a stream by ID.", "examples": [ "<%= config.bin %> stream delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "stream:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete a stream", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "stream", "delete.js" ] }, "stream:get": { "aliases": [], "args": { "id": { "description": "Stream ID (UUID)", "name": "id", "required": true } }, "description": "Get detailed information about a stream.", "examples": [ "<%= config.bin %> stream get ", "<%= config.bin %> stream get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "stream:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get stream details", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "stream", "get.js" ] }, "stream:list": { "aliases": [], "args": {}, "description": "List all streams in your organization.", "examples": [ "<%= config.bin %> stream list", "<%= config.bin %> stream list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "stream:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List streams", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "stream", "list.js" ] }, "stream:update": { "aliases": [], "args": { "id": { "description": "Stream ID (UUID)", "name": "id", "required": true } }, "description": "Update an existing stream.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> stream update --file changes.json", "echo '{\"name\":\"new-name\"}' | <%= config.bin %> stream update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "stream:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a stream", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "stream", "update.js" ] }, "suggestion:count": { "aliases": [], "args": {}, "description": "Count pending suggestions.", "examples": [ "<%= config.bin %> suggestion count", "<%= config.bin %> suggestion count --taskflow-id --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "taskflow-id": { "description": "Optional taskflow ID to limit the count to one taskflow", "name": "taskflow-id", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "suggestion:count", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Count pending suggestions", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "suggestion", "count.js" ] }, "suggestion:delete": { "aliases": [], "args": { "id": { "description": "Suggestion ID (UUID)", "name": "id", "required": true } }, "description": "Delete a suggestion by ID.", "examples": [ "<%= config.bin %> suggestion delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "suggestion:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete a suggestion", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "suggestion", "delete.js" ] }, "suggestion:generate-from-version": { "aliases": [], "args": { "id": { "description": "Taskflow ID (UUID)", "name": "id", "required": true } }, "description": "Generate suggestions for a specific taskflow version.", "examples": [ "<%= config.bin %> suggestion generate-from-version --version 3", "<%= config.bin %> suggestion generate-from-version --version 3 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "version": { "char": "v", "description": "Taskflow version number to analyze", "name": "version", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "suggestion:generate-from-version", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Generate suggestions from a taskflow version", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "suggestion", "generate-from-version.js" ] }, "suggestion:generate": { "aliases": [], "args": { "id": { "description": "Taskflow ID (UUID)", "name": "id", "required": true } }, "description": "Generate AI suggestions for a taskflow.", "examples": [ "<%= config.bin %> suggestion generate ", "<%= config.bin %> suggestion generate --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "suggestion:generate", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Generate suggestions for a taskflow", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "suggestion", "generate.js" ] }, "suggestion:list": { "aliases": [], "args": { "id": { "description": "Taskflow ID (UUID)", "name": "id", "required": true } }, "description": "List generated suggestions for a taskflow.", "examples": [ "<%= config.bin %> suggestion list ", "<%= config.bin %> suggestion list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "suggestion:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List suggestions for a taskflow", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "suggestion", "list.js" ] }, "suggestion:status-update": { "aliases": [], "args": { "id": { "description": "Suggestion item ID (UUID)", "name": "id", "required": true } }, "description": "Update the status of a suggestion item.", "examples": [ "<%= config.bin %> suggestion status-update --status approved", "<%= config.bin %> suggestion status-update --status rejected --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "status": { "description": "New status for the suggestion item", "name": "status", "required": true, "hasDynamicHelp": false, "multiple": false, "options": [ "pending", "approved", "rejected" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "suggestion:status-update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a suggestion item status", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "suggestion", "status-update.js" ] }, "tag-template:create": { "aliases": [], "args": {}, "description": "Create a new tag template.\n\nReads JSON from stdin or --file. Pipe output from 'tag-template get --json' to clone a tag template.", "examples": [ "<%= config.bin %> tag-template create --file tag-template.json", "<%= config.bin %> tag-template get --json | <%= config.bin %> tag-template create", "<%= config.bin %> tag-template list --json | <%= config.bin %> tag-template create" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "tag-template:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a tag template", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "tag-template", "create.js" ] }, "tag-template:delete": { "aliases": [], "args": { "id": { "description": "Tag template ID (UUID)", "name": "id", "required": true } }, "description": "Delete a tag template by ID.", "examples": [ "<%= config.bin %> tag-template delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "tag-template:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete a tag template", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "tag-template", "delete.js" ] }, "tag-template:get": { "aliases": [], "args": { "id": { "description": "Tag template ID (UUID)", "name": "id", "required": true } }, "description": "Get detailed information about a tag template.", "examples": [ "<%= config.bin %> tag-template get ", "<%= config.bin %> tag-template get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "tag-template:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get tag template details", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "tag-template", "get.js" ] }, "tag-template:list": { "aliases": [], "args": {}, "description": "List all tag templates in your organization.", "examples": [ "<%= config.bin %> tag-template list", "<%= config.bin %> tag-template list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "tag-template:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List tag templates", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "tag-template", "list.js" ] }, "tag-template:update": { "aliases": [], "args": { "id": { "description": "Tag template ID (UUID)", "name": "id", "required": true } }, "description": "Update an existing tag template.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> tag-template update --file changes.json", "echo '{\"name\":\"new-name\"}' | <%= config.bin %> tag-template update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "tag-template:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a tag template", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "tag-template", "update.js" ] }, "task-summary:batch-create": { "aliases": [], "args": {}, "description": "Create multiple task summary events in one request.\n\nReads JSON from stdin or --file. You can pass either an array of task summaries or an object with an items array.", "examples": [ "<%= config.bin %> task-summary batch-create --file task-summary-batch.json", "<%= config.bin %> task-summary batch-create --file task-summaries.json --ignore-duplicates --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" }, "ignore-duplicates": { "description": "Ignore duplicate task summaries instead of failing the batch", "name": "ignore-duplicates", "allowNo": false, "type": "boolean" }, "without-device-tags": { "description": "Skip merging device tags onto inserted task summaries", "name": "without-device-tags", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "task-summary:batch-create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Batch create task summaries", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "task-summary", "batch-create.js" ] }, "task-summary:create": { "aliases": [], "args": {}, "description": "Create one or more task summary events.\n\nReads JSON from stdin or --file.", "examples": [ "<%= config.bin %> task-summary create --file task-summary.json", "<%= config.bin %> task-summary create --file task-summaries.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "task-summary:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a task summary", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "task-summary", "create.js" ] }, "task-summary:delete": { "aliases": [], "args": { "id": { "description": "Task summary ID", "name": "id", "required": true } }, "description": "Delete a task summary by ID.", "examples": [ "<%= config.bin %> task-summary delete ", "<%= config.bin %> task-summary delete --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "task-summary:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete a task summary", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "task-summary", "delete.js" ] }, "task:delete": { "aliases": [], "args": { "id": { "description": "Task ID", "name": "id", "required": true } }, "description": "Delete a task by ID.", "examples": [ "<%= config.bin %> task delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "task:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete task", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "task", "delete.js" ] }, "task:get": { "aliases": [], "args": { "id": { "description": "Task ID", "name": "id", "required": true } }, "description": "Get a task by ID.", "examples": [ "<%= config.bin %> task get ", "<%= config.bin %> task get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "task:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get task", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "task", "get.js" ] }, "task:list": { "aliases": [], "args": {}, "description": "List tasks.", "examples": [ "<%= config.bin %> task list", "<%= config.bin %> task list --limit 50 --offset 0", "<%= config.bin %> task list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "limit": { "char": "l", "description": "Maximum number of tasks to return", "name": "limit", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "offset": { "char": "o", "description": "Offset for pagination", "name": "offset", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "task:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List tasks", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "task", "list.js" ] }, "task:paginated-list": { "aliases": [], "args": {}, "description": "List tasks using the paginated tasks endpoint.", "examples": [ "<%= config.bin %> task paginated-list", "<%= config.bin %> task paginated-list --limit 50 --offset 0", "<%= config.bin %> task paginated-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "limit": { "char": "l", "description": "Maximum number of tasks to return", "name": "limit", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "offset": { "char": "o", "description": "Offset for pagination", "name": "offset", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "task:paginated-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List tasks (paginated)", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "task", "paginated-list.js" ] }, "task:run-queue": { "aliases": [], "args": { "id": { "description": "Task ID", "name": "id", "required": true } }, "description": "Queue a task for re-run.", "examples": [ "<%= config.bin %> task run-queue ", "<%= config.bin %> task run-queue --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "task:run-queue", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Queue task rerun", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "task", "run-queue.js" ] }, "task:runs-list": { "aliases": [], "args": { "id": { "description": "Task ID", "name": "id", "required": true } }, "description": "List runs for a task.", "examples": [ "<%= config.bin %> task runs-list ", "<%= config.bin %> task runs-list --limit 50 --offset 0", "<%= config.bin %> task runs-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "limit": { "char": "l", "description": "Maximum number of runs to return", "name": "limit", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "offset": { "char": "o", "description": "Offset for pagination", "name": "offset", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "task:runs-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List task runs", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "task", "runs-list.js" ] }, "task:runs-sections-feedback-create": { "aliases": [], "args": { "id": { "description": "Task ID", "name": "id", "required": true }, "resultId": { "description": "Run result ID", "name": "resultId", "required": true }, "sectionId": { "description": "Section ID", "name": "sectionId", "required": true } }, "description": "Create feedback for a task run section.\n\nReads JSON from stdin or --file.", "examples": [ "<%= config.bin %> task runs-sections-feedback-create --file feedback.json", "<%= config.bin %> task runs-sections-feedback-create --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "task:runs-sections-feedback-create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create task run section feedback", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "task", "runs-sections-feedback-create.js" ] }, "task:runs-sections-feedback-update": { "aliases": [], "args": { "id": { "description": "Task ID", "name": "id", "required": true }, "resultId": { "description": "Run result ID", "name": "resultId", "required": true }, "sectionId": { "description": "Section ID", "name": "sectionId", "required": true }, "feedbackId": { "description": "Feedback ID", "name": "feedbackId", "required": true } }, "description": "Update feedback for a task run section.\n\nReads JSON from stdin or --file with fields to update.", "examples": [ "<%= config.bin %> task runs-sections-feedback-update --file feedback.json", "<%= config.bin %> task runs-sections-feedback-update --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "task:runs-sections-feedback-update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update task run section feedback", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "task", "runs-sections-feedback-update.js" ] }, "task:runs-sections-list": { "aliases": [], "args": { "id": { "description": "Task ID", "name": "id", "required": true }, "resultId": { "description": "Run result ID", "name": "resultId", "required": true } }, "description": "List sections for a task run result.", "examples": [ "<%= config.bin %> task runs-sections-list ", "<%= config.bin %> task runs-sections-list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "task:runs-sections-list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List task run sections", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "task", "runs-sections-list.js" ] }, "task:update": { "aliases": [], "args": { "id": { "description": "Task ID", "name": "id", "required": true } }, "description": "Update a task.\n\nReads JSON from stdin or --file with fields to update.", "examples": [ "<%= config.bin %> task update --file task-update.json", "echo '{\"name\":\"Updated task\"}' | <%= config.bin %> task update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "task:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update task", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "task", "update.js" ] }, "task-summary-format:create": { "aliases": [], "args": {}, "description": "Create one or more task summary formats.\n\nReads JSON from stdin or --file.", "examples": [ "<%= config.bin %> task-summary-format create --file task-summary-format.json", "<%= config.bin %> task-summary-format create --file task-summary-formats.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "task-summary-format:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a task summary format", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "task-summary-format", "create.js" ] }, "task-summary-format:list": { "aliases": [], "args": {}, "description": "List task summary formats in your organization.", "examples": [ "<%= config.bin %> task-summary-format list", "<%= config.bin %> task-summary-format list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "task-summary-format:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List task summary formats", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "task-summary-format", "list.js" ] }, "team:create": { "aliases": [], "args": {}, "description": "Create a new team.\n\nReads JSON from stdin or --file. Pipe output from 'team get --json' to clone a team.", "examples": [ "<%= config.bin %> team create --file team.json", "<%= config.bin %> team get --json | <%= config.bin %> team create", "<%= config.bin %> team list --json | <%= config.bin %> team create" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "team:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a team", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "team", "create.js" ] }, "team:delete": { "aliases": [], "args": { "id": { "description": "Team ID (UUID)", "name": "id", "required": true } }, "description": "Delete a team by ID.", "examples": [ "<%= config.bin %> team delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "team:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete a team", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "team", "delete.js" ] }, "team:get": { "aliases": [], "args": { "id": { "description": "Team ID (UUID)", "name": "id", "required": true } }, "description": "Get detailed information about a team.", "examples": [ "<%= config.bin %> team get ", "<%= config.bin %> team get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "team:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get team details", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "team", "get.js" ] }, "team:list": { "aliases": [], "args": {}, "description": "List all teams in your organization.", "examples": [ "<%= config.bin %> team list", "<%= config.bin %> team list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "team:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List teams", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "team", "list.js" ] }, "team:update": { "aliases": [], "args": { "id": { "description": "Team ID (UUID)", "name": "id", "required": true } }, "description": "Update an existing team.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> team update --file changes.json", "echo '{\"name\":\"new-name\"}' | <%= config.bin %> team update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "team:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a team", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "team", "update.js" ] }, "teleop-view:create": { "aliases": [], "args": {}, "description": "Create a new teleop view.\n\nReads JSON from stdin or --file. Pipe output from 'teleop-view get --json' to clone a teleop view.", "examples": [ "<%= config.bin %> teleop-view create --file teleop-view.json", "<%= config.bin %> teleop-view get --json | <%= config.bin %> teleop-view create", "<%= config.bin %> teleop-view list --json | <%= config.bin %> teleop-view create" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "teleop-view:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a teleop view", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "teleop-view", "create.js" ] }, "teleop-view:delete": { "aliases": [], "args": { "id": { "description": "Teleop view ID (UUID)", "name": "id", "required": true } }, "description": "Delete a teleop view by ID.", "examples": [ "<%= config.bin %> teleop-view delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "teleop-view:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete a teleop view", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "teleop-view", "delete.js" ] }, "teleop-view:get": { "aliases": [], "args": { "id": { "description": "Teleop view ID (UUID)", "name": "id", "required": true } }, "description": "Get detailed information about a teleop view.", "examples": [ "<%= config.bin %> teleop-view get ", "<%= config.bin %> teleop-view get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "teleop-view:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get teleop view details", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "teleop-view", "get.js" ] }, "teleop-view:list": { "aliases": [], "args": {}, "description": "List all teleop views in your organization.", "examples": [ "<%= config.bin %> teleop-view list", "<%= config.bin %> teleop-view list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "teleop-view:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List teleop views", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "teleop-view", "list.js" ] }, "teleop-view:update": { "aliases": [], "args": { "id": { "description": "Teleop view ID (UUID)", "name": "id", "required": true } }, "description": "Update an existing teleop view.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> teleop-view update --file changes.json", "echo '{\"name\":\"new-name\"}' | <%= config.bin %> teleop-view update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "teleop-view:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a teleop view", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "teleop-view", "update.js" ] }, "thread:artifacts": { "aliases": [], "args": { "id": { "description": "Thread ID", "name": "id", "required": true } }, "description": "Get artifacts for a thread.", "examples": [ "<%= config.bin %> thread artifacts ", "<%= config.bin %> thread artifacts --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "thread:artifacts", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get thread artifacts", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "thread", "artifacts.js" ] }, "thread:delete": { "aliases": [], "args": { "id": { "description": "Thread ID", "name": "id", "required": true } }, "description": "Delete a thread.", "examples": [ "<%= config.bin %> thread delete ", "<%= config.bin %> thread delete --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "thread:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete thread", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "thread", "delete.js" ] }, "thread:instructions": { "aliases": [], "args": { "id": { "description": "Thread ID", "name": "id", "required": true } }, "description": "Get instructions for a thread.", "examples": [ "<%= config.bin %> thread instructions ", "<%= config.bin %> thread instructions --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "thread:instructions", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get thread instructions", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "thread", "instructions.js" ] }, "thread:list": { "aliases": [], "args": {}, "description": "List threads.", "examples": [ "<%= config.bin %> thread list", "<%= config.bin %> thread list --limit 50 --offset 0", "<%= config.bin %> thread list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "limit": { "char": "l", "description": "Maximum number of threads to return", "name": "limit", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "offset": { "char": "o", "description": "Offset for pagination", "name": "offset", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "thread:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List threads", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "thread", "list.js" ] }, "thread:logs": { "aliases": [], "args": { "id": { "description": "Thread ID", "name": "id", "required": true } }, "description": "Get logs for a thread.", "examples": [ "<%= config.bin %> thread logs ", "<%= config.bin %> thread logs --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "thread:logs", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get thread logs", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "thread", "logs.js" ] }, "thread:messages-create": { "aliases": [], "args": { "id": { "description": "Thread ID", "name": "id", "required": true } }, "description": "Create a message in a thread.\n\nProvide either:\n- --content (optional --role), or\n- JSON via stdin/--file.", "examples": [ "<%= config.bin %> thread messages-create --content \"hello\"", "<%= config.bin %> thread messages-create --content \"hello\" --role user", "<%= config.bin %> thread messages-create --file message.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "content": { "char": "c", "description": "Message content", "name": "content", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "file": { "char": "f", "description": "Path to JSON body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "role": { "description": "Message role (used with --content)", "name": "role", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "thread:messages-create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create thread message", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "thread", "messages-create.js" ] }, "user:get": { "aliases": [], "args": { "id": { "description": "User ID (UUID)", "name": "id", "required": true } }, "description": "Get detailed information about a user.\n\nShows user details including email, name, roles, and account settings.", "examples": [ "<%= config.bin %> user get ", "<%= config.bin %> user get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "user:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get user details", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "user", "get.js" ] }, "user:list": { "aliases": [], "args": {}, "description": "List all users in your organization.\n\nShows user accounts, their email addresses, and account status.", "examples": [ "<%= config.bin %> user list", "<%= config.bin %> user list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "user:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List users", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "user", "list.js" ] }, "value:create": { "aliases": [], "args": {}, "description": "Create one or more organization values.\n\nReads JSON from stdin or --file.", "examples": [ "<%= config.bin %> value create --file value.json", "<%= config.bin %> value create --file values.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "value:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a value", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "value", "create.js" ] }, "value:delete": { "aliases": [], "args": { "id": { "description": "Value ID", "name": "id", "required": true } }, "description": "Delete an organization value by ID.", "examples": [ "<%= config.bin %> value delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "value:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete a value", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "value", "delete.js" ] }, "value:get": { "aliases": [], "args": { "id": { "description": "Value ID", "name": "id", "required": true } }, "description": "Get an organization value by ID.", "examples": [ "<%= config.bin %> value get ", "<%= config.bin %> value get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "value:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get a value", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "value", "get.js" ] }, "value:list": { "aliases": [], "args": {}, "description": "List organization values.", "examples": [ "<%= config.bin %> value list", "<%= config.bin %> value list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "value:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List values", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "value", "list.js" ] }, "value:update": { "aliases": [], "args": { "id": { "description": "Value ID", "name": "id", "required": true } }, "description": "Update an organization value.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> value update --file changes.json", "echo '{\"description\":\"Updated value\"}' | <%= config.bin %> value update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "value:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a value", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "value", "update.js" ] }, "view:create": { "aliases": [], "args": {}, "description": "Create a new view.\n\nReads JSON from stdin or --file. Pipe output from 'view get --json' to clone a view.", "examples": [ "<%= config.bin %> view create --file view.json", "<%= config.bin %> view get --json | <%= config.bin %> view create", "<%= config.bin %> view list --json | <%= config.bin %> view create" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "view:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create a view", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "view", "create.js" ] }, "view:delete": { "aliases": [], "args": { "id": { "description": "View ID (UUID)", "name": "id", "required": true } }, "description": "Delete a view by ID.", "examples": [ "<%= config.bin %> view delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "view:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete a view", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "view", "delete.js" ] }, "view:get": { "aliases": [], "args": { "id": { "description": "View ID (UUID)", "name": "id", "required": true } }, "description": "Get detailed information about a view.", "examples": [ "<%= config.bin %> view get ", "<%= config.bin %> view get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "view:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get view details", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "view", "get.js" ] }, "view:list": { "aliases": [], "args": {}, "description": "List all views in your organization.", "examples": [ "<%= config.bin %> view list", "<%= config.bin %> view list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "view:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List views", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "view", "list.js" ] }, "view:migrate": { "aliases": [], "args": { "viewId": { "description": "ID of the v1 view to migrate", "name": "viewId", "required": true } }, "description": "Convert v1 (observe/analytics) views into v2 coherence dashboard views.\n\nBuilds a \" - Coherence\" dashboard view with equivalent modules: module\npositions are scaled from v1's 12-column grid to coherence's 36-column grid,\nmodules are titled with the org-level stream alias, numeric-set modules render\nas small multiples, and module selection mirrors what the v1 observe view\ndisplays. Custom visualization modules and file/transform-tree streams are\nnot migrated; 3D scene modules migrate unconfigured.\n\nUse --dry-run to preview the modules that would be created without writing\nanything.", "examples": [ "<%= config.bin %> view migrate 3f8f2f66-1234-4c1b-9d70-aaaaaaaaaaaa --device 8a3b0f12-5678-4d1c-8e90-bbbbbbbbbbbb --dry-run", "<%= config.bin %> view migrate 3f8f2f66-1234-4c1b-9d70-aaaaaaaaaaaa --device 8a3b0f12-5678-4d1c-8e90-bbbbbbbbbbbb" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "device": { "description": "Device to snapshot the view for; v1 views compute their module list per device, so omit this only for views with their own filter", "name": "device", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dry-run": { "description": "Build the migrated view and report modules without creating anything", "name": "dry-run", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "view:migrate", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Migrate v1 views to v2 coherence views", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "view", "migrate.js" ] }, "view:reorder": { "aliases": [], "args": {}, "description": "Reorder views in your organization.\n\nReads JSON from stdin or --file. Accepts:\n- Array of view IDs: [\"id-1\", \"id-2\", ...]\n- Array of objects: [{\"id\":\"id-1\",\"index\":0}, ...]\n- Wrapped object: {\"items\":[...]} (matching API shape)\n\nIf index is omitted, command uses the array order (0..n-1).", "examples": [ "echo '[\"\",\"\"]' | <%= config.bin %> view reorder", "echo '{\"items\":[{\"id\":\"\",\"index\":0},{\"id\":\"\",\"index\":1}]}' | <%= config.bin %> view reorder", "<%= config.bin %> view list --json | jq 'map(.id)' | <%= config.bin %> view reorder" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "view:reorder", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Reorder views", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "view", "reorder.js" ] }, "view:update": { "aliases": [], "args": { "id": { "description": "View ID (UUID)", "name": "id", "required": true } }, "description": "Update an existing view.\n\nReads JSON from stdin or --file with the fields to update.", "examples": [ "<%= config.bin %> view update --file changes.json", "echo '{\"name\":\"new-name\"}' | <%= config.bin %> view update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "exclusive": [ "stdin" ], "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stdin": { "description": "Read JSON from stdin", "exclusive": [ "file" ], "name": "stdin", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "view:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a view", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "view", "update.js" ] }, "gateway:ai-integrations:create": { "aliases": [], "args": {}, "description": "Create an AI integration.\n\nReads JSON request body from stdin or --file.", "examples": [ "<%= config.bin %> gateway ai-integrations create --file ai-integration.json", "<%= config.bin %> gateway ai-integrations create --file ai-integration.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON AI integration body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "gateway:ai-integrations:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create an AI integration", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "gateway", "ai-integrations", "create.js" ] }, "gateway:ai-integrations:delete": { "aliases": [], "args": { "id": { "description": "AI integration ID", "name": "id", "required": true } }, "description": "Delete an AI integration by ID.", "examples": [ "<%= config.bin %> gateway ai-integrations delete ", "<%= config.bin %> gateway ai-integrations delete --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "gateway:ai-integrations:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete an AI integration", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "gateway", "ai-integrations", "delete.js" ] }, "gateway:ai-integrations:get": { "aliases": [], "args": { "id": { "description": "AI integration ID", "name": "id", "required": true } }, "description": "Get an AI integration by ID.", "examples": [ "<%= config.bin %> gateway ai-integrations get ", "<%= config.bin %> gateway ai-integrations get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "gateway:ai-integrations:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get an AI integration", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "gateway", "ai-integrations", "get.js" ] }, "gateway:ai-integrations:list": { "aliases": [], "args": {}, "description": "List AI integrations.", "examples": [ "<%= config.bin %> gateway ai-integrations list", "<%= config.bin %> gateway ai-integrations list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "gateway:ai-integrations:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List AI integrations", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "gateway", "ai-integrations", "list.js" ] }, "gateway:ai-integrations:update": { "aliases": [], "args": { "id": { "description": "AI integration ID", "name": "id", "required": true } }, "description": "Update an AI integration.\n\nReads JSON request body from stdin or --file.", "examples": [ "<%= config.bin %> gateway ai-integrations update --file ai-integration-update.json", "<%= config.bin %> gateway ai-integrations update --file ai-integration-update.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON AI integration body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "gateway:ai-integrations:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update an AI integration", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "gateway", "ai-integrations", "update.js" ] }, "investigation:ai-models:get": { "aliases": [], "args": { "name": { "description": "AI model name", "name": "name", "required": true } }, "description": "Get details for a specific AI model.", "examples": [ "<%= config.bin %> investigation ai-models get ", "<%= config.bin %> investigation ai-models get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:ai-models:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get AI model details", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "ai-models", "get.js" ] }, "investigation:ai-models:list": { "aliases": [], "args": {}, "description": "List AI models available in your organization (built-in and custom).", "examples": [ "<%= config.bin %> investigation ai-models list", "<%= config.bin %> investigation ai-models list --custom true", "<%= config.bin %> investigation ai-models list --enabled true --provider anthropic", "<%= config.bin %> investigation ai-models list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "custom": { "description": "Filter by custom model state", "name": "custom", "hasDynamicHelp": false, "multiple": false, "options": [ "true", "false" ], "type": "option" }, "enabled": { "description": "Filter by enabled state", "name": "enabled", "hasDynamicHelp": false, "multiple": false, "options": [ "true", "false" ], "type": "option" }, "provider": { "description": "Filter by provider (for example: bedrock, anthropic)", "name": "provider", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:ai-models:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List AI models", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "ai-models", "list.js" ] }, "investigation:feedback-forms:create": { "aliases": [], "args": {}, "description": "Create one or more feedback forms.\n\nReads JSON from stdin or --file. Accepts either one object or an array.", "examples": [ "<%= config.bin %> investigation feedback-forms create --file feedback-form.json", "<%= config.bin %> investigation feedback-forms create --file feedback-forms.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:feedback-forms:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create feedback forms", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "feedback-forms", "create.js" ] }, "investigation:feedback-forms:delete": { "aliases": [], "args": { "formId": { "description": "Feedback form ID (UUID)", "name": "formId", "required": true } }, "description": "Delete a feedback form by ID.", "examples": [ "<%= config.bin %> investigation feedback-forms delete " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:feedback-forms:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete a feedback form", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "feedback-forms", "delete.js" ] }, "investigation:feedback-forms:get": { "aliases": [], "args": { "formId": { "description": "Feedback form ID (UUID)", "name": "formId", "required": true } }, "description": "Get details for a feedback form.", "examples": [ "<%= config.bin %> investigation feedback-forms get ", "<%= config.bin %> investigation feedback-forms get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:feedback-forms:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get feedback form details", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "feedback-forms", "get.js" ] }, "investigation:feedback-forms": { "aliases": [], "args": { "id": { "description": "Runtime investigation ID", "name": "id", "required": true } }, "description": "List feedback forms associated with a runtime investigation.", "examples": [ "<%= config.bin %> investigation feedback-forms ", "<%= config.bin %> investigation feedback-forms --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:feedback-forms", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List investigation feedback forms", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "feedback-forms", "index.js" ] }, "investigation:feedback-forms:list": { "aliases": [], "args": {}, "description": "List feedback forms in your organization.", "examples": [ "<%= config.bin %> investigation feedback-forms list", "<%= config.bin %> investigation feedback-forms list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:feedback-forms:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List feedback forms", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "feedback-forms", "list.js" ] }, "investigation:feedback-forms:update": { "aliases": [], "args": { "formId": { "description": "Feedback form ID (UUID)", "name": "formId", "required": true } }, "description": "Update a feedback form.\n\nReads JSON from stdin or --file with fields to update.", "examples": [ "<%= config.bin %> investigation feedback-forms update --file feedback-form-update.json", "echo '{\"name\":\"Updated form\"}' | <%= config.bin %> investigation feedback-forms update " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:feedback-forms:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update a feedback form", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "feedback-forms", "update.js" ] }, "investigation:model-providers:get": { "aliases": [], "args": { "provider": { "description": "Model provider name", "name": "provider", "required": true } }, "description": "Get details for a specific configured model provider.", "examples": [ "<%= config.bin %> investigation model-providers get ", "<%= config.bin %> investigation model-providers get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:model-providers:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get model provider details", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "model-providers", "get.js" ] }, "investigation:model-providers:list": { "aliases": [], "args": {}, "description": "List configured model providers in your organization.", "examples": [ "<%= config.bin %> investigation model-providers list", "<%= config.bin %> investigation model-providers list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "investigation:model-providers:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List model providers", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "investigation", "model-providers", "list.js" ] }, "persona:chat:history": { "aliases": [], "args": { "threadId": { "description": "Thread ID (UUID)", "name": "threadId", "required": true } }, "description": "Show message history for a persona chat thread.\n\nFetches thread messages from Theopolis, applies optional filters, and returns the\nmost recent messages in chronological order.", "examples": [ "<%= config.bin %> persona chat history ", "<%= config.bin %> persona chat history --type assistant --limit 10", "<%= config.bin %> persona chat history --since 2026-01-01T00:00:00Z --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "limit": { "char": "l", "description": "Maximum number of messages to return (most recent first by time)", "name": "limit", "default": 20, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "since": { "description": "Only include messages at or after this ISO timestamp", "name": "since", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "show-pending": { "description": "Include pending/incomplete assistant messages", "name": "show-pending", "allowNo": false, "type": "boolean" }, "type": { "description": "Filter by message type", "name": "type", "default": "all", "hasDynamicHelp": false, "multiple": false, "options": [ "all", "assistant", "memory", "reasoning_step", "system", "tool_call", "tool_result", "user" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "persona:chat:history", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Show persona chat history", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "persona", "chat", "history.js" ] }, "persona:chat:poll": { "aliases": [], "args": { "threadId": { "description": "Thread ID (UUID)", "name": "threadId", "required": true } }, "description": "Poll for persona chat messages on a thread.\n\nBy default this returns current messages that match the requested type. With --wait,\nit keeps polling until at least one matching message arrives or timeout is reached.", "examples": [ "<%= config.bin %> persona chat poll ", "<%= config.bin %> persona chat poll --after 2026-01-01T00:00:00Z --wait", "<%= config.bin %> persona chat poll --type assistant --timeout 120 --interval 2 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "after": { "description": "Only include messages created at or after this ISO timestamp", "name": "after", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "interval": { "description": "Polling interval in seconds when --wait is enabled", "name": "interval", "default": 2, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit": { "char": "l", "description": "Maximum number of matching messages to return", "name": "limit", "default": 20, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "show-pending": { "description": "Include pending/incomplete messages in results", "name": "show-pending", "allowNo": false, "type": "boolean" }, "timeout": { "description": "Maximum wait time in seconds when --wait is enabled", "name": "timeout", "default": 120, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "type": { "description": "Message type to poll for", "name": "type", "default": "assistant", "hasDynamicHelp": false, "multiple": false, "options": [ "assistant", "memory", "reasoning_step", "system", "tool_call", "tool_result", "user" ], "type": "option" }, "wait": { "description": "Wait until at least one matching message is available", "name": "wait", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "persona:chat:poll", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Poll persona chat responses", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "persona", "chat", "poll.js" ] }, "persona:chat:send": { "aliases": [], "args": { "threadId": { "description": "Thread ID (UUID)", "name": "threadId", "required": true }, "message": { "description": "Message text (optional when using --message or --file)", "name": "message", "required": false } }, "description": "Send a message to a persona chat thread.\n\nUses Theopolis chat socket transport to trigger persona execution. Use default wait mode\nfor synchronous responses, or --async then \"persona chat poll\" for async workflows.", "examples": [ "<%= config.bin %> persona chat send \"Summarize device health for today\"", "<%= config.bin %> persona chat send --file prompt.txt --async", "<%= config.bin %> persona chat send --message \"What should I do next?\" --timeout 120 --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "async": { "description": "Return immediately after message send (use persona chat poll to fetch response)", "name": "async", "allowNo": false, "type": "boolean" }, "file": { "char": "f", "description": "Read message text from file path, or \"-\" for stdin", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "message": { "char": "m", "description": "Message text (alternative to positional arg)", "name": "message", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "model": { "description": "Optional AI model override for this message (e.g. o3, claude-sonnet-4-5)", "name": "model", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "persona": { "description": "Override persona ID for this send (defaults to thread currentPersonaId)", "name": "persona", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "timeout": { "description": "Maximum wait time in seconds in synchronous mode", "name": "timeout", "default": 120, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "persona:chat:send", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Send a message to a persona chat thread", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "persona", "chat", "send.js" ] }, "persona:chat:start": { "aliases": [], "args": { "personaId": { "description": "Persona ID (UUID) for this chat thread", "name": "personaId", "required": true } }, "description": "Start a chat thread bound to a persona.\n\nCreates a new Theopolis thread with a current persona, then returns thread metadata\nyou can use with \"persona chat send\", \"persona chat poll\", and \"persona chat history\".", "examples": [ "<%= config.bin %> persona chat start ", "<%= config.bin %> persona chat start --name \"Ops triage\" --hidden", "<%= config.bin %> persona chat start --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "description": { "char": "d", "description": "Optional thread description", "name": "description", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "hidden": { "description": "Create the thread as hidden", "name": "hidden", "allowNo": false, "type": "boolean" }, "name": { "char": "n", "description": "Optional thread name", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "persona:chat:start", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Start a persona chat thread", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "persona", "chat", "start.js" ] }, "persona:chat:switch-persona": { "aliases": [], "args": { "threadId": { "description": "Thread ID (UUID)", "name": "threadId", "required": true }, "personaId": { "description": "Persona ID (UUID) to set as current thread persona", "name": "personaId", "required": true } }, "description": "Switch the active persona for an existing chat thread.\n\nThis updates thread.currentPersonaId so future \"persona chat send\" turns use the new persona\nunless a persona is explicitly overridden.", "examples": [ "<%= config.bin %> persona chat switch-persona ", "<%= config.bin %> persona chat switch-persona --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "persona:chat:switch-persona", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Switch chat thread persona", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "persona", "chat", "switch-persona.js" ] }, "persona:graph-settings:delete": { "aliases": [], "args": { "id": { "description": "Persona ID", "name": "id", "required": true } }, "description": "Delete graph settings for a persona.", "examples": [ "<%= config.bin %> persona graph-settings delete ", "<%= config.bin %> persona graph-settings delete --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "persona:graph-settings:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete persona graph settings", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "persona", "graph-settings", "delete.js" ] }, "persona:graph-settings:get": { "aliases": [], "args": { "id": { "description": "Persona ID", "name": "id", "required": true } }, "description": "Get graph settings for a persona.", "examples": [ "<%= config.bin %> persona graph-settings get ", "<%= config.bin %> persona graph-settings get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "persona:graph-settings:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get persona graph settings", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "persona", "graph-settings", "get.js" ] }, "persona:graph-settings:upsert": { "aliases": [], "args": { "id": { "description": "Persona ID", "name": "id", "required": true } }, "description": "Create or replace graph settings for a persona.\n\nReads JSON request body from stdin or --file.", "examples": [ "<%= config.bin %> persona graph-settings upsert --file graph-settings.json", "<%= config.bin %> persona graph-settings upsert --file graph-settings.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON graph settings body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "persona:graph-settings:upsert", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Upsert persona graph settings", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "persona", "graph-settings", "upsert.js" ] }, "persona:org:create": { "aliases": [ "persona:create" ], "args": {}, "description": "Create an organization persona.\n\nReads JSON request body from stdin or --file.", "examples": [ "<%= config.bin %> persona org create --file persona.json", "<%= config.bin %> persona org create --file persona.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON persona body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "persona:org:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create an organization persona", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "persona", "org", "create.js" ] }, "persona:org:delete": { "aliases": [], "args": { "id": { "description": "Persona ID", "name": "id", "required": true } }, "description": "Delete an organization persona by ID.", "examples": [ "<%= config.bin %> persona org delete ", "<%= config.bin %> persona org delete --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "persona:org:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete an organization persona", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "persona", "org", "delete.js" ] }, "persona:org:get": { "aliases": [], "args": { "id": { "description": "Persona ID", "name": "id", "required": true } }, "description": "Get an organization persona by ID.", "examples": [ "<%= config.bin %> persona org get ", "<%= config.bin %> persona org get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "persona:org:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get an organization persona", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "persona", "org", "get.js" ] }, "persona:org:query": { "aliases": [], "args": {}, "description": "Query organization personas with paging and filters.\n\nOptionally provide a JSON query body from stdin or --file.", "examples": [ "<%= config.bin %> persona org query", "<%= config.bin %> persona org query --file persona-query.json", "<%= config.bin %> persona org query --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON persona query body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "persona:org:query", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Query organization personas", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "persona", "org", "query.js" ] }, "persona:org:update": { "aliases": [ "persona:update" ], "args": { "id": { "description": "Persona ID", "name": "id", "required": true } }, "description": "Update an organization persona by ID.\n\nReads JSON request body from stdin or --file.", "examples": [ "<%= config.bin %> persona org update --file persona-update.json", "<%= config.bin %> persona org update --file persona-update.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON persona update body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "persona:org:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update an organization persona", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "persona", "org", "update.js" ] }, "query:export-sheet:create": { "aliases": [], "args": {}, "description": "Export stream query results to a sheet.\n\nReads JSON request body from stdin or --file.", "examples": [ "<%= config.bin %> query export-sheet create --file export-sheet-request.json", "<%= config.bin %> query export-sheet create --file export-sheet-request.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON export request body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "query:export-sheet:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create stream-data export sheet", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "query", "export-sheet", "create.js" ] }, "query:last-seen:get": { "aliases": [], "args": { "id": { "description": "Device ID", "name": "id", "required": true } }, "description": "Get last-seen timestamp for an online device.", "examples": [ "<%= config.bin %> query last-seen get ", "<%= config.bin %> query last-seen get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "query:last-seen:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get online device last-seen timestamp", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "query", "last-seen", "get.js" ] }, "role:by-user:get": { "aliases": [], "args": { "id": { "description": "User ID (UUID)", "name": "id", "required": true } }, "description": "Get role details for a specific user ID.", "examples": [ "<%= config.bin %> role by-user get ", "<%= config.bin %> role by-user get --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "role:by-user:get", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Get role by user ID", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "role", "by-user", "get.js" ] }, "signal:references:add": { "aliases": [], "args": { "id": { "description": "Signal ID (UUID)", "name": "id", "required": true } }, "description": "Add references to a signal.\n\nReads JSON from stdin or --file with references to attach.", "examples": [ "<%= config.bin %> signal references add --file references.json", "echo '{\"references\":[{\"type\":\"event\",\"id\":\"evt_123\"}]}' | <%= config.bin %> signal references add ", "<%= config.bin %> signal references add --file references.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON references body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "signal:references:add", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Add signal references", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "signal", "references", "add.js" ] }, "team:users:list": { "aliases": [], "args": { "id": { "description": "Team ID (UUID)", "name": "id", "required": true } }, "description": "List users in a team.", "examples": [ "<%= config.bin %> team users list ", "<%= config.bin %> team users list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "team:users:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List users in a team", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "team", "users", "list.js" ] }, "gateway:ai-integrations:org:create": { "aliases": [], "args": {}, "description": "Create organization AI integration settings.\n\nReads JSON request body from stdin or --file.", "examples": [ "<%= config.bin %> gateway ai-integrations org create --file org-ai-integration.json", "<%= config.bin %> gateway ai-integrations org create --file org-ai-integration.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON organization AI integration body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "gateway:ai-integrations:org:create", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Create organization AI integration settings", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "gateway", "ai-integrations", "org", "create.js" ] }, "gateway:ai-integrations:org:delete": { "aliases": [], "args": { "id": { "description": "AI integration ID", "name": "id", "required": true } }, "description": "Delete organization AI integration settings by ID.", "examples": [ "<%= config.bin %> gateway ai-integrations org delete ", "<%= config.bin %> gateway ai-integrations org delete --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "gateway:ai-integrations:org:delete", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Delete organization AI integration settings", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "gateway", "ai-integrations", "org", "delete.js" ] }, "gateway:ai-integrations:org:disconnect": { "aliases": [], "args": { "id": { "description": "AI integration ID", "name": "id", "required": true } }, "description": "Disconnect organization credentials for an AI integration.", "examples": [ "<%= config.bin %> gateway ai-integrations org disconnect ", "<%= config.bin %> gateway ai-integrations org disconnect --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "gateway:ai-integrations:org:disconnect", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Disconnect organization AI integration credentials", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "gateway", "ai-integrations", "org", "disconnect.js" ] }, "gateway:ai-integrations:org:list": { "aliases": [], "args": {}, "description": "List organization AI integration settings.", "examples": [ "<%= config.bin %> gateway ai-integrations org list", "<%= config.bin %> gateway ai-integrations org list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "gateway:ai-integrations:org:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List organization AI integrations", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "gateway", "ai-integrations", "org", "list.js" ] }, "gateway:ai-integrations:org:update": { "aliases": [], "args": { "id": { "description": "AI integration ID", "name": "id", "required": true } }, "description": "Update organization AI integration settings.\n\nReads JSON request body from stdin or --file.", "examples": [ "<%= config.bin %> gateway ai-integrations org update --file org-ai-integration-update.json", "<%= config.bin %> gateway ai-integrations org update --file org-ai-integration-update.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON organization AI integration body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "gateway:ai-integrations:org:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update organization AI integration settings", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "gateway", "ai-integrations", "org", "update.js" ] }, "gateway:ai-integrations:user:disconnect": { "aliases": [], "args": { "id": { "description": "AI integration ID", "name": "id", "required": true } }, "description": "Disconnect user credentials for an AI integration.", "examples": [ "<%= config.bin %> gateway ai-integrations user disconnect ", "<%= config.bin %> gateway ai-integrations user disconnect --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "gateway:ai-integrations:user:disconnect", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Disconnect user AI integration credentials", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "gateway", "ai-integrations", "user", "disconnect.js" ] }, "gateway:ai-integrations:user:list": { "aliases": [], "args": {}, "description": "List user AI integration settings.", "examples": [ "<%= config.bin %> gateway ai-integrations user list", "<%= config.bin %> gateway ai-integrations user list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "gateway:ai-integrations:user:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List user AI integrations", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "gateway", "ai-integrations", "user", "list.js" ] }, "gateway:ai-integrations:user:update": { "aliases": [], "args": { "id": { "description": "AI integration ID", "name": "id", "required": true } }, "description": "Update user AI integration settings.\n\nReads JSON request body from stdin or --file.", "examples": [ "<%= config.bin %> gateway ai-integrations user update --file user-ai-integration-update.json", "<%= config.bin %> gateway ai-integrations user update --file user-ai-integration-update.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON user AI integration body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "gateway:ai-integrations:user:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update user AI integration settings", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "gateway", "ai-integrations", "user", "update.js" ] }, "persona:user:tools:call": { "aliases": [], "args": { "id": { "description": "Persona ID", "name": "id", "required": true }, "tool": { "description": "Tool name", "name": "tool", "required": true } }, "description": "Call a tool for a user-scoped persona.\n\nOptionally provide call arguments from stdin or --file.", "examples": [ "<%= config.bin %> persona user tools call ", "<%= config.bin %> persona user tools call --file tool-call.json", "<%= config.bin %> persona user tools call --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON tool call body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "persona:user:tools:call", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Call a user persona tool", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "persona", "user", "tools", "call.js" ] }, "gateway:ai-integrations:org:tools:list": { "aliases": [], "args": { "id": { "description": "AI integration ID", "name": "id", "required": true } }, "description": "List tools for an organization AI integration.", "examples": [ "<%= config.bin %> gateway ai-integrations org tools list ", "<%= config.bin %> gateway ai-integrations org tools list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "gateway:ai-integrations:org:tools:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List organization AI integration tools", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "gateway", "ai-integrations", "org", "tools", "list.js" ] }, "gateway:ai-integrations:org:tools:update": { "aliases": [], "args": { "id": { "description": "AI integration ID", "name": "id", "required": true }, "tool": { "description": "Tool name", "name": "tool", "required": true } }, "description": "Update tool settings for an organization AI integration.\n\nReads JSON request body from stdin or --file.", "examples": [ "<%= config.bin %> gateway ai-integrations org tools update --file org-tool-update.json", "<%= config.bin %> gateway ai-integrations org tools update --file org-tool-update.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON organization tool settings body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "gateway:ai-integrations:org:tools:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update organization AI integration tool settings", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "gateway", "ai-integrations", "org", "tools", "update.js" ] }, "gateway:ai-integrations:user:tools:call": { "aliases": [], "args": { "id": { "description": "AI integration ID", "name": "id", "required": true }, "tool": { "description": "Tool name", "name": "tool", "required": true } }, "description": "Call a user AI integration tool.\n\nOptionally provide call arguments from stdin or --file.", "examples": [ "<%= config.bin %> gateway ai-integrations user tools call ", "<%= config.bin %> gateway ai-integrations user tools call --file tool-call.json", "<%= config.bin %> gateway ai-integrations user tools call --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Optional JSON tool call body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "gateway:ai-integrations:user:tools:call", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Call a user AI integration tool", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "gateway", "ai-integrations", "user", "tools", "call.js" ] }, "gateway:ai-integrations:user:tools:list": { "aliases": [], "args": { "id": { "description": "AI integration ID", "name": "id", "required": true } }, "description": "List tools for a user AI integration.", "examples": [ "<%= config.bin %> gateway ai-integrations user tools list ", "<%= config.bin %> gateway ai-integrations user tools list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "gateway:ai-integrations:user:tools:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List user AI integration tools", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "gateway", "ai-integrations", "user", "tools", "list.js" ] }, "gateway:ai-integrations:user:tools:update": { "aliases": [], "args": { "id": { "description": "AI integration ID", "name": "id", "required": true }, "tool": { "description": "Tool name", "name": "tool", "required": true } }, "description": "Update tool settings for a user AI integration.\n\nReads JSON request body from stdin or --file.", "examples": [ "<%= config.bin %> gateway ai-integrations user tools update --file user-tool-update.json", "<%= config.bin %> gateway ai-integrations user tools update --file user-tool-update.json --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "file": { "char": "f", "description": "Path to JSON user tool settings body file (use - for stdin)", "name": "file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "gateway:ai-integrations:user:tools:update", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "Update user AI integration tool settings", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "gateway", "ai-integrations", "user", "tools", "update.js" ] }, "gateway:ai-integrations:user:tools:all:list": { "aliases": [], "args": {}, "description": "List all tools available from user AI integrations.", "examples": [ "<%= config.bin %> gateway ai-integrations user tools all list", "<%= config.bin %> gateway ai-integrations user tools all list --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "dev": { "description": "Target the dev environment", "exclusive": [ "stage" ], "helpGroup": "GLOBAL", "name": "dev", "allowNo": false, "type": "boolean" }, "stage": { "description": "Target the stage environment", "exclusive": [ "dev" ], "helpGroup": "GLOBAL", "name": "stage", "allowNo": false, "type": "boolean" }, "toon": { "description": "Output data in TOON (Token-Oriented Object Notation) format", "exclusive": [ "json" ], "helpGroup": "GLOBAL", "name": "toon", "allowNo": false, "type": "boolean" }, "full": { "description": "For --json/--toon, return full API objects (disable default minimal output projection)", "helpGroup": "GLOBAL", "name": "full", "allowNo": false, "type": "boolean" }, "field": { "description": "For --json/--toon, include additional output field path (repeatable, dot notation)", "helpGroup": "GLOBAL", "name": "field", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "gateway:ai-integrations:user:tools:all:list", "pluginAlias": "@formant/formant-cli", "pluginName": "@formant/formant-cli", "pluginType": "core", "strict": true, "summary": "List all user AI integration tools", "enableJsonFlag": true, "isESM": true, "relativePath": [ "dist", "commands", "gateway", "ai-integrations", "user", "tools", "all", "list.js" ] } }, "version": "1.1.17" }