Send push notifications and trigger live activities with ActivitySmith CLI

Use the ActivitySmith CLI when you want shell-native commands for push notifications and live activity lifecycle control.

Install

npm i -g activitysmith-cli

Push Notifications

Send an immediate notification for a completed task or event:

activitysmith push \
  --title "New subscription 💸" \
  --message "Customer upgraded to Pro plan"

Live Activities

Live Activities come in two UI types, but the lifecycle stays the same: start the activity, keep the returned activity_id, update it as state changes, then end it when the work is done. You can use --content-state <json> for the examples below, or build the same payload with flags.

segmented_progress: best for jobs tracked in steps
progress: best for jobs tracked as a percentage or numeric range

Shared flow

Call activitysmith activity start ....
Save the returned activity_id.
Call activitysmith activity update ... as progress changes.
Call activitysmith activity end ... when the work is finished.

Segmented Progress Type

Use segmented_progress when progress is easier to follow as steps instead of a raw percentage. It fits jobs like backups, deployments, ETL pipelines, and checklists where "step 2 of 3" is more useful than "67%". number_of_steps is dynamic, so you can increase or decrease it later if the workflow changes.

Start

activitysmith activity start \
  --content-state '{
    "title": "Nightly database backup",
    "subtitle": "create snapshot",
    "numberOfSteps": 3,
    "currentStep": 1,
    "type": "segmented_progress",
    "color": "yellow"
  }' \
  --channels "devs,ops"

Update

activitysmith activity update \
  --activity-id "<activityId>" \
  --content-state '{
    "title": "Nightly database backup",
    "subtitle": "upload archive",
    "currentStep": 2
  }'

End

activitysmith activity end \
  --activity-id "<activityId>" \
  --content-state '{
    "title": "Nightly database backup",
    "subtitle": "verify restore",
    "currentStep": 3,
    "autoDismissMinutes": 2
  }'

Progress Type

Use progress when the state is naturally continuous. It fits charging, downloads, sync jobs, uploads, timers, and any flow where a percentage or numeric range is the clearest signal.

Start

activitysmith activity start \
  --content-state '{
    "title": "EV Charging",
    "subtitle": "Added 30 mi range",
    "percentage": 15,
    "type": "progress",
    "color": "lime"
  }'

Update

activitysmith activity update \
  --activity-id "<activityId>" \
  --content-state '{
    "title": "EV Charging",
    "subtitle": "Added 120 mi range",
    "percentage": 60
  }'

End

activitysmith activity end \
  --activity-id "<activityId>" \
  --content-state '{
    "title": "EV Charging",
    "subtitle": "Added 200 mi range",
    "percentage": 100,
    "autoDismissMinutes": 2
  }'