Commands

This document provides an overview of the commands available in the Nitro Module CLI.

Usage

Usage: create-nitro-module [options] [name]

A CLI tool that simplifies creating React Native modules powered by Nitro Modules.

Arguments:
  name                                name of the module to create

Options:
  -v, --version                       output the version number
  -t, --package-type <packageType>    type of the package to create
  --platforms <platforms>             comma-separated platforms to target
  --langs <langs>                     comma-separated languages to generate
  -d, --module-dir <moduleDirectory>  directory to create the module in
  -e, --skip-example                  skip example app generation
  -i, --skip-install                  skip installing dependencies
  --ci                               run in CI mode
  -h, --help                          display help for command

Example

Bun

bun create nitro-module@latest my-awesome-module

Npx

npx create-nitro-module@latest my-awesome-module

Yarn

yarn create nitro-module@latest my-awesome-module

Pnpm

pnpm create nitro-module@latest my-awesome-module

For additional support, please open an issue on our GitHub repository.