https://github.com/raghur/zsh-arduino
zsh plugin for arduino build, upload and monitor
https://github.com/raghur/zsh-arduino
Last synced: 7 months ago
JSON representation
zsh plugin for arduino build, upload and monitor
- Host: GitHub
- URL: https://github.com/raghur/zsh-arduino
- Owner: raghur
- License: mit
- Created: 2020-09-30T06:37:41.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-09T02:14:03.000Z (almost 2 years ago)
- Last Synced: 2025-04-30T21:54:51.271Z (7 months ago)
- Language: Shell
- Size: 11.7 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-zsh-plugins - arduino - Adds scripts to build, upload and monitor arduino sketches from a command line. Requires [`jq`](https://stedolan.github.io/jq/). (Plugins / ZSH on Windows)
- fucking-awesome-zsh-plugins - arduino - Adds scripts to build, upload and monitor arduino sketches from a command line. Requires 🌎 [`jq`](stedolan.github.io/jq/). (Plugins / ZSH on Windows)
README
## Arduino plugin - Very WIP - you've been warned
Build, upload and monitor arduino sketches from zsh. Reuses `.vscode/arduino.json` if available else you can set env vars.
## Usage
1. In a sketch folder, run `ar_build`
- If you have `.vscode/arduino.json`, then all flags - esp `fqbn` is pulled in from there.
2. Setting compile time vars
- `ar_build stm32-nrf24tx02.ino --build-properties='compiler.cpp.extra_flags=-DDEBUG`
3. You can just run `ar_upload` directly - if a binary (`AR_BIN`) isn't set, then it will build & upload
- to force build, use `ar_build; ar_upload`
### Needs
1. [arduino-cli](https://github.com/arduino/arduino-cli)
2. `jq` - sudo apt install jq
### Setup
#### zplug
* `zplug "raghur/zsh-arduino"`
#### Manual - Git
1. clone this somewhere in your $FPATH
2. Source `plugin.zsh` from your startup scripts
2. In your sketch folder, following are available
- `ar_build`, `ar_upload`, `ar_env`, `ar_serial`