-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
575ede9
commit 19d377d
Showing
5 changed files
with
110 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
book |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
[book] | ||
authors = ["vaishnav_sabari_girish"] | ||
language = "en" | ||
multilingual = false | ||
src = "src" | ||
title = "Arduino-CLI Interactive (aci)" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
![Bash Script](https://img.shields.io/badge/bash_script-%23121011.svg?style=for-the-badge&logo=gnu-bash&logoColor=white)` | ||
|
||
![Rust](https://img.shields.io/badge/rust-%23000000.svg?style=for-the-badge&logo=rust&logoColor=white) | ||
|
||
|
||
# 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. | ||
|
||
### 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 [NetwokChuck](https://youtu.be/vxTW22y8zV8?si=mZ5w9KmT0A4_d7Zr) | ||
|
||
<br> | ||
|
||
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 in 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) | ||
|
||
#### 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` | ||
|
||
<details> | ||
<summary>Using Package Managers</summary> | ||
|
||
```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 | ||
``` | ||
</details> | ||
|
||
For more installation methods , refer the [GitHub repository of `gum`](https://github.com/charmbracelet/gum) | ||
|
||
## Usage | ||
|
||
Check out this asciinema Recording to know the basics of using `arduino-cli-interactive` | ||
|
||
[![asciinema Recording](https://asciinema.org/a/MrsJQejlak5mpzRrQuydKXH1W.svg)](https://asciinema.org/a/MrsJQejlak5mpzRrQuydKXH1W) | ||
|
||
Incase asciinema doesn't work , see this | ||
|
||
![VHS Recording](https://vhs.charm.sh/vhs-5e3yO2e4MhtHZsbfJk6fPt.gif) | ||
|
||
|
||
## Stargazers over time | ||
[![Stargazers over time](https://starchart.cc/Vaishnav-Sabari-Girish/arduino-cli-interactive.svg?variant=adaptive)](https://starchart.cc/Vaishnav-Sabari-Girish/arduino-cli-interactive) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Summary | ||
|
||
[Introduction](README.md) | ||
|
||
- [Chapter 1](./chapter_1.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Chapter 1 |