understand-dashboard

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

/understand-dashboard

/understand-dashboard

Start the Understand Anything dashboard to visualize the knowledge graph for the current project.
启动Understand Anything仪表板,可视化当前项目的知识图谱。

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
    .understand-anything/knowledge-graph.json
    exists in the project directory. If not, tell the user:
    No knowledge graph found. Run /understand 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)
    • ~/.understand-anything-plugin/packages/dashboard/
      (universal symlink, all installs)
    • Two levels up from
      ~/.agents/skills/understand-dashboard
      real path (self-relative fallback)
    • Two levels up from
      ~/.copilot/skills/understand-dashboard
      real path (Copilot personal skills fallback)
    • Common clone-based install roots:
      • ~/.codex/understand-anything/understand-anything-plugin/packages/dashboard/
      • ~/.opencode/understand-anything/understand-anything-plugin/packages/dashboard/
      • ~/.pi/understand-anything/understand-anything-plugin/packages/dashboard/
      • ~/understand-anything/understand-anything-plugin/packages/dashboard/
    Use the Bash tool to resolve:
    bash
    SKILL_REAL=$(realpath ~/.agents/skills/understand-dashboard 2>/dev/null || readlink -f ~/.agents/skills/understand-dashboard 2>/dev/null || echo "")
    SELF_RELATIVE=$([ -n "$SKILL_REAL" ] && cd "$SKILL_REAL/../.." 2>/dev/null && pwd || echo "")
    COPILOT_SKILL_REAL=$(realpath ~/.copilot/skills/understand-dashboard 2>/dev/null || readlink -f ~/.copilot/skills/understand-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/.understand-anything-plugin" \
      "$SELF_RELATIVE" \
      "$COPILOT_SELF_RELATIVE" \
      "$HOME/.codex/understand-anything/understand-anything-plugin" \
      "$HOME/.opencode/understand-anything/understand-anything-plugin" \
      "$HOME/.pi/understand-anything/understand-anything-plugin" \
      "$HOME/understand-anything/understand-anything-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 understand-anything plugin root."
      echo "Checked:"
      echo "  - ${CLAUDE_PLUGIN_ROOT:-<unset CLAUDE_PLUGIN_ROOT>}"
      echo "  - $HOME/.understand-anything-plugin"
      echo "  - ${SELF_RELATIVE:-<unresolved path derived from ~/.agents/skills/understand-dashboard>}"
      echo "  - ${COPILOT_SELF_RELATIVE:-<unresolved path derived from ~/.copilot/skills/understand-dashboard>}"
      echo "  - $HOME/.codex/understand-anything/understand-anything-plugin"
      echo "  - $HOME/.opencode/understand-anything/understand-anything-plugin"
      echo "  - $HOME/.pi/understand-anything/understand-anything-plugin"
      echo "  - $HOME/understand-anything/understand-anything-plugin"
      echo "Make sure you followed the installation instructions for your platform."
      exit 1
    fi
  4. Install dependencies and build if needed:
    bash
    cd <dashboard-dir> && pnpm install --frozen-lockfile 2>/dev/null || pnpm install
    Then ensure the core package is built (the dashboard depends on it):
    bash
    cd <plugin-root> && pnpm --filter @understand-anything/core build
  5. Start the Vite dev server pointing at the project's knowledge graph:
    bash
    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>/.understand-anything/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.
  1. 确定项目目录:
    • 如果
      $ARGUMENTS
      包含路径,则使用该路径作为项目目录
    • 否则,使用当前工作目录
  2. 检查项目目录中是否存在
    .understand-anything/knowledge-graph.json
    。如果不存在,告知用户:
    No knowledge graph found. Run /understand first to analyze this project.
  3. 查找仪表板代码。仪表板位于此插件根目录下的
    packages/dashboard/
    。按以下顺序检查路径,使用第一个存在的路径:
    • ${CLAUDE_PLUGIN_ROOT}/packages/dashboard/
      (Claude Code运行时根目录,优先级最高)
    • ~/.understand-anything-plugin/packages/dashboard/
      (通用符号链接,适用于所有安装)
    • ~/.agents/skills/understand-dashboard
      实际路径向上两级(自相对回退)
    • ~/.copilot/skills/understand-dashboard
      实际路径向上两级(Copilot个人技能回退)
    • 常见基于克隆的安装根目录:
      • ~/.codex/understand-anything/understand-anything-plugin/packages/dashboard/
      • ~/.opencode/understand-anything/understand-anything-plugin/packages/dashboard/
      • ~/.pi/understand-anything/understand-anything-plugin/packages/dashboard/
      • ~/understand-anything/understand-anything-plugin/packages/dashboard/
    使用Bash工具解析:
    bash
    SKILL_REAL=$(realpath ~/.agents/skills/understand-dashboard 2>/dev/null || readlink -f ~/.agents/skills/understand-dashboard 2>/dev/null || echo "")
    SELF_RELATIVE=$([ -n "$SKILL_REAL" ] && cd "$SKILL_REAL/../.." 2>/dev/null && pwd || echo "")
    COPILOT_SKILL_REAL=$(realpath ~/.copilot/skills/understand-dashboard 2>/dev/null || readlink -f ~/.copilot/skills/understand-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/.understand-anything-plugin" \
      "$SELF_RELATIVE" \
      "$COPILOT_SELF_RELATIVE" \
      "$HOME/.codex/understand-anything/understand-anything-plugin" \
      "$HOME/.opencode/understand-anything/understand-anything-plugin" \
      "$HOME/.pi/understand-anything/understand-anything-plugin" \
      "$HOME/understand-anything/understand-anything-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 understand-anything plugin root."
      echo "Checked:"
      echo "  - ${CLAUDE_PLUGIN_ROOT:-<unset CLAUDE_PLUGIN_ROOT>}"
      echo "  - $HOME/.understand-anything-plugin"
      echo "  - ${SELF_RELATIVE:-<unresolved path derived from ~/.agents/skills/understand-dashboard>}"
      echo "  - ${COPILOT_SELF_RELATIVE:-<unresolved path derived from ~/.copilot/skills/understand-dashboard>}"
      echo "  - $HOME/.codex/understand-anything/understand-anything-plugin"
      echo "  - $HOME/.opencode/understand-anything/understand-anything-plugin"
      echo "  - $HOME/.pi/understand-anything/understand-anything-plugin"
      echo "  - $HOME/understand-anything/understand-anything-plugin"
      echo "Make sure you followed the installation instructions for your platform."
      exit 1
    fi
  4. 安装依赖并按需构建:
    bash
    cd <dashboard-dir> && pnpm install --frozen-lockfile 2>/dev/null || pnpm install
    然后确保核心包已构建(仪表板依赖于此):
    bash
    cd <plugin-root> && pnpm --filter @understand-anything/core build
  5. 启动指向项目知识图谱的Vite开发服务器:
    bash
    cd <dashboard-dir> && GRAPH_DIR=<project-dir> npx vite --host 127.0.0.1
    在后台运行此命令,以便用户可以继续工作。
  6. 从服务器输出中捕获访问令牌URL。Vite服务器会打印如下内容:
    🔑  Dashboard URL: http://127.0.0.1:<PORT>?token=<TOKEN>
    提取包含
    ?token=
    参数的完整URL。访问令牌是访问知识图谱数据所必需的 — 没有它,仪表板将显示"Access Token Required"(需要访问令牌)的提示。
  7. 向用户报告,包括完整的带令牌URL:
    Dashboard started at http://127.0.0.1:<PORT>?token=<TOKEN>
    Viewing: <project-dir>/.understand-anything/knowledge-graph.json
    
    The dashboard is running in the background. Press Ctrl+C in the terminal to stop it.
    重要提示: 分享URL时务必包含
    ?token=
    参数。如果省略,用户将被令牌验证拦截,必须手动从终端输出中查找令牌。

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
  • 仪表板会通过
    --open
    参数在默认浏览器中自动打开
  • 如果端口5173已被占用,Vite会选择下一个可用端口
  • GRAPH_DIR
    环境变量用于告知仪表板知识图谱的位置