Skip to content

Commit df16706

Browse files
update keyword dgrkt to quickstart
1 parent 30b7754 commit df16706

13 files changed

Lines changed: 80 additions & 80 deletions

File tree

.gitignore

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,10 +114,10 @@ fabric.properties
114114
.taskpid.yaml
115115
test-env/
116116
logs/
117-
dgrkt
118-
dgrkt*.exe
119-
dgrkt-portable
120-
dgrkt-portable*.exe
117+
quickstart
118+
quickstart*.exe
119+
quickstart-portable
120+
quickstart-portable*.exe
121121
# Added by goreleaser init:
122122
dist/
123123
.tmp/

.goreleaser.yaml

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ universal_binaries:
1313
- replace: false
1414

1515
builds:
16-
- id: "dgrkt-cli-build"
17-
binary: "dgrkt"
16+
- id: "quickstart-cli-build"
17+
binary: "quickstart"
1818
env:
1919
- CGO_ENABLED=0
2020
goos:
@@ -36,8 +36,8 @@ builds:
3636
- -X {{.ModulePath}}/app.BuildDate={{.CommitDate}}
3737
- -X {{.ModulePath}}/app.Portable=false
3838
mod_timestamp: "{{ .CommitTimestamp }}"
39-
- id: "dgrkt-portable-build"
40-
binary: "dgrkt-portable"
39+
- id: "quickstart-portable-build"
40+
binary: "quickstart-portable"
4141
env:
4242
- CGO_ENABLED=0
4343
goos:
@@ -61,10 +61,10 @@ builds:
6161
mod_timestamp: "{{ .CommitTimestamp }}"
6262

6363
archives:
64-
- id: "dgrkt-cli-archive"
64+
- id: "quickstart-cli-archive"
6565
formats: ['tar.gz']
6666
ids:
67-
- dgrkt-cli-build
67+
- quickstart-cli-build
6868
name_template: "{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}{{ if .Arm }}v{{ .Arm }}{{ end }}"
6969
format_overrides:
7070
- goos: windows
@@ -76,10 +76,10 @@ archives:
7676
group: root
7777
owner: root
7878
mtime: "{{ .CommitDate }}"
79-
- id: "dgrkt-portable-archive"
79+
- id: "quickstart-portable-archive"
8080
formats: ['tar.gz']
8181
ids:
82-
- dgrkt-portable-build
82+
- quickstart-portable-build
8383
name_template: "{{ .ProjectName }}-portable_{{ .Version }}_{{ .Os }}_{{ .Arch }}{{ if .Arm }}v{{ .Arm }}{{ end }}"
8484
format_overrides:
8585
- goos: windows
@@ -104,34 +104,34 @@ release:
104104

105105

106106
homebrew_casks:
107-
- name: dgrkt
107+
- name: quickstart
108108
repository:
109109
owner: TPIsoftwareOSPO
110110
name: homebrew-tap
111111
homepage: "https://github.com/TPIsoftwareOSPO/quickstart"
112112
description: "Designed to orchestrate and execute a series of commands based on a declarative YAML configuration file."
113113
ids:
114-
- dgrkt-cli-archive
114+
- quickstart-cli-archive
115115

116116
scoops:
117117
- repository:
118118
owner: TPIsoftwareOSPO
119119
name: scoop-bucket
120-
name: dgrkt
120+
name: quickstart
121121
directory: bucket
122122
homepage: "https://github.com/TPIsoftwareOSPO/quickstart"
123123
description: "A command orchestration tool for declarative task execution."
124124
ids:
125-
- dgrkt-cli-archive
125+
- quickstart-cli-archive
126126

127127
dockers:
128-
- id: "dgrkt-docker-amd64"
128+
- id: "quickstart-docker-amd64"
129129
ids:
130-
- dgrkt-cli-build
130+
- quickstart-cli-build
131131
use: buildx
132132
goarch: amd64
133133
image_templates:
134-
- "tpisoftwareopensource/dgrkt:{{ .Version }}-amd64"
134+
- "tpisoftwareopensource/quickstart:{{ .Version }}-amd64"
135135
dockerfile: Dockerfile
136136
build_flag_templates:
137137
- "--pull"
@@ -145,11 +145,11 @@ dockers:
145145
extra_files:
146146
- README.md
147147
- LICENSE
148-
- id: "dgrkt-docker-arm64"
148+
- id: "quickstart-docker-arm64"
149149
use: buildx
150150
goarch: arm64
151151
image_templates:
152-
- "tpisoftwareopensource/dgrkt:{{ .Version }}-arm64"
152+
- "tpisoftwareopensource/quickstart:{{ .Version }}-arm64"
153153
dockerfile: Dockerfile
154154
build_flag_templates:
155155
- "--pull"
@@ -165,14 +165,14 @@ dockers:
165165
- LICENSE
166166

167167
docker_manifests:
168-
- name_template: "tpisoftwareopensource/dgrkt:{{ .Version }}"
168+
- name_template: "tpisoftwareopensource/quickstart:{{ .Version }}"
169169
image_templates:
170-
- "tpisoftwareopensource/dgrkt:{{ .Version }}-amd64"
171-
- "tpisoftwareopensource/dgrkt:{{ .Version }}-arm64"
172-
- name_template: "tpisoftwareopensource/dgrkt:latest"
170+
- "tpisoftwareopensource/quickstart:{{ .Version }}-amd64"
171+
- "tpisoftwareopensource/quickstart:{{ .Version }}-arm64"
172+
- name_template: "tpisoftwareopensource/quickstart:latest"
173173
image_templates:
174-
- "tpisoftwareopensource/dgrkt:{{ .Version }}-amd64"
175-
- "tpisoftwareopensource/dgrkt:{{ .Version }}-arm64"
174+
- "tpisoftwareopensource/quickstart:{{ .Version }}-amd64"
175+
- "tpisoftwareopensource/quickstart:{{ .Version }}-arm64"
176176

177177

178178
snapshot:
@@ -184,11 +184,11 @@ gomod:
184184
report_sizes: true
185185

186186
sboms:
187-
- id: dgrkt-sbom
187+
- id: quickstart-sbom
188188
disable: false
189189
ids:
190-
- dgrkt-cli-archive
191-
- dgrkt-portable-archive
190+
- quickstart-cli-archive
191+
- quickstart-portable-archive
192192
documents:
193193
- "${artifact}.sbom.json"
194194

Dockerfile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,18 @@ WORKDIR /app
1515

1616
# 複製由 GoReleaser 編譯好的主要二進制文件。
1717
# GoReleaser 會在執行 Docker build 時,將這個二進制文件放在 Docker build context 的根目錄。
18-
# 根據你的 builds.binary: "dgrkt" 設定,複製後的檔案名就是 "dgrkt"。
19-
COPY dgrkt .
18+
# 根據你的 builds.binary: "quickstart" 設定,複製後的檔案名就是 "quickstart"。
19+
COPY quickstart .
2020

2121
# 複製任何你在 .goreleaser.yaml 的 dockers.extra_files 中指定的額外文件。
2222
# 這些文件也會被 GoReleaser 放在 Docker build context 的根目錄。
2323
COPY README.md .
2424
COPY LICENSE .
2525

2626
# 設定容器啟動時的入口點。
27-
# 這表示當容器運行時,它會直接執行 /app/dgrkt
27+
# 這表示當容器運行時,它會直接執行 /app/quickstart
2828
# 使用 JSON 陣列格式是最佳實踐,避免 shell 處理。
29-
ENTRYPOINT ["/app/dgrkt"]
29+
ENTRYPOINT ["/app/quickstart"]
3030

3131
CMD ["-h"]
3232

README.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# quickstart(dgrkt)
1+
# quickstart(quickstart)
22

3-
`dgrkt` is a convenient command-line utility built with Go and Cobra. It's designed to orchestrate and execute a series of commands based on a declarative YAML configuration file, similar to how container orchestrators manage services. This tool simplifies the management of complex multi-command setups, making it ideal for local development environments, testing suites, or task automation.
3+
`quickstart` is a convenient command-line utility built with Go and Cobra. It's designed to orchestrate and execute a series of commands based on a declarative YAML configuration file, similar to how container orchestrators manage services. This tool simplifies the management of complex multi-command setups, making it ideal for local development environments, testing suites, or task automation.
44

5-
With `dgrkt`, you define your tasks, their execution parameters, and their dependencies, allowing you to bring up and manage an entire set of related processes with a single command. It includes robust health check capabilities, ensuring that each task is healthy before dependent tasks are started.
5+
With `quickstart`, you define your tasks, their execution parameters, and their dependencies, allowing you to bring up and manage an entire set of related processes with a single command. It includes robust health check capabilities, ensuring that each task is healthy before dependent tasks are started.
66

77
### Features
88

@@ -32,10 +32,10 @@ you'll currently need to manually bypass system security blocks when running the
3232
- [homebrew installation](https://brew.sh/)
3333

3434
```shell
35-
brew install --cask TPIsoftwareOSPO/tap/dgrkt
35+
brew install --cask TPIsoftwareOSPO/tap/quickstart
3636

3737
# macos (as "Important Note!" mention above)
38-
xattr -dr com.apple.quarantine $(which dgrkt)
38+
xattr -dr com.apple.quarantine $(which quickstart)
3939
```
4040

4141
#### Scoop (windows)
@@ -45,20 +45,20 @@ xattr -dr com.apple.quarantine $(which dgrkt)
4545
```shell
4646
# add scoop tap
4747
scoop bucket add TPIsoftwareOSPO https://github.com/TPIsoftwareOSPO/scoop-bucket.git
48-
# install dgrkt
49-
scoop install dgrkt
48+
# install quickstart
49+
scoop install quickstart
5050
```
5151

5252
### Portable Executable
5353

5454
Download the compressed file that matches your system from [release](https://github.com/TPIsoftwareOSPO/quickstart/releases).
55-
The filename prefix will be `dgrkt-portable_`.
55+
The filename prefix will be `quickstart-portable_`.
5656

57-
To run the portable executable, it must be in the same directory with the `dgrkt.yaml` file.
57+
To run the portable executable, it must be in the same directory with the `quickstart.yaml` file.
5858

5959
### Basics
6060

61-
`dgrkt.yaml`
61+
`quickstart.yaml`
6262

6363
```yaml
6464
tasks:
@@ -72,30 +72,30 @@ tasks:
7272
To execute tasks defined in your configuration file:
7373
7474
```bash
75-
dgrkt up
75+
quickstart up
7676
```
7777

7878
output:
7979
```shell
80-
dgrkt|Using config file: ...(ellipsis)/dgrkt.yaml
80+
quickstart|Using config file: ...(ellipsis)/quickstart.yaml
8181
echo|hello world
8282
echo|Completed
8383
```
8484

8585
### Using Docker
8686

8787
```shell
88-
docker run --rm -v ./dgrkt.yaml:/app/dgrkt.yaml tpisoftwareopensource/dgrkt up
88+
docker run --rm -v ./quickstart.yaml:/app/quickstart.yaml tpisoftwareopensource/quickstart up
8989
```
9090

9191
### Command Line Interface (CLI)
9292

93-
`dgrkt` provides a straightforward command-line interface.
93+
`quickstart` provides a straightforward command-line interface.
9494

9595
**Usage:**
9696

9797
```bash
98-
dgrkt [command]
98+
quickstart [command]
9999
```
100100

101101
**Available Commands:**
@@ -107,8 +107,8 @@ dgrkt [command]
107107
| down | Kill previous tasks processes. |
108108
| help | Help about any command. |
109109
| up | Execute tasks according to the YAML configuration file. |
110-
| version | Show version number and build details of dgrkt. |
111-
| init | Generate minimal dgrkt.yaml file |
110+
| version | Show version number and build details of quickstart. |
111+
| init | Generate minimal quickstart.yaml file |
112112

113113

114114
### Configuration File Reference
@@ -119,12 +119,12 @@ The `tasks` key at the root of your YAML file contains a list of individual task
119119
| key | type | description |
120120
|:----------------------------------------|:-------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
121121
| `name` | string, required | A unique identifier for the task. |
122-
| `base_dir` | string | The working directory for the command. cmd.Dir will be set to this path. If not specified, the current working directory of dgrkt will be used. |
122+
| `base_dir` | string | The working directory for the command. cmd.Dir will be set to this path. If not specified, the current working directory of quickstart will be used. |
123123
| `executable` | string, required | The path to the executable command |e.g., node, java, ./my-app.|
124124
| `args` | []string | A list of arguments to pass to the executable. |
125125
| `envs` | []string | A list of environment variables to set for the command |e.g., KEY=VALUE. These are merged with the parent process's environment variables.|
126126
| `depends_on` | []string | A list of task names that this task depends on. This task will only start after all its dependencies have successfully passed their health checks. |
127-
| `healthcheck` | object | Defines how dgrkt determines if a task is healthy. |
127+
| `healthcheck` | object | Defines how quickstart determines if a task is healthy. |
128128
| `healthcheck.http` | object | Configures an HTTP GET health check. |
129129
| `healthcheck.http.url` | string, required | The URL to send the HTTP GET request to. |
130130
| `healthcheck.http.expect` | object, optional | Defines expected responses.If not set, a 2xx HTTP status code indicates health. |
@@ -149,7 +149,7 @@ Each log file will be named in the format `{task:name}-{date}.log`
149149

150150
#### Example 1: Java Application Portable Launch Package
151151

152-
Here's an example of how you might configure `dgrkt` to start .jar file using java command
152+
Here's an example of how you might configure `quickstart` to start .jar file using java command
153153

154154
**Prerequisite**
155155
1. prepare your `myapp.jar` file.
@@ -162,11 +162,11 @@ new-dir/
162162
├─ bin/
163163
├─ java(.exe)
164164
├─ myapp.jar
165-
├─ dgrkt.yaml
166-
├─ (Optional) dgrkt-portable(.exe)
165+
├─ quickstart.yaml
166+
├─ (Optional) quickstart-portable(.exe)
167167
```
168168

169-
**Example of dgrkt.yaml**
169+
**Example of quickstart.yaml**
170170

171171
- With Portable Jre Java
172172
```yaml
@@ -190,11 +190,11 @@ new-dir/
190190
- myapp.jar
191191
```
192192
193-
Double-click the dgrkt portable executable or run `dgrkt up` in your current directory's terminal.
193+
Double-click the quickstart portable executable or run `quickstart up` in your current directory's terminal.
194194

195195
#### Example 2: Portable Elasticsearch and Kibana Set
196196

197-
Here's an example of how you might configure `dgrkt` to start Elasticsearch and Kibana,
197+
Here's an example of how you might configure `quickstart` to start Elasticsearch and Kibana,
198198
with proper health checks and dependencies:
199199

200200
**Prerequisite**
@@ -208,7 +208,7 @@ files structure:
208208
new-dir/
209209
├─ elasticsearch/
210210
├─ kibana/
211-
├─ dgrkt.yaml
211+
├─ quickstart.yaml
212212
├─ kibana.yml
213213
```
214214

@@ -224,7 +224,7 @@ xpack:
224224
encryptionKey: "01234567890123456789012345678901" # only for demo
225225
```
226226

227-
**Example of dgrkt.yaml**
227+
**Example of quickstart.yaml**
228228

229229
```yaml
230230
tasks:
@@ -284,7 +284,7 @@ tasks:
284284
- kibana
285285
```
286286

287-
Double-click the dgrkt portable executable or run `dgrkt up` in your current directory's terminal.
287+
Double-click the quickstart portable executable or run `quickstart up` in your current directory's terminal.
288288

289289
# Implementations
290290

cmd/check.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import (
1414
var CheckCmd = &cobra.Command{
1515
Use: "check",
1616
Short: "Confirm the correctness of the YAML content",
17-
Long: "Confirm the correctness of the YAML content: dgrkt check",
17+
Long: "Confirm the correctness of the YAML content: quickstart check",
1818
Run: func(cmd *cobra.Command, args []string) {
1919

2020
if dir, err := os.Getwd(); err == nil {
@@ -48,7 +48,7 @@ var CheckCmd = &cobra.Command{
4848

4949
func init() {
5050
CheckCmd.PersistentFlags().BoolVar(&app.ShowDetail, "detail", false, "Show configuration details")
51-
CheckCmd.PersistentFlags().StringVarP(&app.TasksComposeFile, "configfile", "f", "", "Specify the path to the configuration file, default is 'dgrkt.yaml'")
51+
CheckCmd.PersistentFlags().StringVarP(&app.TasksComposeFile, "configfile", "f", "", "Specify the path to the configuration file, default is 'quickstart.yaml'")
5252
}
5353

5454
func CheckConfig() error {

cmd/down.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ func (p *ShutdownProcess) kill(wg *sync.WaitGroup) {
3333
var DownCmd = &cobra.Command{
3434
Use: "down",
3535
Short: "Kill previous tasks processes",
36-
Long: "Kill previous tasks processes with command: dgrkt down",
36+
Long: "Kill previous tasks processes with command: quickstart down",
3737
PreRun: func(cmd *cobra.Command, args []string) {
3838
app.DetachMode = true
3939
procedure.InitializeSpinnerAgent()

0 commit comments

Comments
 (0)