BirdNET-Go is an AI solution for continuous avian monitoring and identification
Quick install script for Debian, Ubuntu and Raspberry Pi OS based systems:
curl -fsSL https://github.com/tphakala/birdnet-go/raw/main/install.sh -o install.sh
bash ./install.sh
For developers who want to contribute or build from source:
See CONTRIBUTING.md for more details.
# 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:
For detailed installation instructions, see the installation documentation. For securing your BirdNET-Go installation, see the security documentation. See recommended hardware for optimal performance.
There is more detailed usage documentation at Wiki
Join our Discord server for support, discussions, and updates about BirdNET-Go!
Want to contribute? We welcome contributions from the community! 🎉
For comprehensive contributing guidelines, development setup, and workflow documentation, see CONTRIBUTING.md.
Experienced developers can get started in 5 minutes:
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 includes:
task setup-dev
handles everythingAll contributions must follow:
See CONTRIBUTING.md for complete details.
Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International
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.