brevdev/brev-cli
Grade a repo

84

/ 100

GradeB

Good shape overall. A few tweaks would push it into the top tier.

Top 24% of 5,156 graded repos

Connect your laptop to cloud computers. Follow to stay updated about our product

Documentation68
Engineering88
Health100
Go263MIT1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

10 to address
  1. 1
    README12pt

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

  2. 2
    README12pt

    Add CI/build status badges from shields.io or your CI provider to signal project health.

  3. 3
    Install and run instructions9pt

    Add a section showing how to start or use the project.

  4. 4
    Install and run instructions9pt

    Add a .env.example listing all required environment variables so contributors know what to set up.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

68

Install and run instructions9pt45

README documents how to install the project.

Contributing guide5pt69

Contributing guide is detailed and thorough.

README12pt70

README is present.

License6pt100

Licensed under MIT.

Engineering

88

Issue and PR templates6pt0

No issue or PR templates found (−100 pts).

→ Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.

Tests18pt100

Test files detected (e2etest/setup/setup_test.go).

CI/CD14pt100

CI is configured (.github/workflows/build.yml).

Linting and formatting5pt100

Formatting enforced (.golangci.yml).

Reproducibility6pt100

Lockfile present (go.sum). Installs are reproducible.

Project health

100

Dependency manifest6pt100

Dependency manifest found (go.mod).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 37
    Forks
  • 272
    Releaseslatest 4y ago

Community

  • 62% - Fair
    Community health
  • 2 bus factor
    authors own >50% of commits
  • 263
    Watchers

Responsiveness

  • 10h
    Median issue response
  • <1h
    Median PR merge time
  • 97
    Open issues
Repository files33 root entries
  • .agents
  • .brev
    Good: .gitignore present.
  • .devcontainer
    Good: Environment pinned via .devcontainer/Dockerfile.
  • .direnv
  • .github
    Good: CI is configured (.github/workflows/build.yml).
    Good: Dependabot covers 3 ecosystems (gomod, gomod, github-actions). Dependencies stay current.
  • .vscode
  • assets
  • bin
  • docs
    Good: Contributing guide is detailed and thorough.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Good: Contributing guide includes code examples.
  • e2etest
    Good: Test files detected (e2etest/setup/setup_test.go).
  • flake-explorations
  • pkg
  • scripts
  • tools
  • .gitattributes
  • .gitignore
  • .golangci.yml
    Good: Formatting enforced (.golangci.yml).
  • .goreleaser.yml
  • .projectile
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CODEOWNERS
  • Dockerfile
  • flake.lock
  • flake.nix
  • go.mod
    Good: Dependency manifest found (go.mod).
  • go.sum
    Good: Lockfile present (go.sum). Installs are reproducible.
  • LICENSE
    Good: Licensed under MIT.
  • main.go
  • Makefile
  • prod_lite.env
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.
    Good: README documents how to install the project.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • shell.nix
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/brevdev/brev-cli)](https://www.repo-grade.com/report/brevdev/brev-cli)

More graded Go repos