Documentation
Everything you need to get started with DevSignal — from setup to generating your first report.
Getting Started
DevSignal pulls a developer's recent GitHub activity — pull requests, code reviews, issues, and commits — and uses AI to generate a structured report with analysis and actionable insights.
Reports can be used for 1:1 meetings, performance reviews, sprint retrospectives, self-reflection, or any context where you need a clear picture of what someone has been working on.
Quick start
- Sign up — Create an account with your GitHub login at app.devsignal.app/signup.
- Install the GitHub App — An org owner (or your personal account) needs to install the DevSignal GitHub App. This is what gives DevSignal read access to activity data. See Installing the GitHub App below.
- Select your org — On first login, you'll pick which organization or personal account to work with.
- Generate a report — Pick a developer, timeframe, and optionally scope to specific repos. Hit Run and your report generates in about 15 seconds.
Installing the GitHub App
DevSignal uses a GitHub App to read activity data from your repositories. The app requests read-only access — it never writes to your repos, creates issues, or modifies anything.
Important: The GitHub App must be installed by an owner of the organization. If you're a member or outside collaborator, ask your org admin to install it. Members and collaborators can use DevSignal once the owner has installed the app on the org.
For organization owners
- Go to Settings → Integrations in DevSignal.
- Click “Add another Org/Account” — this opens the GitHub App installation page.
- Select the organization you want to connect and approve the permissions.
- Once installed, all members of that org can sign in to DevSignal and generate reports.
For personal accounts
You can install the app on your personal GitHub account to generate reports about your own activity across personal repos. Follow the same steps above — just select your personal account instead of an org.
What the app can access
- Pull requests, reviews, and review comments
- Issues and issue comments
- Commits and commit messages
- Repository metadata (names, visibility)
- Organization membership (to populate the contributor list)
DevSignal never stores your source code. It only reads activity metadata (titles, descriptions, comments) to generate reports.
Generating Reports
The main screen has a compact query bar where you configure your report. Here's what each field does:
The GitHub user whose activity you want to analyze. The dropdown shows all members of the selected org. Start typing to search by name or username.Look for the green-highlighted field — that's your starting point.
How far back to look. Choose from preset periods (7, 14, 21, or 28 days) or pick custom start/end dates.
Optionally scope the report to specific repositories. Leave blank to include all repos in the org. You can select multiple.
DevSignal automatically adapts the report based on who you're generating it for. Running a report on yourself produces a personal recap written in second person (“you”/“your”) with a growth-oriented tone. Running it on a teammate produces a third-person professional summary — great for managers prepping for 1:1s or staying in sync with the team.
Click Run (or press Enter) to generate the report. Generation typically takes 10–20 seconds depending on the volume of activity.
Saving and sharing
Every report is automatically saved and appears in Recent Reports in the sidebar. You can also:
- Copy to clipboard — Pastes cleanly into Google Docs, Notion, Slack, or email with formatting preserved.
- Download as PDF — Opens a print dialog. Choose “Save as PDF” for a clean, styled document.
Understanding Reports
Reports have two parts: AI-generated analysis at the top, and a raw Activity Log at the bottom.
Report sections
DevSignal generates a Developer Activity report. Both self-reports and teammate reports use the same sections — the only difference is tone (second person “you/your” for self-reports, third person for teammates).
Tip: Running reports on your teammates is a great way to stay in sync before 1:1s or sprint reviews. Running them on yourself gives you a personal recap to track your own momentum and growth.
Activity Log
The bottom of every report includes a raw Activity Log — a structured list of all PRs, reviews, issues, and commits that were analyzed. This is generated directly from GitHub data (not AI), so it's always accurate. Each item links back to GitHub.
Smart Search
Smart Search lets you ask questions across your existing reports using natural language. It's like having a conversation about your team's recent activity.
How it works
- Navigate to Smart Search in the sidebar.
- Type a question or click one of the suggestion cards.
- DevSignal searches your recent reports for the current org and uses AI to answer your question.
- Ask follow-up questions in the same conversation.
Example questions
- “Summarize team activity from the last week”
- “Who has been most active recently?”
- “Which PRs had the most discussion?”
- “What issues or risks have been flagged?”
- “What are the key themes across recent reports?”
Smart Search uses your saved reports as context — the more reports you've generated, the richer the answers.
Organizations & Access
DevSignal works with GitHub organizations, personal accounts, and individual repositories. Here's how access works for each.
Your Organizations
These are GitHub orgs where you are a member. Your personal account also appears here. When you select an org, the developer list shows all org members, and repos show all org repos.
Outside Collaborator orgs
If you're an outside collaborator on another user's account or org (meaning they've installed the GitHub App and granted you access to specific repos), those appear separately. You'll see repos you have access to, not the full org.
Who needs to install the app? The owner of the org or account installs the GitHub App. Once installed, any member or collaborator with a DevSignal account can sign in and generate reports for that org. You don't need to install the app yourself if someone else already has.
Switching organizations
Click the org name at the top of the sidebar to open the org picker. Your selection is saved — next time you log in, you'll be right where you left off.
Manual entry & open source repos
The org picker includes a Manual Entry option where you can type any owner/repo path directly. This is especially useful for open source repositories — you can generate a report for any contributor on any public repo, even if you don't own it and don't have the GitHub App installed there.
For example, entering facebook/react lets you generate a report for any React contributor. The developer list shows that repo's collaborators and the repo field is locked to that single repo.
No GitHub App installation is required for public repos — manual entry works with any repo you can see on GitHub.
Settings
Access Settings from the sidebar. There are three sections:
Integrations
View and manage your GitHub App installations. You can see which orgs and accounts are connected, and add new ones. Removing an installation is done from GitHub's settings (the link is provided).
Usage
Track your token usage for the current billing period. Shows a usage bar, number of reports generated this period, total lifetime reports, and when your usage resets.
Account
View your profile (GitHub avatar, name, username), your GitHub email, and an optional contact email. The “Danger Zone” section allows you to permanently delete your account and all associated data.
Troubleshooting
“GitHub disconnected” message
Your GitHub session expires after 8 hours. When this happens, you'll see a reconnect prompt. Click it to re-authenticate — your form state and selected org are preserved.
Report says “No activity found”
This means the developer had no PRs, reviews, issues, or commits in the selected timeframe and repos. Try expanding the timeframe or removing the repo filter to search across all org repos.
Developer not showing in the dropdown
The developer list comes from GitHub's org membership API. If someone is missing, they may not be a member of the selected org. Check that you're in the right org, or try repo mode (owner/repo) which shows that repo's collaborators instead.
Org not appearing in the picker
The org picker shows organizations where the DevSignal GitHub App is installed. If your org doesn't appear, ask the org owner to install the app. See Installing the GitHub App.
Report seems incomplete
Reports are scoped to the repos visible to the DevSignal GitHub App. If the app was installed with access to only some repos (not “All repositories”), activity in excluded repos won't appear. The org owner can update this in GitHub under Settings → GitHub Apps → DevSignal → Configure.
Smart Search returns thin answers
Smart Search works from your saved reports. If you've only generated one or two reports, there isn't much context to draw from. Generate more reports across different developers and timeframes to get richer search results.
Still need help? Reach us at hello@devsignal.app