Fuma CLI

0.0.5 · active · verified Sun Apr 19

Fuma CLI is an early-stage command-line interface tool designed to facilitate the creation of custom component libraries, drawing inspiration from the `shadcn/ui` pattern. It aims to provide developers with a framework to build their own `shadcn/ui`-like CLI experience for their projects. Currently at version 0.0.5, the project is undergoing rapid development, as indicated by frequent patch releases. Its primary differentiator is its focus on extensibility, allowing users to define and manage their own UI component collections through a dedicated CLI. The project's current status suggests a focus on core features like component addition and environment detection, with a potential for significant changes as it approaches a stable release, serving as a foundational layer for customizable UI tooling.

Common errors

```
fuma-cli: command not found
```
cause The `fuma-cli` package is not installed globally or locally in a way that makes its executable accessible in your PATH.

fix Use `npx fuma-cli <command>` to execute it without global installation, or install it globally with `npm install -g fuma-cli` (though `npx` is generally preferred for CLIs).
```
Error: Cannot find module '@fuma-cli/interactive'
```
cause While `fuma-cli` is the main package, it appears to have sub-packages like `@fuma-cli/interactive` that it depends on, which might not be correctly installed or resolved in some environments.

fix Ensure that all transitive dependencies are correctly installed. Try `npm install` or `yarn install` in your project root. If using `npx`, ensure your `node_modules` is up-to-date. This might also indicate an issue with the package's bundled dependencies.

Warnings

breaking As a pre-1.0 package (currently 0.0.5), `fuma-cli` is subject to frequent and undocumented breaking changes. API surfaces, configuration formats, and command-line arguments may change without major version bumps.
Fix: Always pin exact versions (e.g., `"fuma-cli": "0.0.5"`) and review the GitHub repository for the latest changes and upgrade guides before updating.
gotcha The project description mentions 'Build your own Shadcn CLI', implying that `fuma-cli` itself might be a framework for building other CLIs, rather than a direct replacement for `shadcn/ui`. Users should understand its role as a meta-CLI tool.
Fix: Consult the (currently missing) official documentation or GitHub issues for clarification on its intended use cases and architecture before committing to it for production.
gotcha Lack of comprehensive README and documentation makes understanding advanced features, customization options, and best practices challenging. Many aspects will require inspecting source code or trial-and-error.
Fix: Monitor the official GitHub repository for updates to documentation and examples. Engage with the maintainers via issues for specific guidance.

Install

npm install fuma-cli npm
yarn add fuma-cli yarn
pnpm add fuma-cli pnpm

Imports

fuma
wrong:
```
import fuma from 'fuma-cli'
```
correct:
```
npx fuma-cli
```
fuma-cli is primarily a command-line tool, not designed for direct programmatic import in typical application code. Interaction is through the shell.
fuma add
wrong:
```
import { add } from 'fuma-cli'
```
correct:
```
npx fuma-cli add <component-name>
```
The 'add' functionality is exposed via the CLI command. Direct `import { add }` is not the intended usage for the main `fuma-cli` package.

Quickstart

Initializes a new Fuma CLI project, creates a sample component, and adds it to the project using the CLI's `add` command.

npx fuma-cli init my-component-library
cd my-component-library
echo 'console.log("Hello from a new component!");' > src/components/hello-world.js
npx fuma-cli add hello-world --output-path components/ui

# Example of running an interactive prompt (requires @fuma-cli/interactive)
# Note: This is a conceptual demonstration as `fuma-cli add` is likely interactive by default now.
npx fuma-cli add

view raw JSON →