Skip to content

Commit 534b705

Browse files
author
bigmacfive
committed
Add copy-paste agent prompt docs
1 parent 19c51d4 commit 534b705

4 files changed

Lines changed: 103 additions & 3 deletions

File tree

README.ko.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,11 @@ appbun https://www.notion.so --package-manager npm
8989
appbun https://github.com --name "GitHub" --out-dir ./github --yes
9090
```
9191

92-
개발 중인 웹서비스 repo에서 에이전트에게 그대로 붙여넣을 프롬프트를 만들려면:
92+
개발 중인 웹서비스를 에이전트가 바로 데스크톱 앱으로 빼게 하고 싶다면, 아래 정적 프롬프트를 복붙하면 됩니다:
93+
94+
- [docs/agent-prompts/web-app-repo.ko.md](docs/agent-prompts/web-app-repo.ko.md)
95+
96+
특정 로컬 URL 기준으로 `appbun`이 프롬프트를 미리 채워주게 하려면:
9397

9498
```bash
9599
appbun prompt http://localhost:3000 --name "My App"

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,13 +89,17 @@ Skip confirmation prompts in scripted runs:
8989
appbun https://github.com --name "GitHub" --out-dir ./github --yes
9090
```
9191

92-
Generate a copy-paste prompt for a coding agent that is working inside your web app repo:
92+
If you are building a web app and want a coding agent to turn it into a desktop app for you, copy the prompt from:
93+
94+
- [docs/agent-prompts/web-app-repo.md](docs/agent-prompts/web-app-repo.md)
95+
96+
If you want `appbun` to prefill that prompt for a specific local URL, use:
9397

9498
```bash
9599
appbun prompt http://localhost:3000 --name "My App"
96100
```
97101

98-
That outputs an instruction block telling the agent to package the current web app into `./desktop/my-app` with `appbun@latest`, then build it.
102+
That outputs a ready-to-paste instruction block telling the agent to package the current web app into `./desktop/my-app` with `appbun@latest`, then build it.
99103

100104
## Showcase
101105

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Web App Repo Prompt
2+
3+
현재 개발 중인 웹앱을 데스크톱 앱으로 뽑고 싶을 때, 아래 프롬프트를 그대로 복사해서 코딩 에이전트에게 넣으면 됩니다.
4+
5+
```text
6+
You are working inside the repository of an existing web app.
7+
8+
Create a desktop app wrapper for this app using `appbun`.
9+
10+
Inputs you must fill in before running:
11+
- Web app URL to package: [WEB_APP_URL]
12+
- App name: [APP_NAME]
13+
- Desktop wrapper output directory inside this repo: ./desktop/[APP_SLUG]
14+
- Window size: [WIDTH]x[HEIGHT]
15+
- Theme color: [THEME_COLOR]
16+
17+
Rules:
18+
- Treat the current repository as the source web app project.
19+
- Use `appbun@latest`; do not hand-roll the wrapper unless appbun output needs a specific fix.
20+
- Put the generated desktop wrapper inside this repo so the team can version it together.
21+
- If the URL points to a local dev server, make sure the dev server is running and reachable before packaging.
22+
- Keep the generated project inspectable and editable.
23+
- Preserve site branding and icon metadata when available.
24+
- If the output directory already exists, prefer a safe non-destructive path or explicit confirmation.
25+
- On macOS, include the DMG packaging step.
26+
27+
Execution plan:
28+
1. 필요하면 현재 웹앱 dev server를 띄우고 [WEB_APP_URL]이 실제로 열리는지 확인한다.
29+
2. 아래 명령을 실행한다.
30+
npx -y appbun@latest [WEB_APP_URL] --name "[APP_NAME]" --out-dir ./desktop/[APP_SLUG] --width [WIDTH] --height [HEIGHT] --theme-color [THEME_COLOR] --yes
31+
3. 생성된 wrapper 디렉터리로 이동한다.
32+
cd ./desktop/[APP_SLUG]
33+
4. 의존성을 설치한다.
34+
bun install
35+
5. 데스크톱 wrapper를 빌드한다.
36+
bun run build
37+
6. macOS라면 DMG도 만든다.
38+
bun run build:dmg
39+
7. 필요하면 wrapper를 다시 빌드하는 방법을 README에 짧게 적는다.
40+
41+
When you reply, include:
42+
- what command you ran
43+
- where the generated project was written
44+
- what metadata or icons were detected
45+
- what still needs manual attention, if anything
46+
```

docs/agent-prompts/web-app-repo.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Web App Repo Prompt
2+
3+
Copy the prompt below into your coding agent when you want it to turn the web app you are currently building into a desktop app.
4+
5+
```text
6+
You are working inside the repository of an existing web app.
7+
8+
Create a desktop app wrapper for this app using `appbun`.
9+
10+
Inputs you must fill in before running:
11+
- Web app URL to package: [WEB_APP_URL]
12+
- App name: [APP_NAME]
13+
- Desktop wrapper output directory inside this repo: ./desktop/[APP_SLUG]
14+
- Window size: [WIDTH]x[HEIGHT]
15+
- Theme color: [THEME_COLOR]
16+
17+
Rules:
18+
- Treat the current repository as the source web app project.
19+
- Use `appbun@latest`; do not hand-roll the wrapper unless appbun output needs a specific fix.
20+
- Put the generated desktop wrapper inside this repo so the team can version it together.
21+
- If the URL points to a local dev server, make sure the dev server is running and reachable before packaging.
22+
- Keep the generated project inspectable and editable.
23+
- Preserve site branding and icon metadata when available.
24+
- If the output directory already exists, prefer a safe non-destructive path or explicit confirmation.
25+
- On macOS, include the DMG packaging step.
26+
27+
Execution plan:
28+
1. If needed, start the current web app and verify [WEB_APP_URL] loads.
29+
2. Run:
30+
npx -y appbun@latest [WEB_APP_URL] --name "[APP_NAME]" --out-dir ./desktop/[APP_SLUG] --width [WIDTH] --height [HEIGHT] --theme-color [THEME_COLOR] --yes
31+
3. Change into the generated wrapper directory:
32+
cd ./desktop/[APP_SLUG]
33+
4. Install dependencies:
34+
bun install
35+
5. Build the desktop wrapper:
36+
bun run build
37+
6. On macOS, also build the DMG:
38+
bun run build:dmg
39+
7. If useful, add a short README note explaining how to rebuild the desktop wrapper.
40+
41+
When you reply, include:
42+
- what command you ran
43+
- where the generated project was written
44+
- what metadata or icons were detected
45+
- what still needs manual attention, if anything
46+
```

0 commit comments

Comments
 (0)