Registry / devops / ardunno-cli-gen

ardunno-cli-gen

library0.1.10jsnpmunverified

A code generation tool that produces TypeScript/JavaScript nice-grpc API bindings for the Arduino CLI from its proto files. Version 0.1.10 is the latest stable release with no recent updates (low release cadence). It supports multiple input sources: local proto folders, semver tags (downloading from GitHub releases), or GitHub repository references (branch, commit). The generated code uses nice-grpc and ts-proto, targeting Node.js environments. Key differentiator: automates a manual protobuf generation workflow specifically for Arduino CLI, avoiding the need to run protoc manually.

devops

npm install ardunno-cli-gen

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · ARDUNNO-CLI-GEN

ardunno-cli-gen

devopsjavascriptv0.1.10

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

generate

✓ import { generate } from 'ardunno-cli-gen'

✗ const generate = require('ardunno-cli-gen');

Use named import; default export is not available. CommonJS users must destructure require.

Generates nice-grpc API from Arduino CLI proto files for version 0.29.0, outputting to ./src-gen with overwrite enabled.

import { generate } from 'ardunno-cli-gen'; // Generate from a specific Arduino CLI version await generate({ src: '0.29.0', out: './src-gen', force: true });

Debug

Known issues

gotchaThe generated code uses nice-grpc, which requires the `nice-grpc` package to be installed in your project.

fix

Install nice-grpc as a dependency: npm install nice-grpc

affects: *

gotchaInput 'src' must be a valid path, semver, or GitHub reference. Invalid formats will cause confusing errors.

fix

Use a local path, a semver string (e.g., '0.29.0'), or a GitHub ref in the format 'owner/repo#commit'.

affects: *

deprecatedThe package depends on @pingghost/protoc which bundles protoc 3.19.1. This may not be compatible with the latest Arduino CLI proto files.

fix

Check if a newer version of ardunno-cli-gen updates the protoc version, or manually override using a local path to proto files.

affects: >=0.1.0

Errors

Common errors & fixes

TypeError: generate is not a function

Default import used when named import is required.

fix

Use named import: import { generate } from 'ardunno-cli-gen'

Error: ENOENT: no such file or directory, open '.../proto/arduino/cli/commands/v1/commands.proto'

Invalid input source path or missing proto files.

fix

Ensure the input source is correct: a valid local directory containing proto files, a valid semver, or a GitHub reference.

Upgrade

Version history

0.1.10latest on npm

Audit

Dependencies

nice-grpcrequiredruntime dependency for generated code

debugoptionalused for logging during generation

Agent activity

15 hits · last 30 days

node

Amazon

OpenAI (training)

Resources

githubhttps://github.com/dankeboy36/ardunno-cli-gen ↗

packageardunno-cli-gen ↗

homepagehttps://github.com/dankeboy36/ardunno-cli-gen#readme ↗