beacon-dashboard

/beacon-dashboard

Start the Beacon dashboard to visualize the knowledge graph for the current project.

Instructions

1. Determine the project directory:

   • If $ARGUMENTS contains a path, use that as the project directory
   • Otherwise, use the current working directory

2. Check that .beacon/knowledge-graph.json exists in the project directory. If not, tell the user:

   No knowledge graph found. Run /beacon first to analyze this project.
   

3. Find the dashboard code. The dashboard is at packages/dashboard/ relative to this plugin's root directory. Check these paths in order and use the first that exists:

   • ${CLAUDE_PLUGIN_ROOT}/packages/dashboard/ (Claude Code runtime root, highest priority)
   • ~/.beacon-plugin/packages/dashboard/ (universal symlink, all installs)
   • Two levels up from ~/.agents/skills/beacon-dashboard real path (self-relative fallback)
   • Two levels up from ~/.copilot/skills/beacon-dashboard real path (Copilot personal skills fallback)
   • Common clone-based install roots:
     • ~/.codex/beacon/beacon-plugin/packages/dashboard/
     • ~/.opencode/beacon/beacon-plugin/packages/dashboard/
     • ~/.pi/beacon/beacon-plugin/packages/dashboard/
     • ~/beacon/beacon-plugin/packages/dashboard/

   Use the Bash tool to resolve:

   SKILL_REAL=$(realpath ~/.agents/skills/beacon-dashboard 2>/dev/null || readlink -f ~/.agents/skills/beacon-dashboard 2>/dev/null || echo "")
   SELF_RELATIVE=$([ -n "$SKILL_REAL" ] && cd "$SKILL_REAL/../.." 2>/dev/null && pwd || echo "")
   COPILOT_SKILL_REAL=$(realpath ~/.copilot/skills/beacon-dashboard 2>/dev/null || readlink -f ~/.copilot/skills/beacon-dashboard 2>/dev/null || echo "")
   COPILOT_SELF_RELATIVE=$([ -n "$COPILOT_SKILL_REAL" ] && cd "$COPILOT_SKILL_REAL/../.." 2>/dev/null && pwd || echo "")
   
   PLUGIN_ROOT=""
   for candidate in \
     "${CLAUDE_PLUGIN_ROOT}" \
     "$HOME/.beacon-plugin" \
     "$SELF_RELATIVE" \
     "$COPILOT_SELF_RELATIVE" \
     "$HOME/.codex/beacon/beacon-plugin" \
     "$HOME/.opencode/beacon/beacon-plugin" \
     "$HOME/.pi/beacon/beacon-plugin" \
     "$HOME/beacon/beacon-plugin"; do
     if [ -n "$candidate" ] && [ -d "$candidate/packages/dashboard" ]; then
       PLUGIN_ROOT="$candidate"; break
     fi
   done
   
   if [ -z "$PLUGIN_ROOT" ]; then
     echo "Error: Cannot find the beacon plugin root."
     echo "Checked:"
     echo "  - ${CLAUDE_PLUGIN_ROOT:-<unset CLAUDE_PLUGIN_ROOT>}"
     echo "  - $HOME/.beacon-plugin"
     echo "  - ${SELF_RELATIVE:-<unresolved path derived from ~/.agents/skills/beacon-dashboard>}"
     echo "  - ${COPILOT_SELF_RELATIVE:-<unresolved path derived from ~/.copilot/skills/beacon-dashboard>}"
     echo "  - $HOME/.codex/beacon/beacon-plugin"
     echo "  - $HOME/.opencode/beacon/beacon-plugin"
     echo "  - $HOME/.pi/beacon/beacon-plugin"
     echo "  - $HOME/beacon/beacon-plugin"
     echo "Make sure you followed the installation instructions for your platform."
     exit 1
   fi
   

4. Install dependencies and build if needed:

   cd <dashboard-dir> && pnpm install --frozen-lockfile 2>/dev/null || pnpm install
   

   Then ensure the core package is built (the dashboard depends on it):

   cd <plugin-root> && pnpm --filter @beacon/core build
   

5. Start the Vite dev server pointing at the project's knowledge graph:

   cd <dashboard-dir> && GRAPH_DIR=<project-dir> npx vite --host 127.0.0.1
   

   Run this in the background so the user can continue working.

6. Capture the access token URL from the server output. The Vite server prints a line like:

   🔑  Dashboard URL: http://127.0.0.1:<PORT>?token=<TOKEN>
   

   Extract the full URL including the ?token= parameter. The token is required to access the knowledge graph data — without it the dashboard will show an "Access Token Required" gate.

7. Report to the user, including the full tokenized URL:

   Dashboard started at http://127.0.0.1:<PORT>?token=<TOKEN>
   Viewing: <project-dir>/.beacon/knowledge-graph.json
   
   The dashboard is running in the background. Press Ctrl+C in the terminal to stop it.
   

   Important: Always include the ?token= parameter in the URL you share. If you omit it, the user will be blocked by the token gate and have to manually find the token in the terminal output.

Notes

• The dashboard auto-opens in the default browser via --open
• If port 5173 is already in use, Vite will pick the next available port
• The GRAPH_DIR environment variable tells the dashboard where to find the knowledge graph