ShadowBot CLI

Use the real executable help as the source of truth. Do not trust examples, aliases, or old notes unless they have been verified in the current environment.

Executable

• Prefer shadowbot.shell-cli.exe when it resolves on PATH.
• In this environment it resolves to C:\Program Files\ShadowBot\shadowbot.shell-cli.exe.
• If resolution is uncertain, verify first with Get-Command shadowbot.shell-cli.exe.

Hard Rules

1. Execute only commands and flags confirmed by shadowbot.shell-cli.exe -h or <subcommand> -h.
2. Never invent aliases, hidden commands, IDs, account names, or trigger details.
3. Preserve user-provided values exactly, especially usernames, passwords, UUIDs, paths, cron strings, and JSON payloads.
4. Quote Windows paths and JSON carefully in PowerShell.
5. If the CLI returns an error JSON object, surface the error directly instead of guessing recovery steps.
6. If a command is ambiguous, run the nearest -h help page before acting.

Fast Discovery

Start with the smallest help page that answers the question:

shadowbot.shell-cli.exe -h
shadowbot.shell-cli.exe auth -h
shadowbot.shell-cli.exe console task run -h

Top-level command groups confirmed in this environment:

• auth
• mode
• system
• console
• studio
• config
• ui
• assistant as an additional help topic only

The global flags confirmed at root are:

• --timeout <duration>
• -h|--help
• -v|--version

Verified Workflows

Authentication

Use:

shadowbot.shell-cli.exe auth current
shadowbot.shell-cli.exe auth account list
shadowbot.shell-cli.exe auth login --username <name>
shadowbot.shell-cli.exe auth login --username <name> --password <password>

Important rules from help:

• auth login --username is required.
• --password is normally required.
• You may omit --password only when the username appears in auth account list.
• Login polling flags exist: --login-timeout, --poll-interval.

Practical flow:

1. Run auth current.
2. If not logged in, run auth account list.
3. If the requested username is remembered, use auth login --username <name>.
4. Otherwise use auth login --username <name> --password <password>.
5. Re-run auth current.

System And Mode

Use:

shadowbot.shell-cli.exe system health
shadowbot.shell-cli.exe system state
shadowbot.shell-cli.exe system version
shadowbot.shell-cli.exe mode switch --to console
shadowbot.shell-cli.exe mode switch --to assistant
shadowbot.shell-cli.exe mode switch --to console --force

Notes:

• mode switch --to supports only console|assistant.
• --force exists for forced switch to console.
• system state is the safest preflight before UI or studio actions.

UI Operations

Use:

shadowbot.shell-cli.exe ui --exec studio-minmize
shadowbot.shell-cli.exe ui --exec studio-maximize
shadowbot.shell-cli.exe ui --exec console-minimize
shadowbot.shell-cli.exe ui --exec console-maximize
shadowbot.shell-cli.exe ui --exec switch-to-schedule
shadowbot.shell-cli.exe ui --exec switch-to-assistant
shadowbot.shell-cli.exe ui --exec switch-to-console --force

Confirmed --exec values:

• studio-minmize
• studio-maximize
• console-minimize
• console-maximize
• switch-to-schedule
• switch-to-assistant
• switch-to-console

Notes:

• The CLI also exposes --exce as a compatibility alias.
• The help text uses the misspelling studio-minmize; keep it exactly as documented unless runtime evidence shows otherwise.

Config

Discover and modify config through:

shadowbot.shell-cli.exe config list
shadowbot.shell-cli.exe config list --prefix recording
shadowbot.shell-cli.exe config describe --key login.auto-login
shadowbot.shell-cli.exe config get --key login.auto-login
shadowbot.shell-cli.exe config set --key login.auto-login --value true

Use this order:

1. config list or config list --prefix ...
2. config describe --key ...
3. config get --key ...
4. config set --key ... --value ...

The help page lists these current config keys:

• startup.auto-start
• login.auto-login
• login.switch-to-assistant
• login.auto-start-go
• close.direct-close
• quick.mouse-gesture-enabled
• quick.keyboard-shortcut-enabled
• app-run.auto-hide-robot-window
• app-run.shutdown-explorer-after-task-stop
• designer.auto-save
• designer.auto-anchor
• designer.ai-selector-enabled
• recording.enabled
• recording.save-mode
• recording.save-duration-seconds
• recording.ignore-manual-or-hotkey
• recording.auto-clear-file
• recording.max-size-gb
• recording.storage-path
• performance.render-mode

Console: Pages, Theme, Links

Use:

shadowbot.shell-cli.exe console page switch --target app
shadowbot.shell-cli.exe console theme switch --target dark
shadowbot.shell-cli.exe console link open --target community

Confirmed values:

• console page switch --target: app|trigger|market|tutorial|excellence
• console theme switch --target: light|dark|default
• console link open --target: community|comic|web-console|achievement|dev-feedback

Console: Apps

List and inspect apps:

shadowbot.shell-cli.exe console app
shadowbot.shell-cli.exe console app --app-type subscribed --search invoice
shadowbot.shell-cli.exe console app detail --app-id <uuid>
shadowbot.shell-cli.exe console app versions --app-id <uuid>
shadowbot.shell-cli.exe console app publish --app-id <uuid> --update-log "notes"

Useful flags:

• console app: --app-type, --page, --page-size, --search
• console app detail: --app-id, optional --app-type
• console app versions: --app-id, optional --app-type, --page, --page-size
• console app publish: --app-id, optional --update-log

App recycle bin:

shadowbot.shell-cli.exe console app recycle --app-id <uuid>
shadowbot.shell-cli.exe console app recycle list
shadowbot.shell-cli.exe console app recycle delete --app-id <uuid>

App groups:

shadowbot.shell-cli.exe console app group list
shadowbot.shell-cli.exe console app group create --name "Finance"
shadowbot.shell-cli.exe console app group update --id <group-id> --name "Finance"
shadowbot.shell-cli.exe console app group delete --id <group-id>
shadowbot.shell-cli.exe console app group move --app-id <uuid> --group-id <group-id>
shadowbot.shell-cli.exe console app group remove --app-id <uuid>

Collaborators:

shadowbot.shell-cli.exe console app collaborator list --app-id <uuid>
shadowbot.shell-cli.exe console app collaborator org-users list --app-id <uuid> --keyword foo
shadowbot.shell-cli.exe console app collaborator add --app-id <uuid> --account exact@account
shadowbot.shell-cli.exe console app collaborator remove --app-id <uuid> --account exact@account

Important rules:

• Collaborator add/remove requires exact --account; no fuzzy matching.
• org-users list is for discovery only; add still needs the exact account value.

Console: Tasks

Use:

shadowbot.shell-cli.exe console task run --app-id <uuid>
shadowbot.shell-cli.exe console task run --app-id <uuid> --inputs '{"k":"v"}'
shadowbot.shell-cli.exe console task status --task-id <uuid>
shadowbot.shell-cli.exe console task logs --task-id <uuid> --limit 50
shadowbot.shell-cli.exe console task stop --task-id <uuid> --reason "manual stop"
shadowbot.shell-cli.exe console task history --page 1 --page-size 20

Notes:

• console task run defaults to sync mode with streaming logs.
• --async switches to immediate-return mode.
• Sync mode flags: --wait-timeout, --poll-interval, --log-limit.

Recommended flow:

1. Find the app ID with console app --search ....
2. Run console task run --app-id <uuid>.
3. Capture the returned task ID.
4. Use status, logs, or stop against that task ID.

Console: Triggers

Global trigger commands:

shadowbot.shell-cli.exe console trigger list
shadowbot.shell-cli.exe console trigger list --type file
shadowbot.shell-cli.exe console trigger get --id <trigger-id>
shadowbot.shell-cli.exe console trigger enable --id <trigger-id>
shadowbot.shell-cli.exe console trigger disable --id <trigger-id>
shadowbot.shell-cli.exe console trigger delete --id <trigger-id>

Confirmed flags:

• console trigger list --type: all|file|hotkey|email|schedule
• console trigger list --kind: compatibility alias all|event|schedule

Typed trigger commands:

shadowbot.shell-cli.exe console trigger file list
shadowbot.shell-cli.exe console trigger file add --app-id <uuid> --name "Watch Folder" --details-json '{"folderPath":"C:\\\\in","filesToMonitor":"*.*","includeSubFolders":true,"fileEventsToMonitor":"created"}'
shadowbot.shell-cli.exe console trigger file update --id <trigger-id> --details-json '{...}'

shadowbot.shell-cli.exe console trigger hotkey list
shadowbot.shell-cli.exe console trigger hotkey add --app-id <uuid> --name "Run" --details-json '{"modifierKeys":"Ctrl+Alt","virtualKey":"R"}'
shadowbot.shell-cli.exe console trigger hotkey update --id <trigger-id> --details-json '{...}'

shadowbot.shell-cli.exe console trigger email list
shadowbot.shell-cli.exe console trigger email add --app-id <uuid> --name "Mail" --details-json '{...}'
shadowbot.shell-cli.exe console trigger email update --id <trigger-id> --details-json '{...}'

shadowbot.shell-cli.exe console trigger schedule list
shadowbot.shell-cli.exe console trigger schedule add --app-id <uuid> --name "Daily" --cron "0 9 * * *"
shadowbot.shell-cli.exe console trigger schedule update --id <trigger-id> --app-id <uuid> --name "Daily" --cron "0 9 * * *"

Typed trigger flag patterns:

• common add/update flags: --app-id, optional --app-name, --name, --enabled, --queue-when-busy, --timeout
• file trigger --details-json: folderPath/filesToMonitor/includeSubFolders/fileEventsToMonitor
• hotkey trigger --details-json: modifierKeys and virtualKey
• email trigger --details-json: email trigger detail object
• schedule trigger: --cron, optional --end-time

Be careful:

• schedule update currently documents --app-id, --name, and --cron as required.
• For update commands, --enabled, --queue-when-busy, and --timeout are only applied when explicitly set.

Console: Messages

Use:

shadowbot.shell-cli.exe console message list
shadowbot.shell-cli.exe console message list --status unread --size 20
shadowbot.shell-cli.exe console message read --id <uuid>
shadowbot.shell-cli.exe console message read-all

Confirmed --status values:

• all
• unread
• read

Console: Extensions

Use:

shadowbot.shell-cli.exe console extension list
shadowbot.shell-cli.exe console extension get --type chrome
shadowbot.shell-cli.exe console extension install --type edge --wait

Confirmed extension types:

• chrome
• edge
• device
• screen-unlock
• background-wakeup

Install notes:

• --wait polls until installed or timeout.
• Polling flags: --wait-timeout, --poll-interval.
• Business dialogs are silent, but UAC prompts may still require manual confirmation.

Studio

Use:

shadowbot.shell-cli.exe studio create --name "Demo"
shadowbot.shell-cli.exe studio open --name "Demo"
shadowbot.shell-cli.exe studio open-app --app-id <uuid>
shadowbot.shell-cli.exe studio current get
shadowbot.shell-cli.exe studio current update-info --name "Demo" --description "desc"
shadowbot.shell-cli.exe studio current save
shadowbot.shell-cli.exe studio current sync

Notes:

• studio create creates then sync-closes.
• studio open creates and keeps studio open.
• studio open-app expects no studio already open.
• studio current update-info --name is required.
• Advanced options on update-info: --remember-databook true|false, --allow-view-source true|false, --clear-description, --clear-instruction.

Known Non-Commands

Do not use these unless future runtime verification proves otherwise:

• shadowbot.shell-cli.exe login
• shadowbot.shell-cli.exe apps
• shadowbot.shell-cli.exe messages

In this environment they return unknown command.

Response Style

• Report the exact command you ran.
• Summarize only the key result.
• If the CLI returns machine-readable error JSON, include the critical fields directly.
• When acting on mutable resources, mention the specific ID or account used.