updates

Author: Xun Zhou

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## v3.47.6 - 2025-12-25
+
+- **update the documentation**: update the documentation to the latest version
+- **update homebrew tap**: add taskr homebrew tap and add the newest version
+
+## v3.47.5 - 2025-12-24
+- **Add banner config**: enable banner feature
+
 ## v3.46.3 - 2025-12-22
 
 - **Add index**: sort the task by given task index

website/src/docs/getting-started.md

@@ -15,22 +15,22 @@ haven't installed Task yet, head over to our [installation guide](installation).
 Once Task is installed, you can create your first Taskfile by running:
 
 ```shell
-task --init
+taskr --init
 ```
 
 This will create a file called `Taskfile.yml` in the current directory. If you
 want to create the file in another directory, you can pass an absolute or
 relative path to the directory into the command:
 
 ```shell
-task --init ./subdirectory
+taskr --init ./subdirectory
 ```
 
 Or if you want the Taskfile to have a specific name, you can pass in the name of
 the file:
 
 ```shell
-task --init Custom.yml
+taskr --init Custom.yml
 ```
 
 This will create a Taskfile that looks something like this:
@@ -81,14 +81,14 @@ the absolute or relative path to the directory as an argument using the `--dir`
 flag:
 
 ```shell
-task --dir ./subdirectory
+taskr --dir ./subdirectory
 ```
 
 Or if you created a Taskfile with a different name, you can run it by passing
 the name of the Taskfile as an argument using the `--taskfile` flag:
 
 ```shell
-task --taskfile Custom.yml
+taskr --taskfile Custom.yml
 ```
 
 ## Adding a build task
@@ -105,21 +105,48 @@ called must be available as a built-in or in the system's `PATH`.
 When you're done, it should look something like this:
 
 ```yaml
-version: '3'
+version: "3"
+banner: true
+project: myApp
+categories: ["docker"]
 
 vars:
-  GREETING: Hello, World!
+  DC: docker compose -f docker/docker-compose.yml
+  DC_EXEC_APP: "{{.DC}} exec app"
+
+env:
+  SHELL: /bin/bash
 
 tasks:
-  default:
-    desc: Print a greeting message
+  run:
+    desc: Run API server with hot-reload
+    category: dev
+    index: 2
     cmds:
-      - echo "{{.GREETING}}"
-    silent: true
+      - "{{.DC_EXEC_APP}} air"
 
   build:
+    desc: Build Go application
+    deps: [setup-dirs]
+    category: dev
+    index: 1
     cmds:
-      - go build ./cmd/main.go
+      - '{{.DC_EXEC_APP}} go build -ldflags="-w -s" -o {{.OUT_DIR}}/api ./cmd/api'
+    silent: true
+
+  tidy:
+    category: dependencies
+    desc: Tidy and verify dependencies
+    cmds:
+      - "{{.DC_EXEC_APP}} go mod tidy"
+    silent: true
+
+  logs:
+    category: docker
+    desc: Follow logs from all services
+    cmds:
+      - "{{.DC}} logs -f"
+
 ```
 
 Call the task by running:

website/src/docs/guide.md

@@ -99,9 +99,9 @@ from stdin, you must specify the `-t/--taskfile` flag with the special `-`
 value. You may then pipe into Task as you would any other program:
 
 ```shell
-task -t - <(cat ./Taskfile.yml)
+taskr -t - <(cat ./Taskfile.yml)
 # OR
-cat ./Taskfile.yml | task -t -
+cat ./Taskfile.yml | taskr -t -
 ```
 
 ## Environment variables
@@ -341,7 +341,7 @@ tasks:
 If you run `task -a` it will print :
 
 ```sh
-task: Available tasks for this project:
+taskr: Available tasks for this project:
 * greet:
 * foo
 ```
@@ -1187,7 +1187,7 @@ listed below (most important first):
 Example of sending parameters with environment variables:
 
 ```shell
-$ TASK_VARIABLE=a-value task do-something
+$ TASK_VARIABLE=a-value taskr do-something
 ```
 
 ::: tip
@@ -1201,7 +1201,7 @@ Since some shells do not support the above syntax to set environment variables
 command.
 
 ```shell
-$ task write-file FILE=file.txt "CONTENT=Hello, World!" print "MESSAGE=All done!"
+$ taskr write-file FILE=file.txt "CONTENT=Hello, World!" print "MESSAGE=All done!"
 ```
 
 Example of locally declared vars:
@@ -1758,14 +1758,14 @@ and store the result in the `.SERVICE` variable which is then echoed out in the
 cmds:
 
 ```shell
-$ task start:foo
+$ taskr start:foo
 Starting foo
 ```
 
 You can use whitespace in your arguments as long as you quote the task name:
 
 ```shell
-$ task "start:foo bar"
+$ taskr "start:foo bar"
 Starting foo bar
 ```
 
@@ -1774,7 +1774,7 @@ be used. If you are using included Taskfiles, tasks in parent files will be
 considered first.
 
 ```shell
-$ task start:foo:3
+$ taskr start:foo:3
 Starting foo with 3 replicas
 ```
 
@@ -2002,8 +2002,8 @@ tasks:
 ```
 
 ```shell
-❯ task dangerous
-task: "This is a dangerous command... Do you want to continue?" [y/N]
+❯ taskr dangerous
+taskr: "This is a dangerous command... Do you want to continue?" [y/N]
 ```
 
 Prompts can be a single value or a list of prompts, like below:
@@ -2029,7 +2029,7 @@ will exit with [exit code](/docs/reference/cli#exit-codes) 205. If approved,
 Task will continue as normal.
 
 ```shell
-❯ task example
+❯ taskr example
 not dangerous command
 task: "This is a dangerous command. Do you want to continue?" [y/N]
 y
@@ -2220,7 +2220,7 @@ tasks:
 ```
 
 ```shell
-$ task default
+$ taskr default
 ::group::default
 Hello, World!
 ::endgroup::
@@ -2245,8 +2245,8 @@ tasks:
 ```
 
 ```shell
-$ task passes
-$ task errors
+$ taskr passes
+$ taskr errors
 output-of-errors
 task: Failed to run task "errors": exit status 1
 ```
@@ -2278,7 +2278,7 @@ tasks:
 ```
 
 ```shell
-$ task default
+$ taskr default
 [print-foo] foo
 [print-bar] bar
 [print-baz] baz