Skip to main content

​
Quick Start

1

Simple Usage

praisonai-ts background run my-recipe
2

With Configuration

praisonai-ts background run my-recipe --timeout 600
Background task CLI (TypeScript) Manage background tasks using the praisonai-ts CLI.

​
Installation

npm install -g praisonai-ts

​
Commands Overview

CommandDescription
praisonai-ts background listList all background tasks
praisonai-ts background status <id>Get task status
praisonai-ts background cancel <id>Cancel a running task
praisonai-ts background clearClear completed tasks
praisonai-ts background submitSubmit a recipe as background task

​
Submit a Recipe

# Basic submission
praisonai-ts background submit --recipe my-recipe

# With input data
praisonai-ts background submit --recipe my-recipe --input '{"query": "test"}'

# With config overrides
praisonai-ts background submit --recipe my-recipe --config '{"maxTokens": 1000}'

# With session ID
praisonai-ts background submit --recipe my-recipe --session-id session_123

# With timeout
praisonai-ts background submit --recipe my-recipe --timeout 600

# JSON output
praisonai-ts background submit --recipe my-recipe --json

​
Submit Options

OptionDescription
--recipeRecipe name to execute (required)
--input, -iInput data as JSON string
--config, -cConfig overrides as JSON string
--session-id, -sSession ID for conversation continuity
--timeoutTimeout in seconds (default: 300)
--jsonOutput JSON for scripting

​
List Tasks

# List all tasks
praisonai-ts background list

# Filter by status
praisonai-ts background list --status running

# JSON output
praisonai-ts background list --json

​
Check Status

# Get status
praisonai-ts background status task_abc123

# JSON output
praisonai-ts background status task_abc123 --json

​
Cancel Task

# Cancel task
praisonai-ts background cancel task_abc123

​
Clear Completed

# Clear completed tasks
praisonai-ts background clear

# Clear all tasks
praisonai-ts background clear --all

​
Examples

​
Complete Workflow

# 1. Submit a recipe
praisonai-ts background submit --recipe news-monitor --json

# 2. Check status
praisonai-ts background status task_abc123

# 3. List all tasks
praisonai-ts background list

# 4. Clear completed
praisonai-ts background clear

​
Scripting with JSON

#!/bin/bash

# Submit and capture task ID
RESULT=$(praisonai-ts background submit --recipe my-recipe --json)
TASK_ID=$(echo $RESULT | jq -r '.taskId')

echo "Submitted task: $TASK_ID"

# Poll for completion
while true; do
    STATUS=$(praisonai-ts background status $TASK_ID --json | jq -r '.status')
    if [ "$STATUS" = "completed" ] || [ "$STATUS" = "failed" ]; then
        break
    fi
    sleep 5
done

echo "Task finished: $STATUS"

Background Tasks

SDK documentation

Async Jobs CLI

Async jobs CLI

Agent

Single agent API