You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: update installation and usage instructions for Forge CLI
- Clarified prerequisites by specifying the need for the Forge CLI in the first-app tutorial.
- Enhanced the installation guide to include detailed steps for installing the Forge CLI via various methods (Homebrew, Go, Scoop, binary download, Linux packages, Docker).
- Updated quick start guide to reflect the use of `forge dev` for running applications instead of `go run`.
- Added a new document for the Forge CLI, outlining its command structure, core commands, and quick start examples.
These changes improve the clarity and accessibility of the documentation, ensuring users have the necessary information to effectively use the Forge CLI.
Copy file name to clipboardExpand all lines: docs/content/docs/forge/first-app.mdx
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ In this tutorial, you will build a complete TODO REST API with CRUD operations,
20
20
21
21
## Prerequisites
22
22
23
-
Make sure you have completed the [Installation](/docs/forge/installation) guide and have Go 1.21+ installed.
23
+
Make sure you have completed the [Installation](/docs/forge/installation) guide, have Go 1.21+ installed, and have the Forge CLI available (`forge version`).
24
24
25
25
---
26
26
@@ -284,8 +284,8 @@ If a handler returns a plain `error` (not an `HTTPError`), Forge automatically w
284
284
Start the server and run through the full CRUD cycle:
Forge uses Go generics extensively for type-safe dependency injection. Go 1.21 or later is required.
20
20
</Callout>
21
21
22
-
## Install Forge
22
+
## Install the Forge CLI
23
+
24
+
The Forge CLI (`forge`) is the primary tool for developing, building, and managing Forge applications. It provides hot-reload development servers, code generation, database migrations, and more.
Copy file name to clipboardExpand all lines: docs/content/docs/forge/quick-start.mdx
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,7 @@ This guide walks you through creating your first Forge application from scratch.
14
14
15
15
<Callouttype="info">
16
16
Forge requires **Go 1.21 or later**. Check your version with `go version`.
17
+
Make sure you have the Forge CLI installed. See the [Installation](/docs/forge/installation) guide.
17
18
</Callout>
18
19
19
20
## Build Your First Server
@@ -81,10 +82,10 @@ func main() {
81
82
### Run your application
82
83
83
84
```bash
84
-
go run main.go
85
+
forge dev
85
86
```
86
87
87
-
You should see a startup banner with your application name, version, and the address it is listening on.
88
+
The Forge CLI starts a development server with hot reload enabled by default. You should see a startup banner with your application name, version, and the address it is listening on.
0 commit comments