https://github.com/tphakala/birdnet-go
Realtime BirdNET soundscape analyzer
https://github.com/tphakala/birdnet-go
alpinejs artificial-intelligence audio bioacoustics birdnet birdnet-pi birds birdweather contributions-welcome first-issue go golang help-wanted htmx linux raspberry-pi raspberrypi tailwindcss tensorflow wildlife
Last synced: 5 months ago
JSON representation
Realtime BirdNET soundscape analyzer
- Host: GitHub
- URL: https://github.com/tphakala/birdnet-go
- Owner: tphakala
- License: other
- Created: 2023-10-20T15:51:19.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-11T13:39:14.000Z (about 1 year ago)
- Last Synced: 2025-05-11T14:25:48.716Z (about 1 year ago)
- Topics: alpinejs, artificial-intelligence, audio, bioacoustics, birdnet, birdnet-pi, birds, birdweather, contributions-welcome, first-issue, go, golang, help-wanted, htmx, linux, raspberry-pi, raspberrypi, tailwindcss, tensorflow, wildlife
- Language: Go
- Homepage:
- Size: 134 MB
- Stars: 322
- Watchers: 19
- Forks: 31
- Open Issues: 52
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Support: support.sh
- Authors: AUTHORS
Awesome Lists containing this project
- open-sustainable-technology - BirdNET-Go - Realtime BirdNET soundscape analyzer. (Biosphere / Bioacoustics and Acoustic Data Analysis)
README
# BirdNET-Go
BirdNET-Go is an AI solution for continuous avian monitoring and identification
- 24/7 realtime bird song analysis of soundcard capture, analysis output to log file, SQLite or MySQL
- Utilizes BirdNET AI model trained with more than 6500 bird species
- Local processing, Internet connectivity not required
- Easy to use Web user interface for data visualisation
- Supports over 40 languages for species names
- Advanced features like [Deep Detection](doc/wiki/guide.md#deep-detection) for improved accuracy and [Live Audio Streaming](doc/wiki/guide.md#live-audio-streaming).
- BirdWeather.com API integration
- Realtime log file output can be used as overlay in OBS for bird feeder streams etc.
- Minimal runtime dependencies, BirdNET Tensorflow Lite model is embedded in compiled binary
- Provides endpoint for Prometheus data scraping
- Runs on Windows, Linux and macOS
- Low resource usage, works on Raspberry Pi 3 and equivalent 64-bit single board computers
## Installation
Quick install script for Debian, Ubuntu and Raspberry Pi OS based systems:
```bash
curl -fsSL https://github.com/tphakala/birdnet-go/raw/main/install.sh -o install.sh
bash ./install.sh
```
## Development Setup
For developers who want to contribute or build from source:
> See [CONTRIBUTING.md](CONTRIBUTING.md#step-1-install-task-runner) for more details.
```bash
# Clone the repository
git clone https://github.com/tphakala/birdnet-go.git
cd birdnet-go
# Install Task (if not already installed)
# Linux: sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b /usr/local/bin
# macOS: brew install go-task (assumes Homebrew is installed)
# Setup development environment (Linux apt-based or macOS with homebrew)
task setup-dev
# Build the project
task
# Start development server with hot reload
task dev_server # or "air realtime"
```
The `setup-dev` task will automatically install:
- Go 1.25
- Node.js LTS
- Build tools (gcc, git, wget, etc.)
- golangci-lint (Go linter)
- air (hot reload for Go)
- Frontend dependencies and Playwright browsers
## Web Dashboard
For detailed installation instructions, see the [installation documentation](doc/wiki/installation.md). For securing your BirdNET-Go installation, see the [security documentation](doc/wiki/security.md). See [recommended hardware](doc/wiki/hardware.md) for optimal performance.
There is more detailed usage documentation at [Wiki](doc/wiki/guide.md)
## Community
Join our [Discord server](https://discord.gg/gcSCFGUtsd) for support, discussions, and updates about BirdNET-Go!
## Related Projects
### Core & Extensions
- [BirdNET-Analyzer](https://github.com/birdnet-team/BirdNET-Analyzer) - Upstream project providing the BirdNET AI model for bird sound identification
- [BirdNET-Go Classifiers](https://github.com/tphakala/birdnet-go-classifiers) - Enhanced BirdNET classifiers including additional species
### System Integration
- [Cockpit BirdNET-Go](https://github.com/tphakala/cockpit-birdnet-go) - Web-based system management plugin for BirdNET-Go using Cockpit framework
### Migration Tools
- [BirdNET-Pi2Go](https://github.com/tphakala/birdnet-pi2go) - Database conversion tool for migrating from BirdNET-Pi to BirdNET-Go
### Hardware Solutions
- [BirdNET-Go ESP32 RTSP Microphone](https://github.com/Sukecz/birdnetgo-esp32-rtsp-mic) - ESP32-based RTSP streaming microphone for remote audio capture
- [ESP32 Audio Streamer](https://github.com/jpmurray/esp32-audio-streamer) - Alternative ESP32 RTSP streaming solution for BirdNET-Go audio input
## Contributing
**Want to contribute?** We welcome contributions from the community! 🎉
For comprehensive contributing guidelines, development setup, and workflow documentation, see [**CONTRIBUTING.md**](CONTRIBUTING.md).
### Quick Start for Contributors
**Experienced developers** can get started in 5 minutes:
```bash
git clone https://github.com/tphakala/birdnet-go.git && cd birdnet-go
task setup-dev # One command installs everything (Go, Node.js, tools, git hooks)
air realtime # Start developing with hot reload
```
**New to the project?** The [contributing guide](CONTRIBUTING.md) includes:
- 📋 [TL;DR Quick Start](CONTRIBUTING.md#tldr---quick-start-for-experienced-developers) - 5-minute setup
- 🔧 [Automated Environment Setup](CONTRIBUTING.md#development-environment-setup) - `task setup-dev` handles everything
- 📖 [Development Workflow](CONTRIBUTING.md#development-workflow) - Hot reload, git hooks, testing
- ⚖️ [License & Privacy](CONTRIBUTING.md#license-and-legal) - CC BY-NC-SA 4.0, privacy-by-design
- 💬 [Discord Community](https://discord.gg/gcSCFGUtsd) - Get help and discuss features
All contributions must follow:
- ✅ Privacy-by-design principles
- ✅ Code quality standards (automated via git hooks)
- ✅ CC BY-NC-SA 4.0 license terms
See [CONTRIBUTING.md](CONTRIBUTING.md) for complete details.
## Data Sources
### Taxonomy Data
BirdNET-Go includes embedded taxonomy data derived from the eBird/Clements Checklist:
- **Source**: [eBird API v2](https://api.ebird.org/v2/ref/taxonomy/ebird)
- **Copyright**: © Cornell Lab of Ornithology
- **License**: Used under eBird API Terms of Use for non-commercial purposes
- **Attribution**: Taxonomy data powered by [eBird.org](https://ebird.org)
- **Purpose**: Provides fast local genus/family lookups without requiring API calls
- **Coverage**: 2,374 genera, 254 families, 11,145 species
For more information about eBird's taxonomy, visit [eBird Taxonomy](https://ebird.org/science/use-ebird-data/the-ebird-taxonomy).
## License
Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International
## Authors
Tomi P. Hakala
Contributions by Hampus Carlsson, Jan Vrska, @twt--, @aster1sk, @hoover67
Please let me know if you are missing from contributors list!
BirdNET AI model by the K. Lisa Yang Center for Conservation Bioacoustics at the Cornell Lab of Ornithology in collaboration with Chemnitz University of Technology. Stefan Kahl, Connor Wood, Maximilian Eibl, Holger Klinck.
BirdNET label translations by Patrick Levin for BirdNET-Pi project by Patrick McGuire.