Streaming CLI

Command-line streaming options for agents

Control streaming behaviour when running agents from the command line.

Diagram

User

CLI

Streaming

Control streaming behavior when running agents from the command line.

Quick Start

  1. Simple Usage
    bash
    praisonai-ts chat "Tell me a story" --stream
  2. With Configuration
    bash
    praisonai-ts chat "Tell me a story" --no-stream

Overview

By default, agent responses stream to the terminal in real-time. You can control this behavior with CLI flags.

Commands

Enable Streaming (Default)

bash
praisonai-ts chat "Tell me a story" --stream

Disable Streaming

bash
praisonai-ts chat "Tell me a story" --no-stream

Options

OptionDescriptionDefault
--streamEnable streaming outputtrue
--no-streamDisable streaming, wait for complete responsefalse
--verbose, -vShow streaming output in terminaltrue
--quiet, -qSuppress streaming outputfalse

Examples

Interactive Streaming

bash
# Stream response as it's generated
praisonai-ts chat "Explain quantum computing in detail" --stream

Batch Processing

bash
# Get complete response (better for scripting)
praisonai-ts chat "Summarize this text" --no-stream --json

Silent Mode

bash
# No streaming output, just final result
praisonai-ts chat "Hello" --quiet

Verbose Streaming

bash
# Full streaming with debug info
praisonai-ts chat "Hello" --stream --verbose

Scripting Examples

Capture Streamed Output

bash
#!/bin/bash

# Stream to file
praisonai-ts chat "Write a long story" --stream > story.txt

# Stream and display
praisonai-ts chat "Explain AI" --stream | tee output.txt

JSON Output (No Streaming)

bash
# For API-like usage, disable streaming
RESULT=$(praisonai-ts chat "Hello" --no-stream --json)
echo $RESULT | jq '.data.response'

Pipeline Usage

bash
# Pipe between commands (streaming disabled automatically)
echo "Summarize this" | praisonai-ts chat --stdin --no-stream

Environment Variables

bash
# Default streaming behavior
export PRAISON_STREAM=true

# Default verbose behavior
export PRAISON_VERBOSE=true

Use Cases

Interactive Chat

bash
# Best experience for interactive use
praisonai-ts chat "Let's have a conversation" --stream --verbose

Automation Scripts

bash
# Best for scripts and automation
praisonai-ts chat "Process this data" --no-stream --json

Long-Form Generation

bash
# Stream long content to see progress
praisonai-ts run \
  --instructions "You are a writer" \
  --task "Write a 2000-word essay" \
  --stream

See Also

Related