Skip to main content

Command Reference

Complete reference for all Signaloid CLI commands.

Command Structure​

signaloid-cli <command> <subcommand> [options]

Global Options​

OptionDefaultDescription
--verbosity <n>2Output verbosity level: 0 = no output, 1 = command output and errors, 2 = also progress messages and tips
--jsonMachine-readable JSON output (equivalent to --format json on the commands that have a --format option)
-d, --debugAccepted, but currently produces no additional output
-V, --versionPrint the version number and exit
-h, --helpDisplay help

Examples:

signaloid-cli --version
signaloid-cli repos --help
signaloid-cli tasks list --help

Command Categories​

Authentication​

Manage authentication and view current user.

Builds​

Create and manage builds from source code or repositories.

Completion​

Generate shell tab-completion scripts.

Buckets​

Manage cloud storage bucket configurations.

Cores​

View and manage Signaloid compute cores.

Drives​

Manage virtual drives for data source integration.

Files​

Manage files in Signaloid storage.

GitHub​

Manage GitHub integration with Signaloid.

Health​

Check API connectivity.

  • health - Check API health status

Init​

Generate web application front ends.

Keys​

Manage API keys.

Organizations​

Manage organizations, their members, and pending invitations.

Plotting​

Visualize distributional data.

Repositories​

Manage GitHub repositories connected to Signaloid.

Samples​

Retrieve random samples from task outputs.

Subscriptions​

View your account subscription.

Tasks​

Run and manage computational tasks.

Users​

Manage user account.

Webhooks​

Manage webhook integrations.

Common Workflows​

Quick Build and Run​

# Build from source
signaloid-cli builds create:source --file main.c --lang C

# Run task
signaloid-cli tasks create --build-id <build-id>

# Get output
signaloid-cli tasks output --task-id <task-id>

Repository Workflow​

# Connect repo
signaloid-cli repos connect --url https://github.com/user/repo

# Create build
signaloid-cli builds create:repo --repo-id <repo-id>

# Watch build
signaloid-cli builds watch --build-id <build-id>

# Run task
signaloid-cli tasks create --build-id <build-id>

# Watch task
signaloid-cli tasks watch --task-id <task-id>

# Get results
signaloid-cli tasks output --task-id <task-id>

Exit Codes​

Signaloid CLI uses standard exit codes:

CodeMeaning
0Success. An empty result — no cores, no tasks, no matching files — is a success, not an error.
1General error (request failed, unexpected server response, or no stored credentials because you are not logged in)
2Misuse of command (invalid or conflicting options)
3Authentication failure: the API rejected the stored session or API key, for example because it expired
4The requested resource was not found

Example usage in scripts:

if signaloid-cli tasks watch --task-id $TASK_ID; then
  echo "Task completed successfully"
else
  echo "Task failed"
  exit 1
fi

Getting Help​

Command Help​

Every command has built-in help:

# General help
signaloid-cli --help

# Category help
signaloid-cli repos --help

# Specific command help
signaloid-cli repos connect --help

Example Output​

signaloid-cli repos connect --help

Usage: signaloid-cli repos connect [options]

Connect a repository

Options:
  --url <gitUrl>      Remote Git URL (RemoteURL)
  --commit <sha>      Commit (Commit)
  --branch <name>     Branch (Branch)
  --dir <path>        Build directory (BuildDirectory)
  --args <args>       Default runtime arguments (Arguments)
  --core-id <coreId>     Core ID (Core)
  -h, --help          display help for command

Pagination​

Commands that list items read one page at a time. Each command's page gives its default and largest page size.

# Get the first page
signaloid-cli tasks list

# Get the next page, using the Cursor value of the previous output
signaloid-cli tasks list --cursor <cursor>

# Get 100 tasks, across pages
signaloid-cli tasks list --count 100

# Set the number of items per request
signaloid-cli tasks list --limit 10
  • Without --count, the command fetches one page. The JSON output has the items and their count, Count for most commands, and ends with Cursor when more items are available. Pass Cursor back with --cursor to continue where the output stopped.
  • The listing has ended when the output has no Cursor. Do not stop on a short or empty output, as it can still have one.
  • The cursor is an opaque string: do not parse, build or change it.
  • With --format table, the cursor is not in the table. When more items are available, the command prints More items: --cursor <cursor> on stderr after the table, or --start-key <key> for an older Signaloid Cloud Compute Engine. On the last page, it prints nothing there.
  • To read every item, pass a --count at least as large as the number of items. Pairing it with the largest --limit makes the fewest requests.
  • Pass --cursor with the same filters as the command that printed it, such as --status, --from or --to. Only --limit and --count may change. The Signaloid Cloud Compute Engine refuses a cursor sent with other filters.
  • --start-key and the output's ContinuationKey still work on the lists that had them, but are deprecated. Pass ContinuationKey only as --start-key, and Cursor only as --cursor. The --start option of earlier versions is now --cursor.
  • An older Signaloid Cloud Compute Engine without Pagination does not take --cursor. Rather than show the first page again, the command then stops with an error. Pass the ContinuationKey of the previous output as --start-key instead.
  • If the Signaloid Cloud Compute Engine stops advancing the listing, the command prints the items read so far, with no Cursor, and exits with an error.

Filtering​

Filter options vary by command:

# Filter by status
signaloid-cli tasks list --status Completed

# Filter by date range
signaloid-cli builds list --from 2025-01-01T00:00:00Z --to 2025-01-31T23:59:59Z

# Filter by path
signaloid-cli files ls --path datasets/

Next Steps​

Quick Reference

For quick examples and common patterns, see our Quick Start Guide.

Last updated on