Links

Install the Uiflow CLI package

To add or manage custom components to Uiflow, ensure you install the @uiflow/cli npm package.
Note: If your project already contains the npm package, you do not need to run these commands.
  1. 1.
    Open a command line window and navigate to your project folder.
  2. 2.
    If you don't have an existing custom components directory, enter the following commands to create one. This directory contains the required components subdirectory for your custom components.
    Note: This walkthrough uses my-custom-components as a sample name for the custom components directory. You can choose any directory name, but consider using dashes instead of spaces for command line navigation purposes.
    mkdir my-custom-components/components
    cd my-custom-components
  3. 3.
    Enter npm update to ensure npm is up-to-date.
  4. 4.
    Enter the following commands to initialize npm and install the required TypeScript dependency and Uiflow CLI package.
    npm init -y
    npm install -D typescript
    npm install @uiflow/[email protected]
  5. 5.
    If you don't have an existing components library for your project, run npx uiflow create to initialize your components library.
    After the package is installed, the Uiflow CLI screen launches in the command line. Follow the on-screen prompts to create a new component library.