Registry / devops / simple-shadcn-cli

simple-shadcn-cli

library1.0.0jsnpmunverified

CLI tool for creating shadcn-cli custom registry items. v1.0.0, stable release. It provides two commands: interactive 'create' for single items and 'build' for project-wide registry generation. Supports registry types: ui, lib, hook, block. Includes TypeScript types for registry schema. Requires Node >=14.16. Differentiators: automated build from project source, file overwrite protection, multiple file support per item.

devops

npm install simple-shadcn-cli

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · SIMPLE-SHADCN-CLI

simple-shadcn-cli

devopsjavascriptv1.0.0

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.

Registry

✓ import type { Registry } from 'simple-shadcn-cli'

✗ import { Registry } from 'simple-shadcn-cli'

TypeScript type import; cannot be used at runtime.

RegistryItem

✓ import type { RegistryItem } from 'simple-shadcn-cli'

✗ const { RegistryItem } = require('simple-shadcn-cli')

TypeScript type import; CJS require does not work for types.

RegistryItemFile

✓ import type { RegistryItemFile } from 'simple-shadcn-cli'

TypeScript type import for file configuration.

Shows both interactive create and automated build workflows for generating shadcn-cli registry JSON files.

// Install globally or use npx npx simple-shadcn-cli create # Follow prompts to generate a registry item # Or build from project: # Create config file: simple-shadcn.json { "outputDir": "public/registry", "registryDirectory": "src/registry" } # In src/registry/index.ts: import type { Registry } from 'simple-shadcn-cli'; export const registry: Registry = [ { name: "button-big", type: "registry:ui", description: "A big button component", files: [ { path: "ui/button-big.tsx", type: "registry:ui" } ] } ]; # Then run: npx simple-shadcn-cli build

Debug

Known issues

gotchaRegistry types are only available as TypeScript type imports; cannot be required at runtime.

fix

Use 'import type' syntax in TypeScript; for JavaScript, you can use JSDoc type annotations.

affects: >=1.0.0

gotchaThe 'build' command requires a 'simple-shadcn.json' config file in project root. Running it without config will error.

fix

Create a simple-shadcn.json file with required fields (outputDir, registryDirectory).

affects: >=1.0.0

gotchaFile paths in registry config are relative to registryDirectory, not project root.

fix

Use paths relative to the directory specified in 'registryDirectory' config option.

affects: >=1.0.0

gotchaInteractive 'create' command overwrites files without prompt unless file overwrite protection is enabled (which is on by default).

fix

Check that the output directory does not contain files you want to keep, or manually review before proceeding.

affects: >=1.0.0

Errors

Common errors & fixes

Error: Cannot find module 'simple-shadcn-cli'

Installed globally vs using npx without install.

fix

Use 'npx simple-shadcn-cli create' or install locally with 'npm install simple-shadcn-cli'.

TypeError: Cannot read properties of undefined (reading 'outputDir')

Missing or invalid 'simple-shadcn.json' configuration file.

fix

Create a valid simple-shadcn.json with 'outputDir' and 'registryDirectory' fields.

Error: ENOENT: no such file or directory, open '...'

File path in registry config does not exist relative to registryDirectory.

fix

Ensure all file paths in registry config are correct relative to the registryDirectory.

Upgrade

Version history

1.0.0latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

5 hits · last 30 days

node

Resources

githubhttps://github.com/Alwurts/simple-shadcn-cli ↗

packagesimple-shadcn-cli ↗

homepagehttps://github.com/Alwurts/simple-shadcn-cli#readme ↗