Skip to Content
CLIIntroduction

The Akinon UI CLI provides a streamlined way to create and manage your Akinon UI Protocol projects. Inspired by Next.js’s approach to project creation, our CLI tools make it simple to get started with any type of UI Protocol application.

Quick Start

Create a new project instantly with our project generator:

npx create-akinon-app@latest

This command will guide you through an interactive setup process, allowing you to choose your project type and configuration preferences.

What You Can Build

The CLI supports creating several types of applications:

  • Fullpage Applications - Standalone full-page applications that run within main applications
  • Plugin Applications - Smaller components that embed within specific sections of main applications
  • Multi-App Projects - Projects containing multiple fullpage or plugin applications

Key Features

Interactive Project Creation

The CLI provides a user-friendly interactive experience that guides you through project setup, similar to popular tools like create-next-app or create-react-app.

Built-in Development Shell

Every project includes access to a development shell server that simulates the Omnitron environment, allowing you to test your applications in a realistic context during development.

Template-Based Architecture

Projects are generated from battle-tested templates that include:

  • TypeScript configuration
  • Testing setup with Vitest
  • Linting and formatting tools
  • UI Kit integration
  • Proper project structure

Development Commands

Once your project is created, you can use these commands:

# Start development server
pnpm dev
 
# Start development with shell environment
pnpm dev:shell
 
# Run tests
pnpm test
 
# Build for production
pnpm build

Installation Options

No installation required - use the latest version directly:

npx create-akinon-app@latest

Global Installation

Install globally for repeated use:

npm install -g create-akinon-app
create-akinon-app

Local Development

For development within an existing UI Protocol workspace:

pnpm add -D @akinon/ui-cli
pnpm akinon-ui --help
Getting Started