Skip to content

Latest commit

 

History

History
128 lines (77 loc) · 3.11 KB

README.md

File metadata and controls

128 lines (77 loc) · 3.11 KB
Raw

Bash Script`

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

brew tap vaishnav-sabari-girish/arduino-cli-interactive
brew install aci

From source

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


After installing Homebrew , go to your terminal and just type this

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

Check out the arduino-cli documentation here

2. gum

gum is a tool developed by the company Charm . Check out their gitHub at Charm's GitHub

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

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

arduino-cli board listall
arduino-cli core install arduino:avr

To Uninstall

brew uninstall aci 
brew untap vaishnav-sabari-girish/arduino-cli-interactive

Refer the below recording to see it in action

action

Documentation short URL

https://1pt.co/aci-docs