volcengine/searchcli

0

/ 100

Documentation85
Engineering21
Health92
TypeScript710Apache-2.01d ago
Grade a repo

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

Documentation

85

README12pt70

README is present.

Install and run instructions9pt90

README documents how to install the project.

Contributing guide5pt97

Contributing guide is detailed and thorough.

License6pt100

Licensed under Apache-2.0.

Engineering

21

CI/CD14pt0

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.

Linting and formatting5pt0

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.

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.

Tests18pt35

Test files detected (scripts/search-tuning-field-context.test.ts).

Reproducibility6pt70

Lockfile present (package-lock.json). Installs are reproducible.

Project health

92

Dependency manifest6pt75

Dependency manifest found (package.json).

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)
  • 23
    Forks
  • 0
    Releases

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 710
    Watchers

Responsiveness

  • —
    Median issue response
  • <1h
    Median PR merge time
  • 0
    Open issues
Repository files27 root entries
  • bin
  • docs
  • examples
  • scripts
    Good: Test files detected (scripts/search-tuning-field-context.test.ts).
  • skills
  • src
  • .gitignore
    Good: .gitignore present.
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    Good: 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.
  • LICENSE
    Good: Licensed under Apache-2.0.
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • README.de_DE.md
    Good: 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.md
    Good: Security policy present.
  • tsconfig.json