@akanjs/cli 2.1.0 → 2.1.1-rc.0

package/README.ko.md

@@ -0,0 +1,63 @@
+# @akanjs/cli
+
+[문서](https://akanjs.com/docs) | [npm](https://www.npmjs.com/package/@akanjs/cli) | [런타임](https://www.npmjs.com/package/akanjs)
+
+Akan.js 워크스페이스를 위한 command-line tooling입니다.
+
+`@akanjs/cli`는 Akan 애플리케이션, 라이브러리, 프레임워크 패키지를 생성, 빌드, 테스트, 린트,
+릴리즈, 유지보수하는 데 사용하는 `akan` 실행 파일을 제공합니다. Bun-first CLI 패키지이며 Akan
+개발 tooling을 내부에 번들링하므로, 애플리케이션 런타임은 더 작은 `akanjs` 패키지에만 의존할 수
+있습니다.
+
+## 설치
+
+새 워크스페이스를 바로 만들 수 있습니다.
+
+```bash
+bunx create-akan-workspace@latest
+```
+
+또는 CLI를 전역으로 설치할 수 있습니다.
+
+```bash
+bun install -g @akanjs/cli@latest
+akan --help
+```
+
+## 자주 쓰는 명령
+
+```bash
+akan create-workspace <workspace-name>
+akan start <app-name>
+akan build <app-name>
+akan test <app-or-lib-or-pkg>
+akan lint <app-or-lib-or-pkg>
+akan create-application <app-name>
+akan create-library <lib-name>
+akan create-module <module-name>
+akan create-scalar <scalar-name>
+```
+
+패키지 유지보수 명령도 같은 실행 파일에서 제공합니다.
+
+```bash
+akan build-package akanjs
+akan build-package @akanjs/cli
+akan build-package @akanjs/devkit
+```
+
+## 패키지 경계
+
+- 애플리케이션과 런타임 코드는 `akanjs`를 사용합니다.
+- 사용자-facing 실행 패키지는 `@akanjs/cli`입니다.
+- `@akanjs/devkit`은 published CLI 사용을 위해 CLI 안에 번들링됩니다. 일반 CLI 사용자가 별도의
+  runtime dependency로 설치할 필요는 없습니다.
+
+## 요구사항
+
+- [Bun](https://bun.sh) `>=1.3.13`
+- TypeScript 기반 Akan 워크스페이스
+
+## 라이선스
+
+MIT

package/README.md

@@ -0,0 +1,62 @@
+# @akanjs/cli
+
+[Docs](https://akanjs.com/docs) | [npm](https://www.npmjs.com/package/@akanjs/cli) | [Runtime](https://www.npmjs.com/package/akanjs)
+
+Command-line tooling for Akan.js workspaces.
+
+`@akanjs/cli` provides the `akan` executable used to create, build, test, lint, release, and maintain Akan
+applications, libraries, and framework packages. It is a Bun-first CLI package and bundles Akan development
+tooling internally so application runtimes can depend on the smaller `akanjs` package.
+
+## Install
+
+Create a new workspace:
+
+```bash
+bunx create-akan-workspace@latest
+```
+
+Or install the CLI globally:
+
+```bash
+bun install -g @akanjs/cli@latest
+akan --help
+```
+
+## Common Commands
+
+```bash
+akan create-workspace <workspace-name>
+akan start <app-name>
+akan build <app-name>
+akan test <app-or-lib-or-pkg>
+akan lint <app-or-lib-or-pkg>
+akan create-application <app-name>
+akan create-library <lib-name>
+akan create-module <module-name>
+akan create-scalar <scalar-name>
+```
+
+Package maintenance commands are also exposed through the same executable:
+
+```bash
+akan build-package akanjs
+akan build-package @akanjs/cli
+akan build-package @akanjs/devkit
+```
+
+## Package Boundary
+
+- Use `akanjs` from application and runtime code.
+- Use `@akanjs/cli` as the user-facing executable package.
+- `@akanjs/devkit` is bundled into the CLI for published CLI usage; it is not required as a separate
+  runtime dependency for ordinary CLI users.
+
+## Requirements
+
+- [Bun](https://bun.sh) `>=1.3.13`
+- A TypeScript Akan workspace
+
+## License
+
+MIT

package/guidelines/componentRule/componentRule.generate.json

@@ -2,14 +2,14 @@
   "title": "Component Rule",
   "description": "Shared component implementation rules",
   "group": "core",
-  "docsSource": "apps/angelo/page/akanjs/(docs)/references/ui/overview.tsx",
+  "docsSource": "apps/akan/page/(docs)/references/ui/overview.tsx",
   "codegenPriority": 3,
   "deprecated": false,
   "scans": [
     {
       "type": "docs",
       "description": "Current docs source for Component Rule",
-      "path": "apps/angelo/page/akanjs/(docs)/references/ui/overview.tsx"
+      "path": "apps/akan/page/(docs)/references/ui/overview.tsx"
     },
     {
       "type": "example",
@@ -20,18 +20,12 @@
   ],
   "update": {
     "filePath": "./componentRule.instruction.md",
-    "contents": [
-      "purpose",
-      "file ownership",
-      "current API patterns",
-      "codegen rules",
-      "validation checklist"
-    ],
+    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
     "rules": [
       "Use current Akan APIs only",
       "Keep output parseable for codegen",
       "Include ownership boundaries and review checklist"
     ]
   },
-  "page": "apps/angelo/page/akanjs/(docs)/references/ui/overview.tsx"
+  "page": "apps/akan/page/(docs)/references/ui/overview.tsx"
 }

package/guidelines/cssRule/cssRule.generate.json

@@ -2,14 +2,14 @@
   "title": "CSS Rule",
   "description": "Tailwind and DaisyUI styling rules",
   "group": "core",
-  "docsSource": "apps/angelo/page/akanjs/(docs)/docs/arch/css.tsx",
+  "docsSource": "apps/akan/page/(docs)/docs/arch/css.tsx",
   "codegenPriority": 3,
   "deprecated": false,
   "scans": [
     {
       "type": "docs",
       "description": "Current docs source for CSS Rule",
-      "path": "apps/angelo/page/akanjs/(docs)/docs/arch/css.tsx"
+      "path": "apps/akan/page/(docs)/docs/arch/css.tsx"
     },
     {
       "type": "example",
@@ -20,18 +20,12 @@
   ],
   "update": {
     "filePath": "./cssRule.instruction.md",
-    "contents": [
-      "purpose",
-      "file ownership",
-      "current API patterns",
-      "codegen rules",
-      "validation checklist"
-    ],
+    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
     "rules": [
       "Use current Akan APIs only",
       "Keep output parseable for codegen",
       "Include ownership boundaries and review checklist"
     ]
   },
-  "page": "apps/angelo/page/akanjs/(docs)/docs/arch/css.tsx"
+  "page": "apps/akan/page/(docs)/docs/arch/css.tsx"
 }

package/guidelines/docPageRule/docPageRule.generate.json

@@ -2,14 +2,14 @@
   "title": "Docs Page Rule",
   "description": "Docs page writing rules",
   "group": "core",
-  "docsSource": "apps/angelo/page/akanjs/(docs)/cheatsheet/dev/docs.tsx",
+  "docsSource": "apps/akan/page/(docs)/cheatsheet/dev/docs.tsx",
   "codegenPriority": 3,
   "deprecated": false,
   "scans": [
     {
       "type": "docs",
       "description": "Current docs source for Docs Page Rule",
-      "path": "apps/angelo/page/akanjs/(docs)/cheatsheet/dev/docs.tsx"
+      "path": "apps/akan/page/(docs)/cheatsheet/dev/docs.tsx"
     },
     {
       "type": "example",
@@ -20,18 +20,12 @@
   ],
   "update": {
     "filePath": "./docPageRule.instruction.md",
-    "contents": [
-      "purpose",
-      "file ownership",
-      "current API patterns",
-      "codegen rules",
-      "validation checklist"
-    ],
+    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
     "rules": [
       "Use current Akan APIs only",
       "Keep output parseable for codegen",
       "Include ownership boundaries and review checklist"
     ]
   },
-  "page": "apps/angelo/page/akanjs/(docs)/cheatsheet/dev/docs.tsx"
+  "page": "apps/akan/page/(docs)/cheatsheet/dev/docs.tsx"
 }

package/guidelines/docPageRule/docPageRule.instruction.md

@@ -4,7 +4,7 @@
 Use this when generating or updating Akan docs pages under the current docs route tree.
 
 ## Ownership
-- Docs pages live under `apps/angelo/page/akanjs/(docs)`.
+- Docs pages live under `apps/akan/page/(docs)`.
 - Pages use `Docs`, `Code`, `Scroll`, and app localization helpers used by nearby pages.
 - A docs page should teach one concept with examples, alerts, and navigation anchors.
 

package/guidelines/docSyncRule/docSyncRule.generate.json

@@ -2,14 +2,14 @@
   "title": "Docs Sync Rule",
   "description": "Docs to guideline sync rules",
   "group": "core",
-  "docsSource": "apps/angelo/page/akanjs/(docs)/docs/_index.tsx",
+  "docsSource": "apps/akan/page/(docs)/docs/_index.tsx",
   "codegenPriority": 3,
   "deprecated": false,
   "scans": [
     {
       "type": "docs",
       "description": "Current docs source for Docs Sync Rule",
-      "path": "apps/angelo/page/akanjs/(docs)/docs/_index.tsx"
+      "path": "apps/akan/page/(docs)/docs/_index.tsx"
     },
     {
       "type": "example",
@@ -20,18 +20,12 @@
   ],
   "update": {
     "filePath": "./docSyncRule.instruction.md",
-    "contents": [
-      "purpose",
-      "file ownership",
-      "current API patterns",
-      "codegen rules",
-      "validation checklist"
-    ],
+    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
     "rules": [
       "Use current Akan APIs only",
       "Keep output parseable for codegen",
       "Include ownership boundaries and review checklist"
     ]
   },
-  "page": "apps/angelo/page/akanjs/(docs)/docs/_index.tsx"
+  "page": "apps/akan/page/(docs)/docs/_index.tsx"
 }

package/guidelines/enumConstant/enumConstant.generate.json

@@ -2,14 +2,14 @@
   "title": "Enum Constant",
   "description": "enumOf category value rules",
   "group": "core",
-  "docsSource": "apps/angelo/page/akanjs/(docs)/conventions/module/constant.tsx",
+  "docsSource": "apps/akan/page/(docs)/conventions/module/constant.tsx",
   "codegenPriority": 2,
   "deprecated": false,
   "scans": [
     {
       "type": "docs",
       "description": "Current docs source for Enum Constant",
-      "path": "apps/angelo/page/akanjs/(docs)/conventions/module/constant.tsx"
+      "path": "apps/akan/page/(docs)/conventions/module/constant.tsx"
     },
     {
       "type": "example",
@@ -20,18 +20,12 @@
   ],
   "update": {
     "filePath": "./enumConstant.instruction.md",
-    "contents": [
-      "purpose",
-      "file ownership",
-      "current API patterns",
-      "codegen rules",
-      "validation checklist"
-    ],
+    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
     "rules": [
       "Use current Akan APIs only",
       "Keep output parseable for codegen",
       "Include ownership boundaries and review checklist"
     ]
   },
-  "page": "apps/angelo/page/akanjs/(docs)/conventions/module/constant.tsx"
+  "page": "apps/akan/page/(docs)/conventions/module/constant.tsx"
 }

package/guidelines/fieldRule/fieldRule.generate.json

@@ -2,14 +2,14 @@
   "title": "Field Rule",
   "description": "Current via field helper rules",
   "group": "core",
-  "docsSource": "apps/angelo/page/akanjs/(docs)/conventions/module/constant.tsx",
+  "docsSource": "apps/akan/page/(docs)/conventions/module/constant.tsx",
   "codegenPriority": 1,
   "deprecated": false,
   "scans": [
     {
       "type": "docs",
       "description": "Current docs source for Field Rule",
-      "path": "apps/angelo/page/akanjs/(docs)/conventions/module/constant.tsx"
+      "path": "apps/akan/page/(docs)/conventions/module/constant.tsx"
     },
     {
       "type": "example",
@@ -20,18 +20,12 @@
   ],
   "update": {
     "filePath": "./fieldRule.instruction.md",
-    "contents": [
-      "purpose",
-      "file ownership",
-      "current API patterns",
-      "codegen rules",
-      "validation checklist"
-    ],
+    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
     "rules": [
       "Use current Akan APIs only",
       "Keep output parseable for codegen",
       "Include ownership boundaries and review checklist"
     ]
   },
-  "page": "apps/angelo/page/akanjs/(docs)/conventions/module/constant.tsx"
+  "page": "apps/akan/page/(docs)/conventions/module/constant.tsx"
 }

package/guidelines/framework/framework.generate.json

@@ -2,14 +2,14 @@
   "title": "Akan.js Framework",
   "description": "Compact global context for Akan AI codegen",
   "group": "core",
-  "docsSource": "apps/angelo/page/akanjs/(docs)/docs/intro/fundamentals.tsx",
+  "docsSource": "apps/akan/page/(docs)/docs/intro/fundamentals.tsx",
   "codegenPriority": 1,
   "deprecated": false,
   "scans": [
     {
       "type": "docs",
       "description": "Current docs source for Akan.js Framework",
-      "path": "apps/angelo/page/akanjs/(docs)/docs/intro/fundamentals.tsx"
+      "path": "apps/akan/page/(docs)/docs/intro/fundamentals.tsx"
     },
     {
       "type": "example",
@@ -20,18 +20,12 @@
   ],
   "update": {
     "filePath": "./framework.instruction.md",
-    "contents": [
-      "purpose",
-      "file ownership",
-      "current API patterns",
-      "codegen rules",
-      "validation checklist"
-    ],
+    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
     "rules": [
       "Use current Akan APIs only",
       "Keep output parseable for codegen",
       "Include ownership boundaries and review checklist"
     ]
   },
-  "page": "apps/angelo/page/akanjs/(docs)/docs/intro/fundamentals.tsx"
+  "page": "apps/akan/page/(docs)/docs/intro/fundamentals.tsx"
 }

package/guidelines/modelConstant/modelConstant.generate.json

@@ -2,14 +2,14 @@
   "title": "Model Constant",
   "description": "Module constant generation rules",
   "group": "module",
-  "docsSource": "apps/angelo/page/akanjs/(docs)/conventions/module/constant.tsx",
+  "docsSource": "apps/akan/page/(docs)/conventions/module/constant.tsx",
   "codegenPriority": 1,
   "deprecated": false,
   "scans": [
     {
       "type": "docs",
       "description": "Current docs source for Model Constant",
-      "path": "apps/angelo/page/akanjs/(docs)/conventions/module/constant.tsx"
+      "path": "apps/akan/page/(docs)/conventions/module/constant.tsx"
     },
     {
       "type": "example",
@@ -20,18 +20,12 @@
   ],
   "update": {
     "filePath": "./modelConstant.instruction.md",
-    "contents": [
-      "purpose",
-      "file ownership",
-      "current API patterns",
-      "codegen rules",
-      "validation checklist"
-    ],
+    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
     "rules": [
       "Use current Akan APIs only",
       "Keep output parseable for codegen",
       "Include ownership boundaries and review checklist"
     ]
   },
-  "page": "apps/angelo/page/akanjs/(docs)/conventions/module/constant.tsx"
+  "page": "apps/akan/page/(docs)/conventions/module/constant.tsx"
 }

package/guidelines/modelDictionary/modelDictionary.generate.json

@@ -2,14 +2,14 @@
   "title": "Model Dictionary",
   "description": "Module dictionary generation rules",
   "group": "module",
-  "docsSource": "apps/angelo/page/akanjs/(docs)/conventions/module/dictionary.tsx",
+  "docsSource": "apps/akan/page/(docs)/conventions/module/dictionary.tsx",
   "codegenPriority": 1,
   "deprecated": false,
   "scans": [
     {
       "type": "docs",
       "description": "Current docs source for Model Dictionary",
-      "path": "apps/angelo/page/akanjs/(docs)/conventions/module/dictionary.tsx"
+      "path": "apps/akan/page/(docs)/conventions/module/dictionary.tsx"
     },
     {
       "type": "example",
@@ -20,18 +20,12 @@
   ],
   "update": {
     "filePath": "./modelDictionary.instruction.md",
-    "contents": [
-      "purpose",
-      "file ownership",
-      "current API patterns",
-      "codegen rules",
-      "validation checklist"
-    ],
+    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
     "rules": [
       "Use current Akan APIs only",
       "Keep output parseable for codegen",
       "Include ownership boundaries and review checklist"
     ]
   },
-  "page": "apps/angelo/page/akanjs/(docs)/conventions/module/dictionary.tsx"
+  "page": "apps/akan/page/(docs)/conventions/module/dictionary.tsx"
 }

package/guidelines/modelDocument/modelDocument.generate.json

@@ -2,14 +2,14 @@
   "title": "Model Document",
   "description": "Module persistence generation rules",
   "group": "module",
-  "docsSource": "apps/angelo/page/akanjs/(docs)/conventions/module/document.tsx",
+  "docsSource": "apps/akan/page/(docs)/conventions/module/document.tsx",
   "codegenPriority": 1,
   "deprecated": false,
   "scans": [
     {
       "type": "docs",
       "description": "Current docs source for Model Document",
-      "path": "apps/angelo/page/akanjs/(docs)/conventions/module/document.tsx"
+      "path": "apps/akan/page/(docs)/conventions/module/document.tsx"
     },
     {
       "type": "example",
@@ -20,18 +20,12 @@
   ],
   "update": {
     "filePath": "./modelDocument.instruction.md",
-    "contents": [
-      "purpose",
-      "file ownership",
-      "current API patterns",
-      "codegen rules",
-      "validation checklist"
-    ],
+    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
     "rules": [
       "Use current Akan APIs only",
       "Keep output parseable for codegen",
       "Include ownership boundaries and review checklist"
     ]
   },
-  "page": "apps/angelo/page/akanjs/(docs)/conventions/module/document.tsx"
+  "page": "apps/akan/page/(docs)/conventions/module/document.tsx"
 }

package/guidelines/modelService/modelService.generate.json

@@ -2,14 +2,14 @@
   "title": "Model Service",
   "description": "Module service generation rules",
   "group": "module",
-  "docsSource": "apps/angelo/page/akanjs/(docs)/conventions/module/service.tsx",
+  "docsSource": "apps/akan/page/(docs)/conventions/module/service.tsx",
   "codegenPriority": 2,
   "deprecated": false,
   "scans": [
     {
       "type": "docs",
       "description": "Current docs source for Model Service",
-      "path": "apps/angelo/page/akanjs/(docs)/conventions/module/service.tsx"
+      "path": "apps/akan/page/(docs)/conventions/module/service.tsx"
     },
     {
       "type": "example",
@@ -20,18 +20,12 @@
   ],
   "update": {
     "filePath": "./modelService.instruction.md",
-    "contents": [
-      "purpose",
-      "file ownership",
-      "current API patterns",
-      "codegen rules",
-      "validation checklist"
-    ],
+    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
     "rules": [
       "Use current Akan APIs only",
       "Keep output parseable for codegen",
       "Include ownership boundaries and review checklist"
     ]
   },
-  "page": "apps/angelo/page/akanjs/(docs)/conventions/module/service.tsx"
+  "page": "apps/akan/page/(docs)/conventions/module/service.tsx"
 }

package/guidelines/modelSignal/modelSignal.generate.json

@@ -2,14 +2,14 @@
   "title": "Model Signal",
   "description": "Module signal generation rules",
   "group": "module",
-  "docsSource": "apps/angelo/page/akanjs/(docs)/conventions/module/signal.tsx",
+  "docsSource": "apps/akan/page/(docs)/conventions/module/signal.tsx",
   "codegenPriority": 2,
   "deprecated": false,
   "scans": [
     {
       "type": "docs",
       "description": "Current docs source for Model Signal",
-      "path": "apps/angelo/page/akanjs/(docs)/conventions/module/signal.tsx"
+      "path": "apps/akan/page/(docs)/conventions/module/signal.tsx"
     },
     {
       "type": "example",
@@ -20,18 +20,12 @@
   ],
   "update": {
     "filePath": "./modelSignal.instruction.md",
-    "contents": [
-      "purpose",
-      "file ownership",
-      "current API patterns",
-      "codegen rules",
-      "validation checklist"
-    ],
+    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
     "rules": [
       "Use current Akan APIs only",
       "Keep output parseable for codegen",
       "Include ownership boundaries and review checklist"
     ]
   },
-  "page": "apps/angelo/page/akanjs/(docs)/conventions/module/signal.tsx"
+  "page": "apps/akan/page/(docs)/conventions/module/signal.tsx"
 }

package/guidelines/modelStore/modelStore.generate.json

@@ -2,14 +2,14 @@
   "title": "Model Store",
   "description": "Module store generation rules",
   "group": "module",
-  "docsSource": "apps/angelo/page/akanjs/(docs)/conventions/module/store.tsx",
+  "docsSource": "apps/akan/page/(docs)/conventions/module/store.tsx",
   "codegenPriority": 2,
   "deprecated": false,
   "scans": [
     {
       "type": "docs",
       "description": "Current docs source for Model Store",
-      "path": "apps/angelo/page/akanjs/(docs)/conventions/module/store.tsx"
+      "path": "apps/akan/page/(docs)/conventions/module/store.tsx"
     },
     {
       "type": "example",
@@ -20,18 +20,12 @@
   ],
   "update": {
     "filePath": "./modelStore.instruction.md",
-    "contents": [
-      "purpose",
-      "file ownership",
-      "current API patterns",
-      "codegen rules",
-      "validation checklist"
-    ],
+    "contents": ["purpose", "file ownership", "current API patterns", "codegen rules", "validation checklist"],
     "rules": [
       "Use current Akan APIs only",
       "Keep output parseable for codegen",
       "Include ownership boundaries and review checklist"
     ]
   },
-  "page": "apps/angelo/page/akanjs/(docs)/conventions/module/store.tsx"
+  "page": "apps/akan/page/(docs)/conventions/module/store.tsx"
 }