https://github.com/dankeboy36/get-arduino-tools
Get Arduino Tools (`gat`) is a CLI that helps you easily download various Arduino tools
https://github.com/dankeboy36/get-arduino-tools
Last synced: 17 days ago
JSON representation
Get Arduino Tools (`gat`) is a CLI that helps you easily download various Arduino tools
- Host: GitHub
- URL: https://github.com/dankeboy36/get-arduino-tools
- Owner: dankeboy36
- License: mit
- Created: 2025-01-18T10:29:09.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-01-21T09:59:57.000Z (9 months ago)
- Last Synced: 2025-01-21T10:34:32.841Z (9 months ago)
- Language: JavaScript
- Homepage:
- Size: 12.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# get-arduino-tools
Get Arduino Tools (`gat`) is a CLI that helps you easily download various Arduino tools
> This library simplifies obtaining essential tools for developing with the [Arduino CLI's gRPC API](https://arduino.github.io/arduino-cli/latest/rpc/commands/). **Note that this is not a new feature of Arduino**, but a tool to enhance the existing development experience. By streamlining the download of tools like the Arduino CLI, language server, and clang tools, `gat` reduces setup time and lets developers focus on their projects without installation complexities. With `gat`, developers can quickly maximize productivity.
## Tools
- [Arduino CLI](https://github.com/arduino/arduino-cli)
- [Arduino Language Server](https://github.com/arduino/arduino-language-server)
- [Arduino Firmware Uploader](https://github.com/arduino/arduino-fwuploader)
- [Arduino Lint](https://github.com/arduino/arduino-lint)
- [`clangd`](https://github.com/arduino/clang-static-binaries)
- [`clang-format`](https://github.com/arduino/clang-static-binaries)
## Installation
To install the `gat` CLI globally:
```bash
npm install -g get-arduino-tools
```
## Usage
### CLI
You can use `gat` to download Arduino tools with the following command:
```bash
gat get [options]
```
#### Arguments
- ``: The tool you want to download. Can be one of: `arduino-cli`, `arduino-language-server`, `arduino-fwuploader`, `arduino-lint`, `clangd`, `clang-format`.
- ``: The version of the tool you want to download.
#### Options
- `-d, --destination-folder-path `: Destination folder path (default: current working directory).
- `-p, --platform `: Platform (default: current platform).
- `-a, --arch `: Architecture (default: current architecture).
- `-f, --force`: Force download to overwrite existing files (default: false).
- `--ok-if-exists`: If the tool already exists, skip download and exit with code 0.
- `--verbose`: Enables verbose output (default: false).
- `--silent`: Disables the progress bar (default: false).
#### Examples
To download the Arduino CLI version `1.1.1` to the current working directory:
```bash
gat get arduino-cli 1.1.1
```
To download `clangd` for the Arduino language server with verbose output:
```bash
gat get clangd 12.0.0 --verbose
```
To download the Arduino CLI version `1.1.1` to a destination folder:
```bash
gat get arduino-cli 1.1.1 --destination-folder-path /path/to/my/folder
```
### API
```js
const { getTool } = require('get-arduino-tools')
getTool({
tool: 'arduino-cli',
version: '1.1.1',
destinationFolderPath: 'path/to/the/dir',
}).then((result) => console.log(result), console.error)
// { toolPath: 'path/to/the/dir/arduino-cli' }
```
### Proxy Support
Use the `HTTP_PROXY` and the `HTTPS_PROXY` environment variables to configure the HTTP proxy addresses.
## Development Setup
To set up the development environment, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/dankeboy36/get-arduino-tools.git
cd get-arduino-tools
```
2. Install the dependencies:
```bash
npm install
```
3. To run tests:
```bash
npm test
```
4. Build the CLI
```bash
npm run build:cli
```
5. Run the CLI tool locally:
```bash
node bin/cli.js get [options]
```
6. To run the integration tests:
```bash
npm run test:slow
```
## Contributing
Contributions are welcome! Feel free to open an issue or submit a pull request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.