@warpgogol/forge 0.16.0 → 0.17.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.
- package/README.md +61 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,7 +12,65 @@ pnpm add @warpgogol/forge
|
|
|
12
12
|
|
|
13
13
|
## Quick start
|
|
14
14
|
|
|
15
|
-
###
|
|
15
|
+
### For creative operators — no terminal needed
|
|
16
|
+
|
|
17
|
+
You don't need to know what a terminal is. You don't need to type a single command. If you have an AI-powered IDE (like Windsurf, Devin, or Cursor), Forge works entirely through conversation.
|
|
18
|
+
|
|
19
|
+
#### Start a new project from scratch
|
|
20
|
+
|
|
21
|
+
1. **Create an empty folder** on your computer — anywhere you like. Name it whatever you want your project to be called (use lowercase letters and hyphens, e.g. `my-brand-video`).
|
|
22
|
+
|
|
23
|
+
2. **Open that folder in your AI IDE.** The folder is empty — that's exactly what we want.
|
|
24
|
+
|
|
25
|
+
3. **Tell the AI agent what you want to build.** Just type it in the chat, in your own words. For example:
|
|
26
|
+
|
|
27
|
+
> I want to create a brand video for my coffee shop. It should have an animated logo, a short intro, and a product showcase.
|
|
28
|
+
|
|
29
|
+
Or:
|
|
30
|
+
|
|
31
|
+
> I want to build a website for my photography studio.
|
|
32
|
+
|
|
33
|
+
Or:
|
|
34
|
+
|
|
35
|
+
> I want to make a browser game where you catch falling stars.
|
|
36
|
+
|
|
37
|
+
That's it. The AI agent will do everything else:
|
|
38
|
+
- Install Forge and all necessary tools
|
|
39
|
+
- Set up the project structure based on what you described (video, website, game, etc.)
|
|
40
|
+
- Configure language preferences and project settings
|
|
41
|
+
- Start a live preview so you can see your work
|
|
42
|
+
- Tell you the URL to open in your browser
|
|
43
|
+
|
|
44
|
+
4. **Watch the preview.** The AI agent will give you a localhost link. Click it — your project is already running. As you describe changes, the agent updates the project and the preview refreshes automatically.
|
|
45
|
+
|
|
46
|
+
5. **Create together.** From here on, you just talk. Want a different color? Want to add a scene? Want to change the music? Just say it. The agent handles all the technical work.
|
|
47
|
+
|
|
48
|
+
#### Bring an existing project into Forge
|
|
49
|
+
|
|
50
|
+
If you already have a project somewhere else and want to move it into Forge:
|
|
51
|
+
|
|
52
|
+
1. **Create an empty folder** and open it in your AI IDE.
|
|
53
|
+
|
|
54
|
+
2. **Tell the AI agent:**
|
|
55
|
+
|
|
56
|
+
> I want to bring my existing project into Forge. It's located at /path/to/my/project.
|
|
57
|
+
|
|
58
|
+
The agent will:
|
|
59
|
+
- Detect what kind of project it is (website, video, game, etc.)
|
|
60
|
+
- Move all your files into the new Forge project — including hidden files like `.env`
|
|
61
|
+
- Optionally bring your git history
|
|
62
|
+
- Verify everything builds correctly
|
|
63
|
+
- Start a live preview
|
|
64
|
+
|
|
65
|
+
#### What if something goes wrong?
|
|
66
|
+
|
|
67
|
+
Just tell the AI agent. It can check the project's health, fix issues, and explain what happened — all in plain language. You never need to open a terminal or run commands yourself.
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
### For developers — CLI commands
|
|
72
|
+
|
|
73
|
+
#### Create a new project
|
|
16
74
|
|
|
17
75
|
```sh
|
|
18
76
|
# Create a new project (scaffold + init + skills + AGENTS.md in one command)
|
|
@@ -27,7 +85,7 @@ npx forge create my-video --profile editframe
|
|
|
27
85
|
npx forge create my-project --package-manager npm
|
|
28
86
|
```
|
|
29
87
|
|
|
30
|
-
|
|
88
|
+
#### Bring an existing project into Forge
|
|
31
89
|
|
|
32
90
|
There is no CLI command for transplant — it is an interactive, AI-guided process:
|
|
33
91
|
|
|
@@ -46,7 +104,7 @@ npx forge create my-project
|
|
|
46
104
|
# - Verify the build
|
|
47
105
|
```
|
|
48
106
|
|
|
49
|
-
|
|
107
|
+
#### Diagnose and validate
|
|
50
108
|
|
|
51
109
|
```sh
|
|
52
110
|
# Check project health
|