create-akan-workspace 3.3.0-rc.0 → 3.3.0-rc.10

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 +27 -1
  2. package/README.md +28 -1
  3. package/package.json +2 -1
package/README.ko.md CHANGED
@@ -8,6 +8,13 @@
8
8
  bunx create-akan-workspace@latest
9
9
  ```
10
10
 
11
+ Node와 npm만 있는 호스트에서는 npx로 실행하세요. 전역에 아무것도 설치하지 않습니다
12
+ ([자세히](#node와-npm만-있을-때)).
13
+
14
+ ```bash
15
+ npx -y bun@1.4.4 x create-akan-workspace@latest
16
+ ```
17
+
11
18
  이 패키지와 같은 버전의 `akan` CLI(`@akanjs/cli`)를 전역으로 설치한 뒤 `akan create-workspace`를 실행합니다.
12
19
  이 명령은 다음을 합니다.
13
20
 
@@ -37,6 +44,25 @@ bunx create-akan-workspace@latest my-company --app web
37
44
  확인하고, 이 명령을 실행하고, 앱까지 띄웁니다. 끝나면 새 워크스페이스 안에서 에이전트를 다시 여세요. MCP 서버와
38
45
  규칙은 거기서 로드됩니다.
39
46
 
47
+ ## Node와 npm만 있을 때
48
+
49
+ 생성기에는 Bun이 필요한데, 그 한 번의 실행은 npx가 Bun을 대신 받아 줍니다. 이름을 넘기면 아무것도 묻지 않습니다.
50
+
51
+ ```bash
52
+ npx -y bun@1.4.4 x create-akan-workspace@latest . --app <app> --dir <folder> --sample false
53
+ ```
54
+
55
+ 그 Bun은 이후 `PATH`에 없으므로 생성기가 워크스페이스의 `dependencies`에 `bun`을 넣고 package script 두 개를 씁니다.
56
+ `npm run build`로 빌드하고, `PORT=3000 npm start`로 빌드를 띄우고, 다른 명령은 `npx akan …`으로 실행하세요.
57
+
58
+ ```json
59
+ "build": "akan build <app>",
60
+ "start": "cd dist/apps/<app> && bun main.js"
61
+ ```
62
+
63
+ 새로 clone한 사본도 그대로 빌드됩니다. env 파일은 gitignore된 채로 두면 `akan`이 없는 것을 만들어 주므로 커밋할
64
+ 필요가 없습니다. 빌드에 필요한 env가 함께 들어 있고, 실행할 때 지정한 변수가 그 값을 덮어씁니다.
65
+
40
66
  ## 기존 폴더에 만들기
41
67
 
42
68
  워크스페이스 이름을 `.`으로 주면 하위 폴더를 새로 만들지 않고 현재 폴더나 `--dir` 폴더에 바로 만듭니다. 워크스페이스
@@ -64,7 +90,7 @@ bunx create-akan-workspace@latest my-company --app web --sample false # 샘플
64
90
 
65
91
  ## 요구사항
66
92
 
67
- - [Bun](https://bun.sh) `>=1.4.4`
93
+ - [Bun](https://bun.sh) `>=1.4.4`. 없으면 Node의 npx로 [위와 같이](#node와-npm만-있을-때) 실행
68
94
  - 첫 커밋을 위한 Git
69
95
 
70
96
  ## 더 알아보기
package/README.md CHANGED
@@ -8,6 +8,13 @@ Create a new [Akan.js](https://akanjs.com) workspace with one command.
8
8
  bunx create-akan-workspace@latest
9
9
  ```
10
10
 
11
+ On a host with only Node and npm, run it through npx, which installs nothing global
12
+ ([details](#with-only-node-and-npm)):
13
+
14
+ ```bash
15
+ npx -y bun@1.4.4 x create-akan-workspace@latest
16
+ ```
17
+
11
18
  It installs the `akan` CLI (`@akanjs/cli`, at this package's own version) globally, then runs
12
19
  `akan create-workspace`, which:
13
20
 
@@ -38,6 +45,26 @@ The [quick start](https://akanjs.com/docs/intro/quickstart) has a prompt to past
38
45
  checks Bun, runs this, and starts the app. Reopen the agent inside the new workspace afterwards: its MCP server and
39
46
  rules load from there.
40
47
 
48
+ ## With Only Node and npm
49
+
50
+ The creator needs Bun, and npx can supply it for the one run. Pass the names so nothing is asked:
51
+
52
+ ```bash
53
+ npx -y bun@1.4.4 x create-akan-workspace@latest . --app <app> --dir <folder> --sample false
54
+ ```
55
+
56
+ That Bun is not on `PATH` afterwards, so the creator lists `bun` in the workspace's `dependencies` and writes two
57
+ package scripts. Build with `npm run build`, start the build with `PORT=3000 npm start`, and run any other command as
58
+ `npx akan …`.
59
+
60
+ ```json
61
+ "build": "akan build <app>",
62
+ "start": "cd dist/apps/<app> && bun main.js"
63
+ ```
64
+
65
+ A fresh clone builds as is: the env files stay gitignored and `akan` writes the ones it lacks, so commit none. The
66
+ build carries the env it needs, and a variable set at start overrides it.
67
+
41
68
  ## In an Existing Folder
42
69
 
43
70
  Name the workspace `.` to create it in the current folder, or in `--dir` itself, instead of a new subfolder. The
@@ -66,7 +93,7 @@ bunx create-akan-workspace@latest my-company --app web --sample false # no sam
66
93
 
67
94
  ## Requirements
68
95
 
69
- - [Bun](https://bun.sh) `>=1.4.4`
96
+ - [Bun](https://bun.sh) `>=1.4.4`, or Node with npx to run it [as above](#with-only-node-and-npm)
70
97
  - Git, for the first commit
71
98
 
72
99
  ## Learn More
package/package.json CHANGED
@@ -1,13 +1,14 @@
1
1
  {
2
2
  "sourceType": "module",
3
3
  "name": "create-akan-workspace",
4
- "version": "3.3.0-rc.0",
4
+ "version": "3.3.0-rc.10",
5
5
  "bin": {
6
6
  "create-akan-workspace": "index.js"
7
7
  },
8
8
  "publishConfig": {
9
9
  "access": "public"
10
10
  },
11
+ "description": "Create an Akan.js workspace: bunx create-akan-workspace@latest, or with only Node and npm: npx -y bun@1.4.4 x create-akan-workspace@latest",
11
12
  "homepage": "https://akanjs.com",
12
13
  "license": "MIT",
13
14
  "repository": {