{"id":20689037,"url":"https://github.com/dankeboy36/ardunno-cli","last_synced_at":"2026-02-02T11:37:33.698Z","repository":{"id":137891937,"uuid":"539075002","full_name":"dankeboy36/ardunno-cli","owner":"dankeboy36","description":"nice-grpc API for the Arduino CLI","archived":false,"fork":false,"pushed_at":"2024-12-12T13:30:52.000Z","size":351,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-10T00:02:20.925Z","etag":null,"topics":["arduino","grpc","nice-grpc","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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":null,"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":"2022-09-20T16:00:44.000Z","updated_at":"2024-12-12T13:30:53.000Z","dependencies_parsed_at":null,"dependency_job_id":"144caeed-5c0f-4482-800d-6c2afa245767","html_url":"https://github.com/dankeboy36/ardunno-cli","commit_stats":null,"previous_names":["dankeboy36/ardunno-cli-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dankeboy36%2Fardunno-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dankeboy36%2Fardunno-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dankeboy36%2Fardunno-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dankeboy36%2Fardunno-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dankeboy36","download_url":"https://codeload.github.com/dankeboy36/ardunno-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249951942,"owners_count":21350564,"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":["arduino","grpc","nice-grpc","typescript"],"created_at":"2024-11-16T23:08:03.133Z","updated_at":"2026-02-02T11:37:33.693Z","avatar_url":"https://github.com/dankeboy36.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## ardunno-cli\n\n[`nice-grpc`](https://github.com/deeplay-io/nice-grpc) API for the [Arduino CLI](https://github.com/arduino/arduino-cli).\n\nThe CLI API code in this repository is generated from the [`.proto` files](https://github.com/arduino/arduino-cli/tree/master/rpc) of the Arduino CLI. The API is compatible with the Arduino CLI version pinned in [`arduino-cli.version`](arduino-cli.version). This project uses [`ardunno-cli-gen`](https://github.com/dankeboy36/ardunno-cli-gen/) for the API generation.\n\n## Installing\n\n```\nnpm i ardunno-cli --save\n```\n\n## Usage\n\n### TypeScript:\n\n```ts\nimport { createChannel, createClient } from 'nice-grpc'\nimport { ArduinoCoreServiceDefinition } from 'ardunno-cli'\n```\n\n### JavaScript:\n\n```js\nconst { createChannel, createClient } = require('nice-grpc')\nconst { ArduinoCoreServiceDefinition } = require('ardunno-cli')\n```\n\n### Create a gRPC client:\n\nRequires a running Arduino CLI daemon to connect to.\n\n```sh\n% ./arduino-cli daemon --port 50051 --format json\n{\n  \"IP\": \"127.0.0.1\",\n  \"Port\": \"50051\"\n}\n```\n\n```ts\nconst channel = createChannel('localhost:50051')\nconst client = createClient(ArduinoCoreServiceDefinition, channel)\n```\n\n### Create:\n\nCreates a new Arduino Core instance.\n\n```ts\nconst { instance } = await client.create({})\n```\n\n### Initialize:\n\nInitializes an existing Arduino Core instance by loading platforms and libraries.\n\n```ts\nfor await (const { message } of client.init({ instance })) {\n  switch (message.$case) {\n    case 'error':\n      throw new Error(message.error)\n  }\n}\n```\n\n### Search platforms:\n\n```ts\nconst { searchOutput } = await client.platformSearch({\n  instance,\n  searchArgs: 'SAMD',\n})\nsearchOutput.forEach(({ id, latest }) =\u003e console.log(`${id}@${latest}`))\n\n// arduino:samd@1.8.13\n// Arrow:samd@2.1.0\n// industruino:samd@1.0.1\n```\n\n## Configuration\n\nThe API contains typing and a JSON schema for the [Arduino CLI configuration](https://arduino.github.io/arduino-cli/latest/configuration/).\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%2Fardunno-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdankeboy36%2Fardunno-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdankeboy36%2Fardunno-cli/lists"}