> For the complete documentation index, see [llms.txt](https://docs.akinon.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.akinon.com/akinon-ui/cli/introduction.md).

# 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.

### <mark style="color:red;">Installation</mark>

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

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

For frequent usage, you can install it globally:

```bash
pnpm add -g @akinon/ui-cli
```

### <mark style="color:red;">Commands</mark>

The CLI provides two main commands:

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

### <mark style="color:red;">Quick Start</mark>

#### Creating a New Application

```bash
# Interactive mode (recommended)
pnpm create akinon-app

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

#### Running Development Shell

```bash
# Navigate to your project
cd my-app

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

### <mark style="color:red;">Project Types</mark>

The CLI supports creating different types of applications:

<table><thead><tr><th width="177.2109375">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>fullpage</code></td><td>Standalone full-page application that takes over the content area</td></tr><tr><td><code>plugin</code></td><td>Partial plugin that loads within a specific placeholder in the shell</td></tr><tr><td><code>multi-fullpage</code></td><td>Multiple full-page apps served from a single codebase</td></tr><tr><td><code>multi-plugin</code></td><td>Multiple plugins served from a single codebase</td></tr></tbody></table>

### <mark style="color:red;">Package Manager Support</mark>

The CLI supports multiple package managers:

* **pnpm** (recommended) - Fast, disk space efficient
* **npm** - Node.js default package manager
* **yarn** - Popular alternative

### <mark style="color:red;">Features</mark>

#### 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

### <mark style="color:red;">Next Steps</mark>

* Create Application - Create a new project
* Development Shell - Test with a shell server


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.akinon.com/akinon-ui/cli/introduction.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
