Skip to main content

Running Tasks with Paral CLI

After defining your tasks in a .paral file, you can execute them using the Paral command-line interface (CLI).

Basic Usage​

Run your Paral file by specifying its path:

paral your-tasks.paral

This will execute all tasks according to their dependencies and order.

Common Run CLI Options​

  • --describe

    • Show the structure and details of the Paral file without executing tasks.

  • -s, --summary

    • Only show a summary of the execution results.

  • -v, --verbose

    • Enable verbose output for detailed execution information.

  • -q, --silent

    • Suppress all output except errors.

  • -n, --dry-run

    • Show what tasks and commands would be executed without running them.

  • -o FILE, --output FILE

    • Write the output to a file instead of the terminal.

  • --timeout SEC

    • Set a timeout (in seconds) for the execution (0 means no timeout).

  • --profile

    • Show execution time profiling.

Examples​

Run a Paral file normally:

paral pipeline.paral

Run with verbose output:

paral --verbose pipeline.paral

Perform a dry-run to see what would execute:

paral --dry-run pipeline.paral

Describe the file structure without execution:

paral --describe pipeline.paral

Using the Paral CLI, you can easily control task execution with flexible options for output, debugging, and performance.