콘텐츠로 이동

Dashboard

Agent Note dashboard preview

Dashboard 는 팀이 Agent Note 기록을 함께 볼 수 있는 하나의 공유 URL 입니다.

  • Open / Merged 된 PR 기록을 한곳에서 볼 수 있습니다
  • 각 PR 을 열지 않고도 commit, prompt, attribution 을 확인할 수 있습니다
  • Agent Note 가 reference 나 scope 를 복원할 수 있으면 짧은 prompt 앞에 표시 전용 📝 Context 를 볼 수 있습니다
  • 보통 /dashboard/ 아래의 GitHub Pages URL 하나를 팀과 공유할 수 있습니다

PR Description 만으로는 부족하고, 팀이 함께 보는 화면이 필요할 때 쓰면 좋습니다.

Dashboard 는 공유된 웹 화면이 필요할 때만 쓰면 됩니다.

  • pull request 안의 AI report 만으로 충분하다면 GitHub Action 에서 멈추면 됩니다.
  • Open / Merged 기록을 함께 보는 Pages 화면이 필요하다면 여기서 계속 진행하면 됩니다.
  1. Dashboard setup 을 한 번 실행합니다.
Terminal window
npx agent-note init --agent claude --dashboard
  1. 두 workflow file 을 commit 합니다.
Terminal window
git add .github/workflows/agentnote-pr-report.yml .github/workflows/agentnote-dashboard.yml
git commit -m "chore: enable agent-note dashboard"
git push
  1. GitHub Pages 에서 source 로 GitHub Actions 를 선택합니다.

생성된 Dashboard workflow 는 wasabeef/AgentNote@v1dashboard: true 를 전달해 restore, sync, build, artifact upload, note 저장을 실행하고, 공유용 /dashboard/ 화면을 공개합니다. 같은 job 에서 이미 GitHub Pages artifact 를 업로드하고 있다면 Agent Note 는 기존 site 를 바꾸지 않고 그 artifact 의 dashboard/ 디렉터리에 Dashboard 를 추가합니다. 다른 job 이나 workflow 가 이미 Pages 를 공개하고 있다면 Agent Note 는 standalone publish 를 건너뜁니다. docs site 와 Dashboard 를 합치려면 actions/upload-pages-artifact 앞의 같은 job 에 Agent Note 를 두세요.

보통 Dashboard 는 다음 URL 에 공개합니다.

  • https://<owner>.github.io/<repo>/dashboard/

예시:

  • https://wasabeef.github.io/AgentNote/dashboard/

새 리포지토리도 첫 공개 전까지 Dashboard 데이터 자체를 쌓을 수 있습니다. Pull Request Deploy 가 허용되어 있으면 첫 pull_request run 이 성공한 시점에 공유 Pages URL 이 생길 수 있습니다. 허용되어 있지 않으면 default branch 에서 첫 deploy 가 성공한 뒤에 URL 이 생깁니다.

  • refs/notes/agentnote 는 계속 Source of Truth 로 남습니다
  • Dashboard Mode 의 wasabeef/AgentNote@v1 가 note snapshot 을 gh-pages/dashboard/notes/*.json 에 씁니다
  • GitHub Pages 가 build 된 Dashboard 를 /dashboard/ 에서 제공합니다

리포지토리 자체에는 Dashboard 용 sample JSON 을 commit 하지 않습니다. 새 Dashboard 는 workflow 가 note file 을 복원하거나 생성할 때까지 비어 있습니다. pull_request 는 Open 상태를 공개하고, default branch 로의 push 는 이를 Merged 상태로 바꿉니다.

Dashboard 는 이제 단순히 데이터가 없다고만 말하지 않고, 확인할 원인을 함께 보여줍니다.

  • 데이터가 전혀 없음: Agent Note 를 켠 뒤 PR workflow 가 실행됐는지, Dashboard workflow 가 성공했는지, refs/notes/agentnote 가 push 됐는지 확인합니다.
  • ?pr=<number> 에 데이터가 없음: 해당 PR workflow 가 아직 실행되지 않았거나, GitHub Pages environment protection 이 Pull Request Deploy 를 막고 있거나, URL 의 PR 번호가 공개된 Dashboard data 와 맞지 않을 수 있습니다.
  • ?commit=<sha> 에 데이터가 없음: 해당 Commit 에 Agent Note entry 가 없거나, notes 가 아직 push 되지 않았거나, 다른 리포지토리의 SHA 일 수 있습니다.

페이지는 열리지만 비어 있다면 Troubleshooting 을 확인하세요.