Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/raycast/script-commands/llms.txt

Use this file to discover all available pages before exploring further.

Dashboard scripts use Raycast’s inline mode to display live information directly in your command list. These scripts refresh automatically and provide at-a-glance status updates without opening separate windows.

​
What are Dashboard Scripts?

Dashboard scripts use the inline mode and refreshTime parameter to:
  • Display information directly in Raycast’s command list
  • Auto-refresh at specified intervals (10s, 1m, 12h, 1d)
  • Show live status without executing the script manually
  • Pin to favorites for always-visible widgets
Learn more about inline mode in the Output Modes documentation.

​
Available Dashboard Scripts

System Monitoring

  • CPU usage
  • Memory usage
  • Battery status
  • Disk space
  • Network status
  • Temperature sensors

Time & Calendar

  • Current time in multiple time zones
  • Countdown timers
  • Upcoming calendar events
  • Days until/since dates

Weather

  • Current weather conditions
  • Temperature and humidity
  • Weather forecasts
  • Weather alerts

Cryptocurrency

  • Crypto prices
  • Portfolio values
  • Price change indicators
  • Market caps

Stock Prices

  • Live stock quotes
  • Market indices
  • Portfolio tracking
  • Price alerts

API Monitoring

  • Service status
  • API health checks
  • Uptime monitoring
  • Response times

Metrics & Analytics

  • Business metrics (ARR, MRR, ARPU)
  • Website analytics
  • Performance indicators
  • Custom KPIs

Developer Stats

  • GitHub stats
  • CI/CD status
  • Deployment status
  • Build health

​
Creating Dashboard Scripts

A dashboard script requires:
  1. Inline mode - Display output in the command list
  2. Refresh time - Auto-update interval
  3. Brief output - First line is displayed
Example Dashboard Script
#!/bin/bash

# @raycast.schemaVersion 1
# @raycast.title Current Time
# @raycast.mode inline
# @raycast.refreshTime 1s
# @raycast.packageName Dashboard

# @raycast.icon 🕐

date "+%H:%M:%S"
Only the first 10 inline scripts will auto-refresh. The rest must be manually refreshed by navigating to them and pressing return.

​
Best Practices

1

Keep Output Brief

Only the first line is displayed in inline mode. Keep it concise and informative.
2

Choose Appropriate Refresh Intervals

Balance freshness with performance. Use longer intervals for less time-sensitive data.
3

Handle API Failures Gracefully

Display fallback text or cached values when external APIs are unavailable.
4

Use Color for Status

Leverage ANSI color codes to indicate status (green for good, red for alerts).
5

Pin to Favorites

Use Raycast’s favorites feature (Cmd+K) to keep important dashboards visible.

​
Performance Considerations

  • 10-30s: System metrics (CPU, memory)
  • 1-5m: Weather, stock prices
  • 10-30m: Analytics, metrics dashboards
  • 1-6h: Less critical monitoring
  • 12-24h: Daily summaries, reports
For scripts calling external APIs:
  • Cache responses to reduce API calls
  • Use the refresh time to control cache expiry
  • Store cache in /tmp or ~/.cache

Output Modes

Learn more about inline mode and ANSI colors

System Scripts

System monitoring and status scripts

Build docs developers (and LLMs) love

Get started for freeTalk to us