grpcmkr-cli

library1.2.6jsnpmunverified

A CLI tool for scaffolding gRPC microservice projects from .proto files. Current version 1.2.6, released on npm. It generates boilerplate code for Node.js/TypeScript projects with support for both npm and yarn package managers. Differentiators: opinionated project structure inspired by NestJS, automated setup of gRPC server and client stubs. Low release cadence (last update 2023). Requires Node >= 14.

devops

npm install grpcmkr-cli

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · GRPCMKR-CLI

grpcmkr-cli

devopsjavascriptv1.2.6

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.

grpcmkr

✓ npx grpcmkr-cli [command]

✗ npm run grpcmkr

grpcmkr-cli is a global CLI tool, not a library import. Use npx or install globally.

create

✓ grpcmkr create

✗ grpcmkr-cli create

The CLI binary is 'grpcmkr', not 'grpcmkr-cli'. See package.json bin field.

Global install, then scaffold a new gRPC project by providing a .proto file and project name.

npm install -g grpcmkr-cli && cd /tmp && grpcmkr create && # Follow prompts: choose package manager (npm), proto file path (./example/hello.proto), project name (my-grpc-project)

Debug

Known issues

gotchaThe CLI binary is 'grpcmkr' not 'grpcmkr-cli'. Running 'grpcmkr-cli create' fails because the executable name is different.

fix

Use 'grpcmkr create' instead.

affects: >=0.0.0

gotchaThe project does not provide proper TypeScript or JavaScript imports for programmatic use; it's meant only as a CLI tool.

fix

Do not attempt to import from 'grpcmkr-cli' in code; use the CLI directly.

affects: >=0.0.0

deprecatedThe package has no recent updates (last publish 2023) and may lack support for newer Node.js versions beyond 14.

fix

Consider alternatives like 'grpc-tools' or manually generate code with protoc.

affects: <2.0.0

Errors

Common errors & fixes

Command not found: grpcmkr

Package not installed globally or not in PATH.

fix

Run 'npm install -g grpcmkr-cli' and ensure npm global bin is in PATH.

ENOENT: no such file or directory, open '.../package.json'

Running 'grpcmkr create' outside a project directory or without a package.json.

fix

Run the command from a directory that contains a package.json or create one with 'npm init'.

Upgrade

Version history

1.2.6latest on npm

Audit

Dependencies

noderequiredRuntime for the CLI tool

Agent activity

6 hits · last 30 days

node

Resources

githubhttps://github.com/rodrigoalejandrorios/grpcmkr-cli ↗

packagegrpcmkr-cli ↗

homepagehttps://github.com/rodrigoalejandrorios/grpcmkr-cli#readme ↗