README.md
August 20, 2026 ยท View on GitHub
@koalarx/ui
CLI for creating and managing Angular projects with ready-to-use UI components.
Installation
npm install -g @koalarx/ui
or with bun:
bun add -g @koalarx/ui
Commands
kl new
Creates a new Angular project with the Koala structure and dependencies already configured.
Interactive prompts (before scaffold): package manager โ app/library โ SSR (app only) โ AI context (Cursor / GitHub Copilot).
Package managers: bun, npm, yarn, pnpm.
Skip prompts with --pm, --type app|library, --ssr / --no-ssr, --ai-context, and --silent (non-interactive defaults: bun + app + no SSR + AI context none).
kl new --name meu-projeto
kl new --name my-project --pm npm
kl new my-app --ssr
kl new my-lib --type library
kl new my-app --ai-context both
kl new my-app --silent
kl install
Adds one or more UI components to the project.
Use --silent to accept all external dependency installs without prompting (recommended for AI agents and CI).
kl install button
kl install button,loading,dropdown
kl install modal --project meu-projeto
kl install button,modal --silent
kl add
Adds project features. Currently supports AI context scaffolding:
kl add ai-context cursor
kl add ai-context github
kl add ai-context cursor github
kl init
Initializes an existing Angular project with the Koala structure and required tooling.
kl init
kl init --project meu-projeto
kl init --project meu-projeto --verbose
kl init --ai-context none
kl init --silent
kl version
Shows the installed CLI version.
kl version
Support lines (main + previous-release)
| Line | Branch | Docs | npm dist-tag |
|---|---|---|---|
| Latest | main | ui.koalarx.com | latest |
| Previous | previous-release | ui.koalarx.com/v{major}/ | configured in .github/release-lines.json (previousDistTag, e.g. angular-21) |
Archive branches (e.g. 22.3.0) keep frozen majors without CI. On a major bump: create the archive from previous-release, move current main into previous-release, then develop the new major on main. See .agents/documentation.md.
Library major tracks Angular major (22.x โ Angular 21, 23.x โ Angular 22).
Documentation
For detailed installation guides, usage instructions, patch notes, and examples for each component, visit the official documentation:
ui.koalarx.com ยท previous line under /v{major}/ ยท Patch notes ยท CHANGELOG.md