CLI Reference

Complete reference for every command in the ronakcn_cli tool.

Global usage

terminal

ronakcn <command> [arguments] [options]

Global options:
  --version    Print the CLI version
  --help, -h   Show help information

All commands accept --help as a trailing flag for inline help.

Commands

init add remove update list help

init

ronakcn init [options]

Initialises a new RonakCN project in the current directory. Creates a `ronakcn.json` config file and an output directory. Safe to run inside an existing Flutter project.

Options

--dir <path>

Output directory for components (default: lib/components)

--preset <name>

Theme preset to start with (default: default)

--yes, -y

Accept all prompts without interaction

Example

Initialise with a custom output directory and the "ocean" theme preset.

terminal

ronakcn init --dir lib/ui --preset ocean

add

ronakcn add <component> [components...] [options]

Copies one or more components into your project. The CLI resolves inter-component dependencies automatically and only installs pub packages that are not already present in pubspec.yaml.

Options

--overwrite, -o

Overwrite existing files without prompting

--dry-run

Preview what would be added without writing any files

Example

Add three components in a single command.

terminal

ronakcn add button text-field badge

remove

ronakcn remove <component> [components...]

Removes one or more components from your project. Deletes the component source files and cleans up the manifest entry. Does not remove pub packages because they may be used elsewhere.

Options

--yes, -y

Skip the confirmation prompt

Example

Remove the badge component.

terminal

ronakcn remove badge

update

ronakcn update [component] [options]

Updates installed components to the latest version from the registry. When no component name is given, all installed components are updated. Your local customisations are preserved with a diff prompt if conflicts arise.

Options

--all, -a

Update every installed component (default when no name given)

--overwrite

Overwrite local changes without prompting

Example

Update only the button component.

terminal

ronakcn update button

list

ronakcn list [options]

Displays all available components in the RonakCN registry. Components already installed in the current project are marked. Use --installed to show only installed components.

Options

--installed, -i

Show only installed components

--category <name>

Filter by category (input, display, feedback…)

--json

Output as JSON for scripting

Example

List all available input components.

terminal

ronakcn list --category input

help

ronakcn help [command]

Prints usage information for the CLI or for a specific command. You can also pass --help to any command to see its options inline.

Example

Show detailed help for the add command.

terminal

ronakcn help add