Experienced Developer Quick Start - commaai/openpilot GitHub Wiki

This is an abbreviated version for experienced developers

SSH

1. Add your public key to Github
2. Enable SSH in the comma settings & add your GitHub username via Settings -> Developer -> GitHub Username
3. SSH into your comma using the key published on GitHub. NOTE: Must be LAN, SSH is inaccessible from WAN
   • For C2: SSH as root user ssh [email protected]
   • For C3: SSH as comma user ssh [email protected]

Making Changes

1. The openpilot install is housed in /data/openpilot. The code can be modified in place, reboot after changes to see new changes.
2. The official release branch is release3 for the comma3 and release2 for the comma2, which comes with precompiled binaries, but most branches do not have binaries. Other interesting branches include master (latest), master-ci (latest + submodules), devel, and devel-staging
3. Binaries are compiled at boot time assuming they aren't already supplied by the branch (device will take 20+ minutes to boot). To monitor the build, ssh in and attach to the tmux session via tmux a
4. Keep in mind that at the time of writing /cereal, /laika_repo, /opendbc, /panda, /rednose_repo, /laika, and /rednose are all submodules. If you wipe /data/openpilot and clone fresh be sure to issue the command git submodule update --init --recursive after cloning for a successful build.