Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vaishnav-sabari-girish/arduino-cli-interactive
An Interactive way to use the arduino-cli
https://github.com/vaishnav-sabari-girish/arduino-cli-interactive
Last synced: 14 days ago
JSON representation
An Interactive way to use the arduino-cli
- Host: GitHub
- URL: https://github.com/vaishnav-sabari-girish/arduino-cli-interactive
- Owner: Vaishnav-Sabari-Girish
- License: apache-2.0
- Created: 2024-12-12T12:23:58.000Z (24 days ago)
- Default Branch: main
- Last Pushed: 2024-12-20T07:21:34.000Z (16 days ago)
- Last Synced: 2024-12-20T08:25:20.134Z (16 days ago)
- Language: Shell
- Size: 33.2 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
`
# Arduino Interactive CLI
This tool is made specifically for those who want to transition from the Arduino IDE to the CLI , but are still scared or intimidated by the command line.
## Installation
#### Via Homebrew
```bash
brew tap vaishnav-sabari-girish/arduino-cli-interactive
brew install aci
```
#### From source
```bash
git clone https://github.com/Vaishnav-Sabari-Girish/arduino-cli-interactive.git
cd bash_shell_script
chmod +x main.sh
./main.sh
```
### Pre-requisites
#### 1. `arduino-cli`
There are many ways to install arduino-cli. I recommend Homebrew , because all the other prerequisite tools are also available on homebrew.
##### Homebrew
In case you do not have Homebrew installed in your system
##### macOS/Linux
`/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
##### For windows users
Use Windows Subsystem for Linux (WSL) and follow the instructions for Linux.
To learn to use WSL , the best video is by [NetworkChuck](https://youtu.be/vxTW22y8zV8?si=mZ5w9KmT0A4_d7Zr)
After installing Homebrew , go to your terminal and just type this
```bash
brew update
brew install arduino-cli
```
##### Installing `arduino-cli` using the installation script
If you do not want to use homebrew , you can copy and paste this installation script
`curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | sh`
**NOTE** : This script is only for Linux/macOS/WSL users.
##### Using the Pre-built Binaries
You can also install the prebuilt binaries for Windows found [here](https://arduino.github.io/arduino-cli/1.1/installation/#latest-release)
Check out the `arduino-cli` documentation [here](https://arduino.github.io/arduino-cli/1.1/getting-started/)
#### 2. `gum`
`gum` is a tool developed by the company [Charm](https://charm.sh/) . Check out their gitHub at [Charm's GitHub](https://github.com/charmbracelet)
It makes it easy to create good looking Terminal User Interface (TUI)
To install `gum`
Using Package Managers
```bash
# macOS or Linux
brew install gum
# Arch Linux (btw)
pacman -S gum
# Nix
nix-env -iA nixpkgs.gum
# Flox
flox install gum
# Windows (via WinGet or Scoop) (Use Linux, or WSL instead of
directly installing in Windows)
winget install charmbracelet.gum
scoop install charm-gum
```
For more installation methods , refer the [GitHub repository of `gum`](https://github.com/charmbracelet/gum)
## Usage
Before stating to use `aci` , we need to install the cores required for the basic Arduino boards.
So , go to your terminal and the below commands
```bash
arduino-cli board listall
arduino-cli core install arduino:avr
```
Check out this asciinema Recording to know the basics of using `arduino-cli-interactive`
[](https://asciinema.org/a/SUQLo5g4TV0UL2v9YyBdpWuC3)
Incase asciinema doesn't work , see this
