55
/ 100
Popular for its size, but the engineering basics lag behind the interest.
Open CLI for integrating AI search, recommendation, and conversational retrieval into agent systems and business systems
A low grade is a to-do list, not a judgment of your code
Most gaps here are documentation, tests, and setup, not the code itself. Closing your top 3 gaps alone would lift this repo to B (85).
See your top fixesTop fixes
Highest-impact changes first, ranked by point weight
- 1Tests18pt
Set scripts.test in package.json to your actual test command, e.g. "vitest" or "jest".
- 2CI/CD14pt
If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.
- 3README12pt
Link to a deployed version, docs site, or demo video. Users want to see it running.
- 4README12pt
Add CI/build status badges from shields.io or your CI provider to signal project health.
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.
Scorecard
Every check, grouped by category and sorted worst-first
Documentation
85
README is present.
README documents how to install the project.
Contributing guide is detailed and thorough.
Licensed under Apache-2.0.
Engineering
21
No CI configuration detected in this repository.
→ If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.
No linter or formatter found.
→ Add ESLint (eslint.config.js) and/or Prettier (.prettierrc), install them as devDependencies, and add a `lint` script to package.json.
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.
Test files detected (scripts/console-schema-inference.test.ts).
Lockfile present (package-lock.json). Installs are reproducible.
Project health
92
Dependency manifest found (package.json).
Repository has a description.
Actively maintained (pushed within the last month).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- 118 / 147Commits (30d / 90d)
- 24Forks
- 0Releases
Community
- 75% - GoodCommunity health
- 1 bus factorlowauthor own >50% of commits
- 744Watchers
Responsiveness
- -Median issue response
- <1hMedian PR merge time
- 0Open issues
Repository files27 root entries
- bin
- docs
- examples
- scriptsGood: Test files detected (scripts/console-schema-inference.test.ts).
- skills
- src
- .gitignoreGood: .gitignore present.
- CODE_OF_CONDUCT.mdGood: Code of conduct present.
- CONTRIBUTING.mdGood: Contributing guide is detailed and thorough.Good: Contributing guide includes setup/install instructions.Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.Good: Contributing guide explains how to run tests.Good: Contributing guide describes the PR/review workflow.Good: Contributing guide includes code examples.
- LICENSEGood: Licensed under Apache-2.0.
- package-lock.jsonGood: Lockfile present (package-lock.json). Installs are reproducible.
- package.jsonGood: Dependency manifest found (package.json).
- README.de_DE.mdGood: README is present.Good: README is well structured with multiple sections.Good: README includes screenshots or visuals. Great for first impressions.Good: README has code examples.Issue: No live demo link in the README (−20 pts).Fix: Link to a deployed version, docs site, or demo video. Users want to see it running.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.Good: README documents how to run the project.
- README.es_ES.md
- README.fr_FR.md
- README.id_ID.md
- README.it_IT.md
- README.ja_JP.md
- README.ko_KR.md
- README.md
- README.pt_BR.md
- README.ru_RU.md
- README.th_TH.md
- README.tr_TR.md
- README.zh_CN.md
- SECURITY.mdGood: Security policy present.
- tsconfig.json
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/volcengine/searchcli)