DeepGraph

Getting started with DeepGraph

This guide takes you from a project to your first report, one step at a time.

  • You need: a web browser. For a sample or a public project, nothing else. For your private projects, sign in with GitHub, GitLab, or Bitbucket. For projects on your computer, any account works, including one made with your email.
  • Time: a few minutes. Samples open at once. A large project takes longer to read.

Prefer to watch? DeepGraph in 90 seconds shows a public project becoming a report, then people, teams, and comparisons. It opens on YouTube.

1. Add a project

Open the DeepGraph home page and pick one way in:

  • A sample: click Pocket Notes, Harbor Shop, or Meridian Platform under the project box. They are ready-made reports of made-up people, so no account is needed. A sample opens at once: skip to step 3.
  • A public project: paste its GitHub, GitLab, or Bitbucket link into the project box. A link to a file or folder inside it works too.
  • Your own projects: sign in, then pick from the projects you can access. For GitHub, install the DeepGraph GitHub App and choose the projects it may read. For GitLab, you need at least the Reporter role on a project to see its DORA numbers. For Bitbucket, if the DORA view asks you to, connect Bitbucket again so DeepGraph may read pull requests and pipelines.
  • A project on your computer: sign in, click the paperclip marked .git, and choose a folder. How local analysis works.
The project box with three projects added by their links. Click × on a chip to take a project out.

You should see: the project as a chip in the project box. Add more if you want to read several together.

2. Start the report

Click the arrow button in the project box. Progress shows around the box and beside each project.

You should see: your report open when it is ready. A larger history takes longer.

A ready report: totals at the top, then the chart. Point at a week for its numbers, or click it to see who worked.

3. Look at the people

The list shows everyone who saved changes, with their commits, lines added and removed, and files changed. A commit is one saved set of changes.

  • Search for a person and open their profile.
  • Switch between list and grid, and sort by any number.
  • If one person shows up twice, join their profiles (not in samples, which can't be changed).
The people of a sample web shop with their totals and a small chart of their work.

You should see: one profile per person, with their activity over time. More about contributor profiles.

4. Open a day

Pick a time range above the chart, then click a busy day. Select a person to see their commits that day, and open a commit to see what changed.

Try it here: click a day, then a person, then one of their commits.

You should see: the files and lines behind the totals. A big number may be a feature, a cleanup, or generated files. The changes tell you which. More about commit activity over time.

5. Group people into teams

On your own report, select a few people, choose New team, and drag teams into each other to match how you work. Samples can be read but not changed. Meridian Platform already has teams.

Teams with their totals, a small chart each, and the people in them.

You should see: each team's totals and a small chart of its work. More about teams.

6. Keep your reports

Sign in to keep your reports in the sidebar. Put related projects in folders.

  • Connected projects can update when changes reach their main branch, if your connection allows update notifications.
  • A public project added by its link has a Sync button next to its name.
  • Local projects update when you analyze them again.

New accounts get a 14-day Core trial with no payment details. See billing help and pricing.

If something is missing

  • A connected project is not listed: check that your account can access it. For GitHub, check which projects the DeepGraph GitHub App may read.
  • A local project is not found: make sure the folder holds the hidden .git folder and your browser can read it.
  • The DORA tab is empty: see why the DORA tab is empty.

Next steps