Banner

Display announcements and notices to your users

Display important messages to all your users at the top of the app. Perfect for announcements, maintenance notices, or updates.

Quick Overview

  • Only one banner can be active at a time
  • Schedule banners to appear and disappear automatically
  • Choose whether users can dismiss the banner or not
  • Show banners to everyone, or only logged-in users

Creating a Banner

There are two ways to create or update a banner — use whichever you prefer:

  • intelliask binary — manage the banner from the host, no need to shell into the container.
  • npm run update-banner — the app's built-in script, run inside the IntelliAsk container.

Both drive the same underlying banner, so you can mix and match.

Set a banner in one line from the host:

intelliask banner set -m "🎉 Welcome to IntelliAsk! Check out our new features."

Common flags:

FlagPurpose
-m, --message <text>Banner text (required for non-interactive use).
--from <ts>Show from — format yyyy-mm-ddTHH:MM:SSZ (default: now).
--to <ts>Show until — format yyyy-mm-ddTHH:MM:SSZ (default: no end).
--publicAlso show to logged-out visitors (e.g. the login page).
--persistableUsers cannot dismiss the banner — use for important notices.

Check or remove the current banner:

intelliask banner show      # print the active banner
intelliask banner clear     # remove it (asks to confirm; --yes to skip)

Run set with no flags to be walked through the same guided prompts shown in the other tab:

intelliask banner set

What do these options mean?

  • Display From/To: When the banner should appear and disappear. Leave empty for "now" and "forever".
  • Is public (--public): Show to visitors who aren't logged in (like on the login page).
  • Is persistable (--persistable): If yes, users can't dismiss the banner — use for important notices.

Deleting a Banner

intelliask banner clear

You'll be asked to confirm before it's removed. Pass --yes to skip the prompt.

Example Banners

A simple welcome message that users can dismiss:

# intelliask binary
intelliask banner set -m "👋 Welcome to IntelliAsk!"
 
# npm (inside the container)
npm run update-banner "" "" "👋 Welcome to IntelliAsk!" "false" "false"

Date Format

Use this format for dates: yyyy-mm-ddTHH:MM:SSZ

Examples:

  • 2025-12-25T09:00:00Z → December 25, 2025 at 9:00 AM (UTC)
  • 2025-01-01T00:00:00Z → January 1, 2025 at midnight (UTC)

Leave the date empty to use the current time or no end date.

Last updated on