#!/usr/bin/env bash # ╔═══════════════════════════════════════════════════════════════════════════╗ # ║ shipwright public-dashboard — Public real-time pipeline progress ║ # ║ Shareable URLs · Self-contained HTML · Privacy controls ║ # ╚═══════════════════════════════════════════════════════════════════════════╝ set -euo pipefail trap 'echo "ERROR: $BASH_SOURCE:$LINENO exited with status $?" >&2' ERR # shellcheck disable=SC2034 VERSION="3.3.0" SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" REPO_DIR="$(cd "$SCRIPT_DIR/.." && pwd)" # ─── Cross-platform compatibility ────────────────────────────────────────── # shellcheck source=lib/compat.sh [[ -f "$SCRIPT_DIR/lib/compat.sh" ]] && source "$SCRIPT_DIR/lib/compat.sh" # Canonical helpers (colors, output, events) # shellcheck source=lib/helpers.sh [[ -f "$SCRIPT_DIR/lib/helpers.sh" ]] && source "$SCRIPT_DIR/lib/helpers.sh" # Fallbacks when helpers not loaded (e.g. test env with overridden SCRIPT_DIR) [[ "$(type -t info 2>/dev/null)" == "function" ]] || info() { echo -e "\033[38;2;0;212;255m\033[1m▸\033[0m $*"; } [[ "$(type -t success 2>/dev/null)" == "function" ]] || success() { echo -e "\033[38;2;74;222;128m\033[1m✓\033[0m $*"; } [[ "$(type -t warn 2>/dev/null)" == "function" ]] || warn() { echo -e "\033[38;2;250;204;21m\033[1m⚠\033[0m $*"; } [[ "$(type -t error 2>/dev/null)" == "function" ]] || error() { echo -e "\033[38;2;248;113;113m\033[1m✗\033[0m $*" >&2; } if [[ "$(type -t now_iso 2>/dev/null)" != "function" ]]; then now_iso() { date -u +"%Y-%m-%dT%H:%M:%SZ"; } now_epoch() { date +%s; } fi if [[ "$(type -t emit_event 2>/dev/null)" != "function" ]]; then emit_event() { local event_type="$1"; shift; mkdir -p "${HOME}/.shipwright" local payload payload="{\"ts\":\"$(date -u +%Y-%m-%dT%H:%M:%SZ)\",\"type\":\"$event_type\"" while [[ $# -gt 0 ]]; do local key="${1%%=*}" val="${1#*=}"; payload="${payload},\"${key}\":\"${val}\""; shift; done echo "${payload}}" >> "${HOME}/.shipwright/events.jsonl" } fi # ─── Paths ────────────────────────────────────────────────────────────────── PUB_DASH_DIR="${HOME}/.shipwright/public-dashboard" SHARE_LINKS_FILE="${PUB_DASH_DIR}/share-links.json" SHARE_CONFIG_FILE="${PUB_DASH_DIR}/config.json" # ─── Initialization ────────────────────────────────────────────────────────── ensure_dirs() { mkdir -p "$PUB_DASH_DIR" [[ -f "$SHARE_LINKS_FILE" ]] || echo '{"links":[]}' > "$SHARE_LINKS_FILE" [[ -f "$SHARE_CONFIG_FILE" ]] || echo '{"privacy":"stages_only","expiry_hours":24,"custom_domain":"","branding":""}' > "$SHARE_CONFIG_FILE" } # ─── Sanitize Functions ────────────────────────────────────────────────────── sanitize_for_privacy() { local input="$1" local privacy_level="${2:-stages_only}" case "$privacy_level" in public) # Full details echo "$input" ;; anonymized) # Hide paths and tokens echo "$input" | sed -E \ -e 's|/Users/[^/]+|/home/user|g' \ -e 's/(ghp_|sk_live_)[A-Za-z0-9_-]+/[REDACTED_TOKEN]/g' \ -e 's/(CLAUDECODE|GITHUB_TOKEN)=[^ ]*/[REDACTED_ENV]/g' \ -e 's/@[^ ]*\.com/@redacted.com/g' ;; stages_only) # Only stage names and status echo "$input" | sed -E \ -e 's|"description":"[^"]*"|"description":""|g' \ -e 's|"logs":"[^"]*"|"logs":""|g' \ -e 's|"output":"[^"]*"|"output":""|g' \ -e 's|/Users/[^/]+|/home/user|g' ;; esac } # ─── Gather Current Pipeline State ────────────────────────────────────────── gather_pipeline_state() { local privacy="${1:-stages_only}" # shellcheck disable=SC2034 local state_file="${REPO_DIR}/.claude/pipeline-state.md" local daemon_state="${HOME}/.shipwright/daemon-state.json" local pipeline_artifacts="${REPO_DIR}/.claude/pipeline-artifacts" local pipeline_data pipeline_data='{ "status":"unknown", "stages":[], "agents":[], "events":[], "updated_at":"'"$(now_iso)"'" }' # Read daemon state if [[ -f "$daemon_state" ]]; then local active_jobs queued_count active_jobs=$(jq -c '.active_jobs // []' "$daemon_state" 2>/dev/null || echo "[]") queued_count=$(jq 'length' <<<"$active_jobs" 2>/dev/null || echo "0") if [[ "$queued_count" -gt 0 ]]; then pipeline_data=$(jq --argjson jobs "$active_jobs" '.agents = $jobs' <<<"$pipeline_data") fi fi # Read recent events (last 50) if [[ -f "$EVENTS_FILE" ]]; then local events events=$(tail -50 "$EVENTS_FILE" | jq -c -s '.' 2>/dev/null || echo "[]") pipeline_data=$(jq --argjson events "$events" '.events = $events' <<<"$pipeline_data") fi # Read pipeline artifacts if available if [[ -d "$pipeline_artifacts" ]]; then local stage_count stage_count=$(find "$pipeline_artifacts" -name "*.md" -o -name "*.json" | wc -l || true) stage_count="${stage_count:-0}" pipeline_data=$(jq --arg count "$stage_count" '.artifact_count = $count' <<<"$pipeline_data") fi # Sanitize based on privacy level sanitize_for_privacy "$pipeline_data" "$privacy" } # ─── Generate Token ───────────────────────────────────────────────────────── generate_token() { # Create a read-only token (32 hex chars) if command -v openssl >/dev/null 2>&1; then openssl rand -hex 16 else # Fallback to simple pseudo-random head -c 32 /dev/urandom | od -An -tx1 | tr -d ' ' fi } # ─── Generate Self-Contained HTML ────────────────────────────────────────── generate_html() { local data_json="$1" local title="${2:-Shipwright Pipeline Progress}" local privacy="${3:-stages_only}" # Escape JSON for embedding in HTML local json_escaped # shellcheck disable=SC2034 json_escaped=$(echo "$data_json" | sed 's/"/\\"/g' | tr '\n' ' ') cat <<'EOF' TITLE_PLACEHOLDER

⚓ TITLE_PLACEHOLDER

Updated —
Privacy PRIVACY_PLACEHOLDER
📊 Pipeline Status
Overall Loading...
Active Agents —
Completed Events —
⚙️ Artifacts
Stage Files —
Stage outputs and checkpoints available in pipeline artifacts
📝 Recent Events
Loading events...

Generated by Shipwright v1.13.0

Dashboard auto-refreshes every 30s when served from dashboard server

EOF } # ─── Export Command ───────────────────────────────────────────────────────── cmd_export() { local output_file="${1:-${PUB_DASH_DIR}/dashboard.html}" local title="${2:-Shipwright Pipeline Progress}" local privacy="${3:-stages_only}" ensure_dirs info "Gathering pipeline state (privacy: $privacy)..." local state_data state_data=$(gather_pipeline_state "$privacy") info "Generating HTML export..." local html html=$(generate_html "$state_data" "$title" "$privacy") # Replace placeholders html="${html//TITLE_PLACEHOLDER/$title}" html="${html//PRIVACY_PLACEHOLDER/$privacy}" html="${html//\{DATA_PLACEHOLDER\}/$state_data}" html="${html//GITHUB_URL_PLACEHOLDER/$(_sw_github_url)}" # Atomic write local tmp_file tmp_file=$(mktemp) # shellcheck disable=SC2064 trap "rm -f '$tmp_file'" EXIT echo "$html" > "$tmp_file" mv "$tmp_file" "$output_file" emit_event "public_dashboard_export" "privacy=$privacy" "path=$output_file" success "Dashboard exported to: $output_file" echo " Size: $(du -h "$output_file" | cut -f1)" echo " Privacy: $privacy" } # ─── Share Command ────────────────────────────────────────────────────────── cmd_share() { local expiry_hours="${1:-24}" local privacy="${2:-stages_only}" ensure_dirs info "Creating share link (expires in ${expiry_hours}h)..." local token token=$(generate_token) local expires_at expires_at=$(($(now_epoch) + expiry_hours * 3600)) local link_entry link_entry=$(jq -n \ --arg token "$token" \ --arg privacy "$privacy" \ --arg created "$(now_iso)" \ --arg expires "$(date -u -d "@$expires_at" +%Y-%m-%dT%H:%M:%SZ 2>/dev/null || date -u -v +${expiry_hours}H +%Y-%m-%dT%H:%M:%SZ)" \ '{token:$token, privacy:$privacy, created:$created, expires:$expires, view_count:0, last_viewed:null}') # Append to share links file (atomic) local tmp_file tmp_file=$(mktemp) # shellcheck disable=SC2064 trap "rm -f '$tmp_file'" EXIT jq ".links += [$link_entry]" "$SHARE_LINKS_FILE" > "$tmp_file" mv "$tmp_file" "$SHARE_LINKS_FILE" emit_event "public_dashboard_share" "token=$token" "privacy=$privacy" "expires_hours=$expiry_hours" success "Share link created!" echo " Token: $token" echo " Privacy: $privacy" echo " Expires: $(date -u -d "@$expires_at" +%Y-%m-%d\ %H:%M:%S 2>/dev/null || date -u -v +${expiry_hours}H +%Y-%m-%d\ %H:%M:%S)" echo "" echo " Share URL: https://your-domain.com/public-dashboard/$token" echo " or embed: " } # ─── Revoke Command ───────────────────────────────────────────────────────── cmd_revoke() { local token="$1" [[ -z "$token" ]] && error "Token required" && return 1 ensure_dirs info "Revoking share link: $token" local tmp_file tmp_file=$(mktemp) # shellcheck disable=SC2064 trap "rm -f '$tmp_file'" EXIT if jq ".links |= map(select(.token != \"$token\"))" "$SHARE_LINKS_FILE" > "$tmp_file"; then mv "$tmp_file" "$SHARE_LINKS_FILE" emit_event "public_dashboard_revoke" "token=$token" success "Share link revoked" else error "Failed to revoke link" return 1 fi } # ─── List Command ─────────────────────────────────────────────────────────── cmd_list() { ensure_dirs local now_epoch_val now_epoch_val=$(now_epoch) info "Active share links:" echo "" if ! jq empty "$SHARE_LINKS_FILE" 2>/dev/null; then warn "No share links found" return 0 fi local active_count=0 jq -r '.links[] | if (.expires | fromdateiso8601) > '$now_epoch_val' then .token + "|" + .privacy + "|" + .expires + "|" + (.view_count | tostring) else empty end' "$SHARE_LINKS_FILE" | while IFS='|' read -r token privacy expires views; do active_count=$((active_count + 1)) printf " %s... | Privacy: %-12s | Expires: %s | Views: %s\n" "${token:0:8}" "$privacy" "$expires" "$views" done local expired_count expired_count=$(jq "[.links[] | select((.expires | fromdateiso8601) <= $now_epoch_val)] | length" "$SHARE_LINKS_FILE" 2>/dev/null || echo "0") if [[ "$expired_count" -gt 0 ]]; then echo "" warn "$expired_count expired link(s) — run 'shipwright public-dashboard cleanup' to remove" fi } # ─── Config Command ───────────────────────────────────────────────────────── cmd_config() { local key="${1:-}" local value="${2:-}" ensure_dirs if [[ -z "$key" ]]; then info "Current config:" jq '.' "$SHARE_CONFIG_FILE" return 0 fi case "$key" in privacy) [[ -z "$value" ]] && error "Value required for privacy" && return 1 local tmp_file tmp_file=$(mktemp) # shellcheck disable=SC2064 trap "rm -f '$tmp_file'" EXIT jq ".privacy = \"$value\"" "$SHARE_CONFIG_FILE" > "$tmp_file" mv "$tmp_file" "$SHARE_CONFIG_FILE" success "Privacy set to: $value" ;; expiry) [[ -z "$value" ]] && error "Value required for expiry (hours)" && return 1 local tmp_file tmp_file=$(mktemp) # shellcheck disable=SC2064 trap "rm -f '$tmp_file'" EXIT jq ".expiry_hours = $value" "$SHARE_CONFIG_FILE" > "$tmp_file" mv "$tmp_file" "$SHARE_CONFIG_FILE" success "Default expiry set to: ${value}h" ;; domain) [[ -z "$value" ]] && error "Value required for domain" && return 1 local tmp_file tmp_file=$(mktemp) # shellcheck disable=SC2064 trap "rm -f '$tmp_file'" EXIT jq ".custom_domain = \"$value\"" "$SHARE_CONFIG_FILE" > "$tmp_file" mv "$tmp_file" "$SHARE_CONFIG_FILE" success "Custom domain set to: $value" ;; *) error "Unknown config key: $key" return 1 ;; esac } # ─── Embed Command ────────────────────────────────────────────────────────── cmd_embed() { local token="$1" local format="${2:-iframe}" [[ -z "$token" ]] && error "Token required" && return 1 ensure_dirs local domain domain=$(jq -r '.custom_domain // "your-domain.com"' "$SHARE_CONFIG_FILE") local url="https://${domain}/public-dashboard/${token}" case "$format" in iframe) cat < EOF ;; badge) cat < Pipeline Status EOF ;; markdown) cat < [![Pipeline Status]($url/badge)]($url) [View Full Dashboard]($url) EOF ;; link) echo "$url" ;; *) error "Unknown format: $format (iframe, badge, markdown, link)" return 1 ;; esac } # ─── Cleanup Command ──────────────────────────────────────────────────────── cmd_cleanup() { ensure_dirs local now_epoch_val now_epoch_val=$(now_epoch) local before_count after_count before_count=$(jq '.links | length' "$SHARE_LINKS_FILE" 2>/dev/null || echo "0") local tmp_file tmp_file=$(mktemp) # shellcheck disable=SC2064 trap "rm -f '$tmp_file'" EXIT jq ".links |= map(select((.expires | fromdateiso8601) > $now_epoch_val))" "$SHARE_LINKS_FILE" > "$tmp_file" mv "$tmp_file" "$SHARE_LINKS_FILE" after_count=$(jq '.links | length' "$SHARE_LINKS_FILE" 2>/dev/null || echo "0") local removed=$((before_count - after_count)) if [[ "$removed" -gt 0 ]]; then success "Cleaned up $removed expired link(s)" else info "No expired links to clean up" fi } # ─── Help ──────────────────────────────────────────────────────────────────── show_help() { cat < [options] ${CYAN}shipwright share${RESET} [--expires 24h] [--privacy anonymized] ${BOLD}COMMANDS${RESET} ${CYAN}export${RESET} [file] [title] [privacy] Generate self-contained HTML dashboard file File: output path (default: ~/.shipwright/public-dashboard/dashboard.html) Title: page title (default: "Shipwright Pipeline Progress") Privacy: stages_only, anonymized, or public (default: stages_only) ${CYAN}share${RESET} [expiry_hours] [privacy_level] Create a shareable link for real-time dashboard Expiry: hours until link expires (default: 24) Privacy: stages_only, anonymized, or public ${CYAN}revoke${RESET} Revoke a share link (invalidate the token) ${CYAN}list${RESET} List all active share links ${CYAN}config${RESET} [key] [value] View or modify dashboard configuration Keys: privacy, expiry, domain ${CYAN}embed${RESET} [format] Generate embed code (iframe, badge, markdown, link) ${CYAN}cleanup${RESET} Remove expired share links ${CYAN}help${RESET} Show this help message ${BOLD}EXAMPLES${RESET} # Export static HTML ${DIM}shipwright public-dashboard export${RESET} ${DIM}shipwright public-dashboard export dashboard.html "My Pipeline"${RESET} # Create shareable link (requires dashboard server) ${DIM}shipwright public-dashboard share 48 anonymized${RESET} # Generate embed code for README ${DIM}shipwright public-dashboard embed abc123def456 markdown${RESET} # Configure default privacy level ${DIM}shipwright public-dashboard config privacy anonymized${RESET} ${DIM}shipwright public-dashboard config domain app.example.com${RESET} ${BOLD}PRIVACY LEVELS${RESET} ${CYAN}stages_only${RESET} Only stage names and generic status info (most private) ${CYAN}anonymized${RESET} Full details with paths and tokens redacted ${CYAN}public${RESET} All details including paths and environment (least private) ${BOLD}OUTPUT${RESET} Generated HTML files are completely self-contained: - No external resources (all CSS/JS embedded) - ~50 KB gzipped - Works offline - Safe to share ${BOLD}SHARE LINKS${RESET} Share links require a running dashboard server to serve the public endpoint. By default, requires dashboard to serve at: https://your-domain.com/public-dashboard/ ${DIM}Docs: $(_sw_docs_url)${RESET} EOF } # ─── Main ─────────────────────────────────────────────────────────────────── main() { local cmd="${1:-help}" case "$cmd" in export) shift cmd_export "$@" ;; share) shift cmd_share "$@" ;; revoke) shift cmd_revoke "$@" ;; list) cmd_list ;; config) shift cmd_config "$@" ;; embed) shift cmd_embed "$@" ;; cleanup) cmd_cleanup ;; help|--help|-h) show_help ;; *) error "Unknown command: $cmd" echo "" show_help exit 1 ;; esac } if [[ "${BASH_SOURCE[0]}" == "$0" ]]; then main "$@" fi