https://github.com/skitsanos/espidf-app-builder
CLI utility for creating ESP-IDF apps
https://github.com/skitsanos/espidf-app-builder
cli cli-app esp-idf esp32
Last synced: 2 months ago
JSON representation
CLI utility for creating ESP-IDF apps
- Host: GitHub
- URL: https://github.com/skitsanos/espidf-app-builder
- Owner: skitsanos
- License: mit
- Created: 2018-12-04T16:51:02.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2026-03-02T07:11:04.000Z (4 months ago)
- Last Synced: 2026-03-02T11:46:03.360Z (4 months ago)
- Topics: cli, cli-app, esp-idf, esp32
- Language: JavaScript
- Size: 312 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# espidf-app-builder
CLI utility for creating ESP-IDF apps
### Installation
Clone to your drive
```ssh
git clone https://github.com/skitsanos/espidf-app-builder.git
```
Install dependencies
```ssh
cd espidf-app-builder
npm install
```
Once dependencies installed, you need to link. The npm link command allow us to locally ‘symlink a package folder’, and for our needs, it will locally install any command listed in the bin field of our package.json. In other words, npm link is like a NodeJS package installation simulator. It is worth to mention that npm link has a wider usage that exceeds the scope of this guide
```ssh
sudo npm link
```
Now you can run it by typing _esp32app_. Add --help to learn on command line arguments required
```
esp32app --help
```
### Command line arguments
```
Usage: esp32app -name -path
Options:
-v, --version output the version number
-a, --app application name
-p, --path path where application will be created
-h, --help output usage information
```
Will create a directory structure and minimal set of files required for ESP-IDF appplication:
```
├─ /components
├─ /main
├─── app.c
├─── component.mk
├─ CMakeLists.txt
├─ Makefile
```
After application structure created, don't forget to run config
```
make menuconfig
```
### Setting OSX Finder Quick Action with Automator
```sh
if [ -x /usr/libexec/path_helper ]; then
eval `/usr/libexec/path_helper -s`
fi
if [ -f "$HOME"/.profile ]; then
source "$HOME"/.profile
elif [ -f "$HOME"/.bash_profile ]; then
source "$HOME"/.bash_profile
elif [ -f "$HOME"/.bashrc ]; then
source "$HOME"/.bashrc
fi
esp32app --app $1 --path $2
```