create-akan-workspace 3.0.0-beta.9 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.ko.md +39 -33
  2. package/README.md +40 -77
  3. package/package.json +1 -1
package/README.ko.md CHANGED
@@ -1,58 +1,64 @@
1
- # Create Akan Workspace
1
+ # create-akan-workspace
2
2
 
3
- 새 Akan.js 워크스페이스를 가장 빠르게 만드는 스캐폴딩 패키지입니다. 이 패키지는 Akan.js CLI를 설치하고
4
- 워크스페이스 생성 마법사를 실행하는 단일 진입점을 제공합니다.
3
+ [English](https://github.com/akan-team/akanjs/blob/main/pkgs/create-akan-workspace/README.md) | [문서](https://akanjs.com/docs/intro/quickstart) | [npm](https://www.npmjs.com/package/create-akan-workspace)
5
4
 
6
- ## 시작하기
5
+ 명령 하나로 새 [Akan.js](https://akanjs.com) 워크스페이스를 만듭니다.
7
6
 
8
7
  ```bash
9
- bunx create-akan-workspace
8
+ bunx create-akan-workspace@latest
10
9
  ```
11
10
 
12
- 이 명령은 다음 작업을 수행합니다.
11
+ 이 패키지와 같은 버전의 `akan` CLI(`@akanjs/cli`)를 전역으로 설치한 뒤 `akan create-workspace`를 실행합니다.
12
+ 이 명령은 다음을 합니다.
13
13
 
14
- 1. 최신 `akanjs` CLI 설치
15
- 2. 인터랙티브 워크스페이스 생성 마법사 실행
16
- 3. 개발 환경과 초기 애플리케이션 구성
14
+ 1. 워크스페이스 이름과 앱 이름을 묻습니다. 미리 넘겼다면 묻지 않습니다.
15
+ 2. `./<workspace>`를 만들고 의존성을 설치합니다.
16
+ 3. 샘플 `task` 모듈과 페이지가 들어 있는 첫 앱을 만듭니다.
17
+ 4. `AGENTS.md`, `CLAUDE.md`, Cursor 규칙을 쓰고, Claude Code·Codex·Cursor에 Akan MCP 서버를 등록합니다.
18
+ 5. 첫 git 커밋을 만듭니다.
17
19
 
18
- ## 예시
20
+ 그다음 앱을 실행하면 `http://localhost:8282`에서 열립니다.
19
21
 
20
22
  ```bash
21
- # 인터랙티브 모드
22
- bunx create-akan-workspace
23
+ cd <workspace>
24
+ akan start <app> --open
25
+ ```
26
+
27
+ ## 코딩 에이전트로 시작하기
23
28
 
24
- # 조직 이름 지정
25
- bunx create-akan-workspace "my-company"
29
+ 두 이름을 모두 넘기면 아무것도 묻지 않으므로, 코딩 에이전트가 혼자 실행할 수 있습니다.
26
30
 
27
- # 앱 이름과 대상 경로 지정
28
- bunx create-akan-workspace "my-company" --app "web-app" --dir "./projects"
31
+ ```bash
32
+ bunx create-akan-workspace@latest my-company --app web
29
33
  ```
30
34
 
35
+ [시작하기](https://akanjs.com/docs/intro/quickstart)에 Claude Code나 Codex에 붙여 넣을 프롬프트가 있습니다. Bun을
36
+ 확인하고, 이 명령을 실행하고, 앱까지 띄웁니다. 끝나면 새 워크스페이스 안에서 에이전트를 다시 여세요. MCP 서버와
37
+ 규칙은 거기서 로드됩니다.
38
+
31
39
  ## 옵션
32
40
 
33
- | Option | Description | Example |
41
+ | 옵션 | 설명 | 기본값 |
34
42
  | --- | --- | --- |
35
- | `[org]` | 조직 이름 | `my-company` |
36
- | `-a, --app <name>` | 초기 애플리케이션 이름 | `--app web-app` |
37
- | `-d, --dir <path>` | 생성 대상 경로 | `--dir ./projects` |
43
+ | `[org]` | 워크스페이스(조직) 이름 | 물어봄 |
44
+ | `-a, --app <name>` | 첫 애플리케이션 이름 | 물어봄 |
45
+ | `-d, --dir <path>` | 워크스페이스를 만들 디렉터리 | `.` |
46
+ | `-l, --libs <boolean>` | `shared`, `util` 라이브러리(관리자, 사용자, 파일 등)도 설치 | `false` |
47
+ | `-i, --init <boolean>` | 워크스페이스 의존성 설치 | `true` |
48
+ | `-r, --registry <url>` | Akan 패키지를 받을 npm 레지스트리(또는 `AKAN_NPM_REGISTRY`) | npmjs |
49
+ | `-o, --owner <name>` | 워크스페이스 소유자 | — |
38
50
 
39
51
  ## 요구사항
40
52
 
41
- - Bun `>=1.3`
42
-
43
- ## 다음 단계
53
+ - [Bun](https://bun.sh) `>=1.4.0`
54
+ - 첫 커밋을 위한 Git
44
55
 
45
- ```bash
46
- cd <workspace-name>
47
- akan start <app-name> --open
48
- ```
49
-
50
- 프로덕션 빌드는 다음 명령으로 확인할 수 있습니다.
56
+ ## 더 알아보기
51
57
 
52
- ```bash
53
- akan build <app-name>
54
- ```
58
+ - [시작하기](https://akanjs.com/docs/intro/quickstart)
59
+ - [`akanjs`](https://www.npmjs.com/package/akanjs): 프레임워크
60
+ - [`@akanjs/cli`](https://www.npmjs.com/package/@akanjs/cli): `akan` 명령
55
61
 
56
62
  ## 라이선스
57
63
 
58
- 이 패키지는 Akan.js 생태계의 일부이며 MIT 라이선스를 따릅니다.
64
+ MIT
package/README.md CHANGED
@@ -1,102 +1,65 @@
1
- # 🚀 Create Akan Workspace
1
+ # create-akan-workspace
2
2
 
3
- The quickest way to bootstrap a new Akan.js workspace with a single command. This package provides a streamlined entry point that automatically installs the Akan.js CLI and creates your workspace in one step.
3
+ [한국어](https://github.com/akan-team/akanjs/blob/main/pkgs/create-akan-workspace/README.ko.md) | [Docs](https://akanjs.com/docs/intro/quickstart) | [npm](https://www.npmjs.com/package/create-akan-workspace)
4
4
 
5
- ## ⚡ Get Started
6
-
7
- The fastest way to create a new Akan.js workspace:
5
+ Create a new [Akan.js](https://akanjs.com) workspace with one command.
8
6
 
9
7
  ```bash
10
- bunx create-akan-workspace
8
+ bunx create-akan-workspace@latest
11
9
  ```
12
10
 
13
- That's it! This single command will:
11
+ It installs the `akan` CLI (`@akanjs/cli`, at this package's own version) globally, then runs
12
+ `akan create-workspace`, which:
14
13
 
15
- 1. Install the latest `akanjs` globally
16
- 2. Run the interactive workspace creation wizard
17
- 3. Set up your development environment
14
+ 1. asks for a workspace name and an app name, unless you passed them,
15
+ 2. creates `./<workspace>` and installs its dependencies,
16
+ 3. generates the first app with a sample `task` module and pages,
17
+ 4. writes `AGENTS.md`, `CLAUDE.md` and Cursor rules, and registers the Akan MCP server for Claude Code, Codex and
18
+ Cursor,
19
+ 5. makes the first git commit.
18
20
 
19
- ### Quick Setup Examples
21
+ Then start the app. It opens on `http://localhost:8282`.
20
22
 
21
23
  ```bash
22
- # Interactive mode (recommended)
23
- bunx create-akan-workspace
24
-
25
- # Specify organization name
26
- bunx create-akan-workspace "my-company"
27
-
28
- # Full setup with options
29
- bunx create-akan-workspace "my-company" --app "web-app" --dir "./projects"
24
+ cd <workspace>
25
+ akan start <app> --open
30
26
  ```
31
27
 
32
- ## 📋 Options
33
-
34
- | Option | Description | Example |
35
- | ------------------ | ------------------------------ | ------------------ |
36
- | `[org]` | Organization name (positional) | `my-company` |
37
- | `-a, --app <name>` | Initial application name | `--app web-app` |
38
- | `-d, --dir <path>` | Target directory | `--dir ./projects` |
39
-
40
- ## 🎯 What Happens Next
28
+ ## With Your Coding Agent
41
29
 
42
- After running `create-akan-workspace`, you'll have:
43
-
44
- 1. **✅ Akan.js CLI installed globally** - Access to all `akan` commands
45
- 2. **🏗️ Workspace created** - Organized project structure
46
- 3. **📱 Initial application** - Ready-to-run starter app
47
- 4. **🔧 Development environment** - Configured tooling and dependencies
48
-
49
- ### Start developing immediately:
30
+ Pass both names and nothing is asked, so a coding agent can run it on its own:
50
31
 
51
32
  ```bash
52
- cd <workspace-name>
53
- akan start <app-name> --open
54
- ```
55
-
56
- Navigate to http://localhost:4200 to see your app running!
57
-
58
- ## 🛠️ Requirements
59
-
60
- - **Bun.js** >=1.3
61
-
62
- ## 🔗 What's Next?
63
-
64
- After creating your workspace, explore the full power of Akan.js CLI:
65
-
66
- ```bash
67
- # AI-powered module creation
68
- akan create-module
69
-
70
- # Set up AI assistant
71
- akan set-llm
72
-
73
- # Build for production
74
- akan build <app-name>
33
+ bunx create-akan-workspace@latest my-company --app web
75
34
  ```
76
35
 
77
- ## 📚 Learn More
36
+ The [quick start](https://akanjs.com/docs/intro/quickstart) has a prompt to paste into Claude Code or Codex that
37
+ checks Bun, runs this, and starts the app. Reopen the agent inside the new workspace afterwards: its MCP server and
38
+ rules load from there.
78
39
 
79
- - [`akanjs`](../akanjs) - Full CLI documentation and features
80
- - [Akan.js Documentation](https://docs.akanjs.com) - Complete development guide
81
- - [Examples](https://github.com/akan-team/examples) - Sample projects and tutorials
40
+ ## Options
82
41
 
83
- ## 🤝 Contributing
42
+ | Option | Description | Default |
43
+ | --- | --- | --- |
44
+ | `[org]` | Workspace (organization) name | asked |
45
+ | `-a, --app <name>` | First application name | asked |
46
+ | `-d, --dir <path>` | Directory to create the workspace in | `.` |
47
+ | `-l, --libs <boolean>` | Also install the `shared` and `util` libraries (admin, user, file, and more) | `false` |
48
+ | `-i, --init <boolean>` | Install the workspace's dependencies | `true` |
49
+ | `-r, --registry <url>` | npm registry for the Akan packages (or `AKAN_NPM_REGISTRY`) | npmjs |
50
+ | `-o, --owner <name>` | Owner of the workspace | — |
84
51
 
85
- This package is part of the Akan.js ecosystem. Contributions are welcome!
52
+ ## Requirements
86
53
 
87
- 1. Fork the repository
88
- 2. Create your feature branch
89
- 3. Commit your changes
90
- 4. Push to the branch
91
- 5. Open a Pull Request
54
+ - [Bun](https://bun.sh) `>=1.4.0`
55
+ - Git, for the first commit
92
56
 
93
- ## 📄 License
57
+ ## Learn More
94
58
 
95
- This project is part of the Akan.js ecosystem. See the main repository for license information.
59
+ - [Quick start](https://akanjs.com/docs/intro/quickstart)
60
+ - [`akanjs`](https://www.npmjs.com/package/akanjs), the framework
61
+ - [`@akanjs/cli`](https://www.npmjs.com/package/@akanjs/cli), the `akan` command
96
62
 
97
- ---
63
+ ## License
98
64
 
99
- <p align="center">
100
- <strong>Built with ❤️ by the Akan.js team</strong><br>
101
- <em></em>
102
- </p>
65
+ MIT
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "sourceType": "module",
3
3
  "name": "create-akan-workspace",
4
- "version": "3.0.0-beta.9",
4
+ "version": "3.0.0",
5
5
  "bin": {
6
6
  "create-akan-workspace": "index.js"
7
7
  },