facebookresearch/faiss

GitHub
https://github.com/facebookresearch/faiss

A library for efficient similarity search and clustering of dense vectors.

Stars:
41.3k
Language:
C++
Default branch:
main
Last scored:
Overall

At a glance

Rank
#311 of 401
#15 of 21 C++ repos
Checks passed
7 of 17
Full list below
Best set up for
Aider
Score 62.3
Needs most work for
Cursor
Biggest fix: Cursor rules (.cursor/rules) (+11.5 pts)

What it has

What it's missing

What to fix first

Pick an AI agent

Showing fixes for Claude Code

  1. 1
    AGENTS.md / CLAUDE.md
    Add an AGENTS.md covering project goals, layout, setup commands, and conventions. Aim for 800+ chars of real guidance (not boilerplate).
    +13.2 pts
  2. 2
    Reproducible dev env
    Add a Makefile or devcontainer or Dockerfile so the agent can set up the project in one command.
    +11.8 pts
  3. 3
    Type configuration
    Add a type config (tsconfig.json for JS/TS, mypy.ini or pyrightconfig.json for Python). Rust/Go/JVM/Scala/Swift/C#/OCaml/Haskell/Zig are typed by default.
    +7.9 pts

Score for each AI agent

Each agent weighs the checks by its own docs. Under each score are its top three. How each agent is scored →

Aider
#232 of 401
62.3
  • ✗.aider.conf.yml
  • ✓Linter / formatter config
  • ✓Test suite
Claude Code
#316 of 401
60.5
  • ✗AGENTS.md / CLAUDE.md
  • ✓Test suite
  • ✗Reproducible dev env
Codex
#319 of 401
59.5
  • ✗AGENTS.md / CLAUDE.md
  • ✓README
  • ✓Test suite
Devin
#313 of 401
59.3
  • ✗Reproducible dev env
  • ✓Dependency manifest
  • ✓Test suite
Pi
#306 of 401
58.7
  • ✗AGENTS.md / CLAUDE.md
  • ✓Test suite
  • ✓Linter / formatter config
OpenHands
#281 of 401
58.6
  • ✓CI configuration
  • ✓Dependency manifest
  • ✗Reproducible dev env
Kimi Code CLI
#315 of 401
57.6
  • ✗AGENTS.md / CLAUDE.md
  • ✓Test suite
  • ✓Dependency manifest
Gemini CLI
#322 of 401
54.3
  • ✗GEMINI.md
  • ✓README
  • ✓Test suite
Cursor
#322 of 401
53.1
  • ✗Cursor rules (.cursor/rules)
  • ✓README
  • ✗Type configuration

Does facebookresearch/faiss have agent instructions?

An AGENTS.md (or CLAUDE.md) at the root tells AI coding agents how to build, test and work in the repo. A few agents also read a file of their own.

AGENTS.md / CLAUDE.md
None at the root (no AGENTS.md, CLAUDE.md, AGENT.md, .claude/CLAUDE.md or .claude/AGENTS.md)
Agent-specific files
None: no GEMINI.md, .cursor/rules, .openhands/setup.sh, .aider.conf.yml or .agents/skills
Repos that have one
10 of 21 C++ repos · 221 of 401 repos on the leaderboard · See examples →
Get a starter AGENTS.md

From the files the checks found. Fill in the commands, then commit it at the root.

# AGENTS.md

Guidance for AI coding agents working in facebookresearch/faiss. A library for efficient similarity search and clustering of dense vectors. Written mainly in C++.

## Where things are

- Dependencies are declared in `pyproject.toml`.
- Tests live in `tests`.
- Lint and format rules are configured in `.clang-format`.
- CI is defined in `.github/workflows`; read it for the exact install, lint and test steps.
- Follow the conventions in `CONTRIBUTING.md`.

## Commands

<!-- Fill in the exact commands CI runs. -->
- Install: TODO
- Test: TODO
- Lint: TODO

All 17 checks · 7 passed

No .agents/skills/<name>/SKILL.md
No agent instructions file found
.aider.conf.yml· 0% pass
No .aider.conf.yml at repo root
CI configuration· 100% pass
11 GitHub Actions workflows
CONTRIBUTING guide· 100% pass
Guide present
No .cursor/rules/*.mdc or .cursorrules
Manifest present
No Makefile / devcontainer / Docker / equivalent found
GEMINI.md· 0% pass
No GEMINI.md at repo root
License file· 100% pass
License present
Config detected
No .openhands/setup.sh
No pre-commit / husky / lefthook found
README· 100% pass
README detailed (6,363 characters)
Manageable size· 80% pass
1166 files
Test suite· 100% pass
Found /tests
No type config found

How facebookresearch/faiss compares

vs leaderboard average
8.6 pts below
Average 66.8
vs C++ average
1.1 pts below
Average 59.3
Stars among C++ repos
#10 of 21

Missing here, and how many repos have it

  • Type configuration · passed by 68% of leaderboard repos, 24% of C++ repos
  • Pre-commit / git hooks · passed by 29% of leaderboard repos, 29% of C++ repos
  • Reproducible dev env · passed by 22% of leaderboard repos, 10% of C++ repos

One fix for the most agents: AGENTS.md / CLAUDE.md would raise the score for all 9 agents, by up to 13.3 points.

Similar repos

Same language and host as this repo, closest in overall score.

All C++ repos →

Add a badge to your README

Paste this at the top of the README. It shows the score, and links back to this page.

Agent friendly score for github/facebookresearch/faiss
[![Agent Friendly](https://agentfriendlycode.com/api/badge/github/facebookresearch/faiss.svg)](https://agentfriendlycode.com/repo/github/facebookresearch/faiss)

Check the score on every pull request

A GitHub Action posts one comment per pull request with how the score changed and why.