Skip to main content

Getting Started

Overview​

Arclix is an Open Source CLI for Component Generation in React. It offers faster and developer friendly environment with rich features.

  • Instantly generate component in any React project.
  • Provides out-of-box support for TypeScript, CSS preprocessors, Storybook, Test and more.
  • Can generate component with templates, styles, stories and tests.

What you'll need​

  • Node.js version 16.14 or above:
    • When installing Node.js, you are recommended to check all checkboxes related to dependencies.
  • You can also use nvm (macOS/Linux) or nvm-windows to switch Node versions between different projects.

Quick Start​

To use Arclix in your project, do one of the following:

1. Install Arclix as devDependency in your project​

You can install the package using npm or yarn or pnpm.

npm install -D arclix@latest

2. Install Arclix as global package in your system​

You can install the package using npm or yarn or pnpm.

npm install -g arclix@latest

3. No need to install Arclix manually in your system or project​

You can use npx command to use arclix commands without actually installing anything.

Note: This method of using arclix is comparatively slow than other two methods.

Recommended

Installing Arclix as devDependency is the recommended installation.