Introduction

@akinon/ui-cli is a command-line interface tool for creating and developing UI Protocol applications.

It provides scaffolding templates, development utilities, and a shell development server for testing micro-frontend applications.

Installation

The CLI is designed to be used with pnpm for the best experience:

# Create a new application (recommended)
pnpm create akinon-app

For frequent usage, you can install it globally:

pnpm add -g @akinon/ui-cli

Commands

The CLI provides two main commands:

Command	Description
create	Create a new UI Protocol application
shell	Start a development shell server

Quick Start

Creating a New Application

# Interactive mode (recommended)
pnpm create akinon-app

# With options
pnpm create akinon-app my-app -- --type fullpage --package-manager pnpm

Running Development Shell

# Navigate to your project
cd my-app

# Start the shell server
pnpm shell --config shell.config.js --port 4000

Project Types

The CLI supports creating different types of applications:

Type	Description
fullpage	Standalone full-page application that takes over the content area
plugin	Partial plugin that loads within a specific placeholder in the shell
multi-fullpage	Multiple full-page apps served from a single codebase
multi-plugin	Multiple plugins served from a single codebase

Package Manager Support

The CLI supports multiple package managers:

• pnpm (recommended) - Fast, disk space efficient

• npm - Node.js default package manager

• yarn - Popular alternative

Features

Project Scaffolding

• Pre-configured templates for each project type

• TypeScript setup with strict mode

• TanStack Router with file-based routing

• i18n support via @akinon/akilocale

• Vite for fast development and builds

• ESLint and Prettier configuration

• Vitest for testing

Development Shell

• Simulates the production shell environment

• Multiple theme options (Omnitron, Seller Center, Minimal)

• Hot module replacement (HMR)

• Plugin testing capabilities

• Locale switching

• Sidebar navigation

Next Steps

• Create Application - Create a new project

• Development Shell - Test with a shell server