-
Notifications
You must be signed in to change notification settings - Fork 0
📝 Add comprehensive CLAUDE.md for AI assistant guidance #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,295 @@ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # CLAUDE.md - AI Assistant Guide for BlackRoad Dashboards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Repository Overview | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| **BlackRoad Dashboards** is a collection of 117 terminal-based dashboard scripts for monitoring BlackRoad OS infrastructure. All dashboards are written in pure Bash and display rich terminal UIs using ANSI escape codes with 24-bit RGB color support. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| **Owner:** BlackRoad OS, Inc. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| **CEO:** Alexa Amundson | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| **License:** Proprietary (testing/evaluation purposes only) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| **Contact:** blackroad.systems@gmail.com | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Quick Reference | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ```bash | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Main launcher (interactive menu) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ./br-dashboards.sh | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Recommended starting point | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ./blackroad-master-control.sh | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Setup wizard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ./setup.sh | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Interactive dashboard launcher | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ./launch.sh | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Repository Structure | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| blackroad-dashboards/ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ├── .github/workflows/ # GitHub Actions CI/CD | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| │ ├── core-ci.yml # Main CI pipeline | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| │ ├── deploy.yml # Cloudflare Pages deployment | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| │ ├── auto-label.yml # PR auto-labeling | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| │ ├── failure-issue.yml # CI failure tracking | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| │ └── project-sync.yml # Project board sync | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ├── *.sh # 117 dashboard scripts | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ├── README.md # Main documentation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ├── CONTRIBUTING.md # Contribution guidelines | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ├── QUICK_START.md # Quick start guide | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ├── STATUS.md # System status documentation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ├── LICENSE # Proprietary license | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| └── CLAUDE.md # This file | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Dashboard Categories | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ### Core Dashboards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | Script | Description | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |--------|-------------| | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | `blackroad-dashboard.sh` | Basic agent status dashboard | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | `blackroad-live-dashboard.sh` | Live infrastructure monitoring | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | `blackroad-full-system.sh` | Enhanced system monitor with progress bars | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | `blackroad-ultimate.sh` | Full-featured with sound, APIs, SSH menu | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | `blackroad-master-control.sh` | Unified control center (recommended) | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | `blackroad-beautiful-os.sh` | Modern card-based UI | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | `blackroad-os95.sh` | Windows 95 retro UI | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ### Device-Specific Dashboards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | Script | Description | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |--------|-------------| | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | `device-raspberry-pi.sh` | Raspberry Pi cluster monitoring | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | `device-cloudflare.sh` | Cloudflare zones, Pages, KV, D1 | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | `device-github.sh` | GitHub repos and organizations | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | `device-railway.sh` | Railway deployment status | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ### Utility Dashboards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | Script | Description | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |--------|-------------| | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | `agent-detail.sh` | Individual agent inspection | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | `setup.sh` | Interactive configuration wizard | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | `launch.sh` | Dashboard selector menu | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Shell Script Conventions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ### Color Definitions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| All scripts use consistent 24-bit RGB ANSI colors: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ```bash | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Background colors | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BG_DEEP="\033[48;2;10;10;18m" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BG_SURFACE="\033[48;2;18;18;31m" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BG_ELEVATED="\033[48;2;26;26;46m" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Accent colors (primary palette) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ORANGE="\033[38;2;247;147;26m" # #f7931a - Bitcoin orange | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PINK="\033[38;2;233;30;140m" # #e91e8c - Primary brand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PURPLE="\033[38;2;153;69;255m" # #9945ff - Solana purple | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BLUE="\033[38;2;20;241;149m" # #14f195 - Teal/cyan | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CYAN="\033[38;2;0;212;255m" # #00d4ff | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Text colors | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TEXT_PRIMARY="\033[38;2;255;255;255m" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TEXT_SECONDARY="\033[38;2;153;153;153m" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TEXT_MUTED="\033[38;2;77;77;77m" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Control codes | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| RESET="\033[0m" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BOLD="\033[1m" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| DIM="\033[2m" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ### Script Structure Pattern | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ```bash | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| #!/bin/bash | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Script title and description comment | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Color definitions (as above) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Clear screen | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| clear | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Header with gradient logo | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| echo -e "${BOLD}${ORANGE}╔════════════════════════════════════════════════════════════════════════╗${RESET}" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| echo -e "${BOLD}${ORANGE}║${RESET} ${BOLD}${ORANGE}👻${RESET} ${BOLD}${ORANGE}B${PINK}L${PURPLE}A${BLUE}C${CYAN}K${ORANGE}R${PINK}O${PURPLE}A${BLUE}D${RESET} ${TEXT_SECONDARY}OS${RESET} ${BOLD}${ORANGE}║${RESET}" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| echo -e "${BOLD}${ORANGE}╚════════════════════════════════════════════════════════════════════════╝${RESET}" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Content sections with separators | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| echo -e "${TEXT_MUTED}SECTION TITLE${RESET}" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| echo -e "${PINK}─────────────────────────────────────────────────────────────────────────${RESET}" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Footer with timestamp | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| echo -e "${TEXT_SECONDARY}Time: ${RESET}${BOLD}$(date '+%H:%M:%S')${RESET}" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ### Common CLI Patterns | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - `--watch` flag: Auto-refresh every 5 seconds | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - `--boot` flag: Show boot animation (Windows 95 edition) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Interactive controls: `q` quit, `s` SSH menu, `r` refresh, `1-6` tab switching | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Infrastructure Monitored | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ### Raspberry Pi Network | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Lucidia Prime: `192.168.4.38` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - BlackRoad Pi: `192.168.4.64` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Lucidia Alt: `192.168.4.99` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - iPhone Koder: `192.168.4.68:8080` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ### Cloud Services | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - **DigitalOcean:** Codex Infinity (`159.65.43.12`) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - **Cloudflare:** 16 zones, 8 Pages, 8 KV namespaces, 1 D1 database | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - **GitHub:** 15 organizations, 66+ repositories | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - **Railway:** 12+ active projects | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ### Crypto Portfolio | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Bitcoin: 0.1 BTC (Coinbase) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Ethereum: 2.5 ETH (MetaMask) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Solana: 100 SOL (Phantom) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+147
to
+149
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Bitcoin: 0.1 BTC (Coinbase) | |
| - Ethereum: 2.5 ETH (MetaMask) | |
| - Solana: 100 SOL (Phantom) | |
| - Example only (do not commit real holdings or wallet details). | |
| - Bitcoin: `BTC_AMOUNT=<redacted>` (wallet: `BTC_WALLET_PROVIDER=<redacted>`) | |
| - Ethereum: `ETH_AMOUNT=<redacted>` (wallet: `ETH_WALLET_PROVIDER=<redacted>`) | |
| - Solana: `SOL_AMOUNT=<redacted>` (wallet: `SOL_WALLET_PROVIDER=<redacted>`) |
Copilot
AI
Jan 27, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This documentation section exposes specific network IP addresses and detailed cryptocurrency holdings tied to concrete services and providers, which can be used by attackers for targeted network reconnaissance and social engineering (e.g., phishing for Coinbase, MetaMask, or Phantom access). If this repository is or becomes accessible outside a tightly controlled environment, consider removing or anonymizing real infrastructure addresses and asset amounts, replacing them with placeholders or high-level descriptions to avoid leaking sensitive operational and financial information.
| - Lucidia Prime: `192.168.4.38` | |
| - BlackRoad Pi: `192.168.4.64` | |
| - Lucidia Alt: `192.168.4.99` | |
| - iPhone Koder: `192.168.4.68:8080` | |
| ### Cloud Services | |
| - **DigitalOcean:** Codex Infinity (`159.65.43.12`) | |
| - **Cloudflare:** 16 zones, 8 Pages, 8 KV namespaces, 1 D1 database | |
| - **GitHub:** 15 organizations, 66+ repositories | |
| - **Railway:** 12+ active projects | |
| ### Crypto Portfolio | |
| - Bitcoin: 0.1 BTC (Coinbase) | |
| - Ethereum: 2.5 ETH (MetaMask) | |
| - Solana: 100 SOL (Phantom) | |
| - Lucidia Prime: `[internal IP redacted]` | |
| - BlackRoad Pi: `[internal IP redacted]` | |
| - Lucidia Alt: `[internal IP redacted]` | |
| - iPhone Koder: `[internal IP and port redacted]` | |
| ### Cloud Services | |
| - **DigitalOcean:** Codex Infinity (`[public IP redacted]`) | |
| - **Cloudflare:** 16 zones, 8 Pages, 8 KV namespaces, 1 D1 database | |
| - **GitHub:** 15 organizations, 66+ repositories | |
| - **Railway:** 12+ active projects | |
| ### Crypto Portfolio | |
| BlackRoad maintains diversified holdings across major chains (e.g., Bitcoin, Ethereum, Solana) using reputable exchanges and wallets. Specific balances and providers are intentionally omitted from this public documentation. |
Copilot
AI
Jan 27, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section is titled "Environment Variables", but HOME/.blackroad-config is a file path, not an environment variable. Either move it out of this table (e.g., into a "Configuration files" section) or rename the table/column to reflect that it includes file locations as well.
Copilot
AI
Jan 27, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The note "no external dependencies beyond standard Unix tools" is not accurate for macOS as written: many scripts use timeout (e.g., blackroad-live-dashboard.sh:25), which is not available on macOS by default. Suggest updating this guidance to list required commands (or note that macOS users may need coreutils/gtimeout or an alternative implementation).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The doc states there are "117" dashboard scripts, but in-repo references disagree (e.g.,
br-dashboards.shheader says "all 28 terminal dashboards" anddashboard-launcher.shsays "92+ dashboards"). To avoid future drift, avoid hard-coding a specific count here (or compute it in scripts/docs generation).