Agent Friendly Code

getnao/nao

GitHub
https://github.com/getnao/nao

👾 nao is the #1 open source agentic BI. (1) Create context with nao-core cli, (2) deploy nao chat interface for everyone

  • agentic-analytics
  • analytics
  • analytics-engineering
  • bigquery
  • business-intelligence
  • chat-with-your-data
  • context-engineering
  • data
  • data-analysis
  • data-analyst
  • data-engineering
  • databricks
  • postgresql
  • self-hosted
  • slack-bot
  • slackbot
  • snowflake
  • sql
  • text-to-sql
Stars:
2k
Language:
TypeScript
Default branch:
main
Last scored:
Overall

At a glance

Rank
#36 of 401
Top 9% · #6 of 82 TypeScript repos
Checks passed
10 of 17
Full list below
Best set up for
Claude Code
Score 92.8
Needs most work for
Aider
Biggest fix: .aider.conf.yml (+14.1 pts)

What it has

What it's missing

What to fix first

Pick an AI agent

Showing fixes for Claude Code

  1. 1
    Test suite
    Add a tests/ (or test/, __tests__/, spec/) directory with runnable tests. Document how to run them in AGENTS.md.
    +3.9 pts
  2. 2
    Manageable size
    If possible, split into smaller modules or carve out a focused entry path. Document where to start in AGENTS.md.
    +3.3 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 →

Claude Code
#19 of 401
92.8
  • ✓AGENTS.md / CLAUDE.md
  • ~Test suite
  • ✓Reproducible dev env
Codex
#35 of 401
88.7
  • ✓AGENTS.md / CLAUDE.md
  • ✓README
  • ~Test suite
Kimi Code CLI
#36 of 401
88.4
  • ✓AGENTS.md / CLAUDE.md
  • ~Test suite
  • ✓Dependency manifest
Pi
#39 of 401
87.7
  • ✓AGENTS.md / CLAUDE.md
  • ~Test suite
  • ✓Linter / formatter config
Devin
#33 of 401
84.9
  • ✓Reproducible dev env
  • ✓Dependency manifest
  • ~Test suite
OpenHands
#32 of 401
79.8
  • ✓CI configuration
  • ✓Dependency manifest
  • ✓Reproducible dev env
Cursor
#44 of 401
79.2
  • ✗Cursor rules (.cursor/rules)
  • ✓README
  • ✓Type configuration
Gemini CLI
#40 of 401
79.1
  • ✗GEMINI.md
  • ✓README
  • ~Test suite
Aider
#31 of 401
78.9
  • ✗.aider.conf.yml
  • ✓Linter / formatter config
  • ~Test suite

Does getnao/nao 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
AGENTS.md (new tab) · 3,028 characters
Agent-specific files
None: no GEMINI.md, .cursor/rules, .openhands/setup.sh, .aider.conf.yml or .agents/skills
Repos that have one
62 of 82 TypeScript repos · 221 of 401 repos on the leaderboard · See examples →

All 17 checks · 10 passed

Skills (.agents/skills)· 0% pass
No .agents/skills/<name>/SKILL.md
AGENTS.md / CLAUDE.md· 100% pass
Substantive (3,028 characters)
AGENTS.md
.aider.conf.yml· 0% pass
No .aider.conf.yml at repo root
CI configuration· 100% pass
13 GitHub Actions workflows
.github/workflows
CONTRIBUTING guide· 100% pass
Guide present
CONTRIBUTING.md
Cursor rules (.cursor/rules)· 0% pass
No .cursor/rules/*.mdc or .cursorrules
Dependency manifest· 100% pass
Manifest present
package.json
Reproducible dev env· 100% pass
2 env artifacts (Dockerfile, docker-compose.yml)
Dockerfile
GEMINI.md· 0% pass
No GEMINI.md at repo root
License file· 100% pass
License present
LICENSE
Linter / formatter config· 100% pass
Config detected
eslint.config.js
.openhands/setup.sh· 0% pass
No .openhands/setup.sh
Pre-commit / git hooks· 100% pass
Hook framework configured
.husky
README· 100% pass
README detailed (12,746 characters)
README.md
Manageable size· 50% pass
2934 files — large
Test suite· 70% pass
Test files detected (apps/backend/fastapi/test_main.py)
apps/backend/fastapi/test_main.py
Type configuration· 100% pass
Type config present
pyrightconfig.json

How getnao/nao compares

vs leaderboard average
17.6 pts above
Average 66.8
vs TypeScript average
13.2 pts above
Average 71.2
Stars among TypeScript repos
#77 of 82

Missing here, and how many repos have it

  • Skills (.agents/skills) · passed by 17% of leaderboard repos, 30% of TypeScript repos
  • Cursor rules (.cursor/rules) · passed by 4% of leaderboard repos, 13% of TypeScript repos

Passes checks most repos miss

  • Reproducible dev env · only 22% of repos pass it
  • Pre-commit / git hooks · only 29% of repos pass it

One fix for the most agents: Test suite would raise the score for all 9 agents, by up to 4.2 points.

Similar repos

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

All TypeScript repos →

Same topics, any language

Repos tagged with the same GitHub topics, most shared first.

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/getnao/nao
[![Agent Friendly](https://agentfriendlycode.com/api/badge/github/getnao/nao.svg)](https://agentfriendlycode.com/repo/github/getnao/nao)

Check the score on every pull request

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