{"id":24823399,"url":"https://github.com/dankeboy36/get-arduino-tools","last_synced_at":"2025-10-13T22:31:32.082Z","repository":{"id":273078917,"uuid":"918588347","full_name":"dankeboy36/get-arduino-tools","owner":"dankeboy36","description":"Get Arduino Tools (`gat`) is a CLI that helps you easily download various Arduino tools","archived":false,"fork":false,"pushed_at":"2025-01-21T09:59:57.000Z","size":13,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-21T10:34:32.841Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dankeboy36.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-01-18T10:29:09.000Z","updated_at":"2025-01-21T10:06:49.000Z","dependencies_parsed_at":"2025-01-21T10:34:36.976Z","dependency_job_id":null,"html_url":"https://github.com/dankeboy36/get-arduino-tools","commit_stats":null,"previous_names":["dankeboy36/get-arduino-tool","dankeboy36/get-arduino-tools"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dankeboy36%2Fget-arduino-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dankeboy36%2Fget-arduino-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dankeboy36%2Fget-arduino-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dankeboy36%2Fget-arduino-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dankeboy36","download_url":"https://codeload.github.com/dankeboy36/get-arduino-tools/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":236414779,"owners_count":19145077,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-30T19:58:25.196Z","updated_at":"2025-10-13T22:31:32.066Z","avatar_url":"https://github.com/dankeboy36.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# get-arduino-tools\n\nGet Arduino Tools (`gat`) is a CLI that helps you easily download various Arduino tools\n\n\u003e 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.\n\n## Tools\n\n- [Arduino CLI](https://github.com/arduino/arduino-cli)\n- [Arduino Language Server](https://github.com/arduino/arduino-language-server)\n- [Arduino Firmware Uploader](https://github.com/arduino/arduino-fwuploader)\n- [Arduino Lint](https://github.com/arduino/arduino-lint)\n- [`clangd`](https://github.com/arduino/clang-static-binaries)\n- [`clang-format`](https://github.com/arduino/clang-static-binaries)\n\n## Installation\n\nTo install the `gat` CLI globally:\n\n```bash\nnpm install -g get-arduino-tools\n```\n\n## Usage\n\n### CLI\n\nYou can use `gat` to download Arduino tools with the following command:\n\n```bash\ngat get \u003ctool\u003e \u003cversion\u003e [options]\n```\n\n#### Arguments\n\n- `\u003ctool\u003e`: The tool you want to download. Can be one of: `arduino-cli`, `arduino-language-server`, `arduino-fwuploader`, `arduino-lint`, `clangd`, `clang-format`.\n- `\u003cversion\u003e`: The version of the tool you want to download.\n\n#### Options\n\n- `-d, --destination-folder-path \u003cpath\u003e`: Destination folder path (default: current working directory).\n- `-p, --platform \u003cplatform\u003e`: Platform (default: current platform).\n- `-a, --arch \u003carch\u003e`: Architecture (default: current architecture).\n- `-f, --force`: Force download to overwrite existing files (default: false).\n- `--ok-if-exists`: If the tool already exists, skip download and exit with code 0.\n- `--verbose`: Enables verbose output (default: false).\n- `--silent`: Disables the progress bar (default: false).\n\n#### Examples\n\nTo download the Arduino CLI version `1.1.1` to the current working directory:\n\n```bash\ngat get arduino-cli 1.1.1\n```\n\nTo download `clangd` for the Arduino language server with verbose output:\n\n```bash\ngat get clangd 12.0.0 --verbose\n```\n\nTo download the Arduino CLI version `1.1.1` to a destination folder:\n\n```bash\ngat get arduino-cli 1.1.1 --destination-folder-path /path/to/my/folder\n```\n\n### API\n\n```js\nconst { getTool } = require('get-arduino-tools')\n\ngetTool({\n  tool: 'arduino-cli',\n  version: '1.1.1',\n  destinationFolderPath: 'path/to/the/dir',\n}).then((result) =\u003e console.log(result), console.error)\n// { toolPath: 'path/to/the/dir/arduino-cli' }\n```\n\n### Proxy Support\n\nUse the `HTTP_PROXY` and the `HTTPS_PROXY` environment variables to configure the HTTP proxy addresses.\n\n## Development Setup\n\nTo set up the development environment, follow these steps:\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/dankeboy36/get-arduino-tools.git\n   cd get-arduino-tools\n   ```\n\n2. Install the dependencies:\n\n   ```bash\n   npm install\n   ```\n\n3. To run tests:\n\n   ```bash\n   npm test\n   ```\n\n4. Build the CLI\n\n   ```bash\n   npm run build:cli\n   ```\n\n5. Run the CLI tool locally:\n\n   ```bash\n   node bin/cli.js get \u003ctool\u003e \u003cversion\u003e [options]\n   ```\n\n6. To run the integration tests:\n\n   ```bash\n   npm run test:slow\n   ```\n\n## Contributing\n\nContributions are welcome! Feel free to open an issue or submit a pull request.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdankeboy36%2Fget-arduino-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdankeboy36%2Fget-arduino-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdankeboy36%2Fget-arduino-tools/lists"}