bitterbot-ai/bitterbot-desktopNew scan
98/ 100 · A

A well-known project done right. Strong docs and solid engineering throughout.

A local-first AI agent with persistent memory, emotional intelligence, and a peer-to-peer skills economy.

TypeScript2,399 starsOtherupdated today

Outstanding work. A score of 98/100 puts this repo in a very small tier of truly well-engineered open source projects.

DocumentationREADME, setup, examples, license
98
EngineeringTests, CI, linting, lockfiles
98
Project healthDescription, activity, stars, deps
100

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

  2. 2
    Reproducibility
    EngineeringIssue

    Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.

  3. 3
    Reproducibility
    EngineeringInfo

    Use a multi-stage Dockerfile.

Detailed breakdown

Documentation

98
  • README100
    • README is present.
    • README is well structured with multiple sections.
    • README includes screenshots or visuals. Great for first impressions.
    • README has code examples.
    • README links to a live demo or deployed app.
    • README includes status badges.
  • Install and run instructions100
    • README documents how to install the project.
    • README documents how to run the project.
    • .env.example is present. Contributors can see exactly which env vars to set.
  • License100
    • Licensed under Other.
  • Contributing guide85
    • Contributing guide is detailed and thorough.
    • Contributing guide lacks a setup section (−12 pts).Show new contributors how to get a local dev environment running.
    • Contributing guide describes code style expectations.
    • Contributing guide lacks a testing section (−8 pts).Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    • Contributing guide describes the PR/review workflow.
    • Contributing guide includes code examples.
    • Code of conduct present.

Engineering

98
  • Tests100
    • Test files detected (benchmarks/arc-agi-3/kaggle/bitterbot_memory_py/tests).
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/ci.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI workflow runs a lint or format check.
    • CI runs type checking (tsc, mypy, cargo check, etc.).
    • Optional: report test coverage in CI.Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.
    • CI tests across multiple environments or versions.
    • CI includes a build step.
  • Linting and formatting100
    • Linter or formatter configured (.swiftlint.yml).
  • Reproducibility80
    • Lockfile present (pnpm-lock.yaml). Installs are reproducible.
    • Environment pinned via Dockerfile.
    • Consider using a multi-stage Dockerfile (builder + runtime stage) for smaller, more secure images.Use a multi-stage Dockerfile.
    • Dockerfile runs as a non-root user.
    • No Dependabot config (adding it earns up to +20 pts).Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

100
  • Dependency manifest100
    • Dependency manifest found (package.json).
    • package.json has a description field.
    • package.json links back to the repository.
  • Repository metadata100
    • Repository has a description.
    • Primary language detected: TypeScript.
    • package.json metadata is complete (description, keywords, repository).
  • Activity100
    • Actively maintained (pushed within the last month).
    • 2,399 stars.
  • Housekeeping100
    • .gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 419
    Forks
  • 1
    Releaseslatest 2mo ago

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 2,399
    Watchers

Responsiveness

  • 14h
    Median issue response
  • <1h
    Median PR merge time
  • 2
    Open issues
Repository files57 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Issue or PR templates present.
  • benchmarks
    Good: Test files detected (benchmarks/arc-agi-3/kaggle/bitterbot_memory_py/tests).
  • deploy
  • desktop
  • docs
  • extensions
  • git-hooks
  • orchestrator
  • scripts
  • skills
  • src
  • test
  • vendor
  • .detect-secrets.cfg
  • .dockerignore
  • .env.example
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .markdownlint-cli2.jsonc
  • .npmrc
  • .oxfmtrc.jsonc
  • .oxlintrc.json
  • .pre-commit-config.yaml
  • .secrets.baseline
  • .shellcheckrc
  • .swiftformat
  • .swiftlint.yml
    Good: Linter or formatter configured (.swiftlint.yml).
  • AGENTS.md
  • bitterbot.mjs
  • bitterbot.podman.env
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    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.
    Good: Contributing guide describes code style expectations.
    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).
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • docker-compose.yml
  • docker-setup.sh
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • Dockerfile.sandbox
  • Dockerfile.sandbox-browser
  • Dockerfile.sandbox-common
  • how-the-memory-works.md
  • LICENSE
    Good: Licensed under Other.
  • package.json
    Good: Dependency manifest found (package.json).
  • pnpm-lock.yaml
    Good: Lockfile present (pnpm-lock.yaml). Installs are reproducible.
  • pnpm-workspace.yaml
  • README.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.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • SECURITY.md
    Good: Security policy present.
  • self_harness_integration_study.md
  • setup-podman.sh
  • tsconfig.json
  • tsconfig.plugin-sdk.dts.json
  • tsconfig.test.json
  • tsdown.config.ts
  • vitest.config.ts
  • vitest.e2e.config.ts
  • vitest.extensions.config.ts
  • vitest.gateway.config.ts
  • vitest.live.config.ts
  • vitest.unit.config.ts