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 = silent, 1 = errors only, 2 = full
--jsonMachine-readable JSON output (equivalent to --format json on all commands)
-d, --debugOutput extra debugging information
-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 available 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.

  • init web-app - Produce a new Signaloid web application template

Keys​

Manage API keys.

Organizations​

Manage organizations, their members, and pending invitations.

Plotting​

Visualize uncertainty data.

Repositories​

Manage GitHub repositories connected to Signaloid.

Samples​

Retrieve random samples from task outputs.

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
1General error
2Misuse of command (invalid options)

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 return lists support pagination:

# Get first page
signaloid-cli tasks list

# Get next page
signaloid-cli tasks list --start-key <cursor>

# Limit results
signaloid-cli tasks list --count 10

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