Overview

A template for automatically setting up a PlatformIO + Arduino development environment.

Setting up Clangd LSP to work with PlatformIO can be very finicky, this repo also tries to automate that.

Showcase.mp4

⭐ If you find this project useful, consider starring the original repo to help it gain visibility! A start for me would also be appreciated (˶ᵔ ᵕ ᵔ˶)

Features

• Clangd LSP support.
• Included Makefile for common actions.
• Fancy wizard for automatic project creation.

How to use

Automatic

1. Run the setup wizard

/bin/bash -c "$(curl -sSL https://raw.githubusercontent.com/PolyCatDev/clangd-platformio/refs/heads/main/wizard.sh)"

2. Keep It Up to Date

Every time you modify project libraries or config:

make updatedb

Manual

1. Clone the repo

git clone https://github.com/PolyCatDev/clangd-platformio <project-name>
cd <project-name>

2. Remove git repo and wizard script

rm -rf .git wizard.sh

3. Initialize the project

pio init --ide vim --board <board-id>

4. Run Python script to generate compile_commands.json

python3 conv.py

5. Keep It Up to Date

Every time you modify project libraries or config:

make updatedb