TaskSultan Docs tasksultan.com

Reference

Command line reference

Every TaskSultan command, grouped by area, with its arguments and exit codes.

Commands are a single CLI: npx tsx orchestrator/cli.ts <area> <verb> [args]. With no command, or help, it prints the listing. The Robot has its own entry point, npx tsx robot/cli.ts. Unless a row says otherwise, 0 means success, 1 a refusal or failure and 2 that the invocation could not be read or the work was incomplete.

#Orchestrator and jobs

Command Arguments
run <jobdef.json> [--root <stateRoot>]; enqueue and dispatch one job through the Robot
jobs list [--credential <name>] [--fingerprint <fp>]; filter by credential lineage
jobs show <id> one job in detail
robot register <id> --capabilities web,excel [--hostname h]
robot heartbeat <id> / robot list mark online; show the registry
package ingest --from <flat-or-tspkg-dir> [--from-artifacts <automationId>]
principals add <id> --roles operator,approver [--secret s]; principals list
state gc [--keep-days N]; inspection only

#Vault

vault init creates an empty vault. vault types [--json] prints the asset vocabulary as data. vault set <name> [--type credential|windowsCredential|certificate|text|integer|bool] [--envs dev,staging] <k=v> … upserts an asset. vault set <name> --type credential --secret-stdin [--via <tag>] reads the fields as JSON on stdin. vault list and vault show <name> print names, metadata and a fingerprint, never values. vault encrypt --migrate rewrites a plaintext vault, vault rotate <name> re-seals one item and vault doctor [--strict] checks form, custody and allow-list hygiene.

#Schedules

schedule add <jobdef.json> --cron "*/5 * * * *" [--name n], schedule list, schedule remove <id> and scheduler run [--once] [--poll-ms 30000], which loops due to queue to dispatch.

#Test suites

suite add <suite.json>, suite list, suite show <id>, suite remove <id>. suite run <id> [--only tag,tag] [--headed] [--trigger on-demand|scheduled] [--artifacts d] runs a suite and the exit code is the verdict. suite draft <automation> [--id i] [--labels a,b] [--credentials n] [--out f] drafts a test from a real run. suite runs [--suite <id>] [--limit n] and suite result <suiteRunId> read them back.

#Action Centre

action create --subject <kind:ref> --title <t> --package <p> --version <v> --queue <q> raises an Action. action list [--view my|unassigned|pending|completed] [--mine] [--subject <ref>] [--label l] [--json] shows the views. action show, action data and action history read one Action. action assign <id> [--to <principal>], action unassign <id> and action forward <id> --to <principal> move it. action comment <id> --text "…" and action label <id> --labels a,b set properties. action complete <id> --outcome approve|reject [--reason "why"] [--output <json|@file>] [--no-resume] decides and resumes the work. action resume <id> dispatches the continuation, idempotently. action threshold prints the approval amount.

#Buildout queue

buildout add --queue <q> --kind <chapter|slice|finding|decision|debt|residue> --title "<t>" declares an item. buildout list --queue <q> [--kind k] [--state s] [--format md|json] renders the work list. buildout claim --queue <q> --robot <id> takes the next item atomically, exiting 4 when there is nothing to claim. buildout settle <id> --state done|refused|escalated closes a row. buildout release <id> undoes a claim. buildout render --queue <q> [--out <file>] writes markdown without modifying the queue. buildout seed --input <path> --queue <q> imports a register idempotently.

#UiPath conversion

uipath evaluate <path …> [--json] [--all] reports per-activity feasibility. uipath targets <path …> [--json] [--all] synthesises stored selectors. uipath bind <path> [--url <url>] [--headed] [--credential <name>] binds targets against running pages. uipath emit <path> [--url <url>] [--credential <name>] [--out <dir>] [--install] [--headed] [--json] writes the converted navigation and Target Repository pair. uipath census <path …> [--json] [--all] [--per-file] [--top n] [--packages <path>] counts constructs. uipath ir <path …> [--json] [--all] [--per-file] [--top n] [--packages <path>] [--front-end auto|xaml] models behaviour. `uipath codegen <path …> --out

[--json] [--all] [--packages ] [--front-end auto|xaml]` emits staged code. Every `uipath` verb exits `0` clean, `1` with a refusal or blocker and `2` when a file or the invocation could not be read.

#Generated-target binding

bind <intents.json> --url <url> [--domain <name>] [--json] [--headed] binds declared target intents against a live page and prints the targets/<domain>.targets.ts text. Exit 0 all bound, 1 refusals and 2 the invocation or pass could not run.

#Desktop

desktop inspect dumps the Windows UI Automation tree. desktop bind, desktop record and desktop brief cover the recorder pipeline. desktop inspect never emits a coordinate and exits 1 only when refused.

#Robot and validator

npx tsx robot/cli.ts takes list, run <automationId>, show <automationId> <runId>, package <automationId> [--out <dir>], run-package <pkgDir>, generate <brief.json> and status <automationId> [runId]. Its exit codes are 0 run finished, 2 fatal failure, 3 stopped by the operator, 1 usage. validate-automation <automationId> [--source <path>] checks a source against the platform contract without running it, exiting 0 or 1 with violations.