kocolosk/couchxray

Couchxray is a command-line tool that scans a CouchDB database and tells you exactly which features it relies on. The main reason you'd reach for it is to figure out whether a database will work if you move it to a different version of CouchDB. Instead of guessing or discovering problems after a migration, you get a clear compatibility report upfront. You point the tool at your CouchDB service by providing a URL (with login credentials). If you include a specific database name in that URL, couchxray examines just that one database and gives you back a detailed JSON report. If you point it at the service without specifying a database, it scans every database and produces a CSV spreadsheet with one row per database. The report covers things like how many search indexes exist, whether the database is partitioned, which types of query indexes are in use, and whether older features like dbcopy or show/list functions appear. The output includes a "compatibility" section that flags whether the database can run on CouchDB 1.x, 2.x, 3.x, or 4.x. If a database isn't compatible with a given version, the report lists the specific features blocking it. For example, if a database uses Lucene-based search indexes, the tool will tell you that CouchDB 3 or higher is required, and that versions 1 and 2 won't work. This is most useful for teams planning a CouchDB upgrade or migration. Say you're moving a collection of databases from an older Cloudant-hosted setup to a self-hosted CouchDB 3 cluster, you'd run the tool across all your databases to see which ones are ready to move and which ones need attention first. It also reports practical details like document counts, disk usage, and shard recommendations, which help with capacity planning. The tool requires Node.js and installs as a global command, so it's lightweight to set up and run from any terminal.