Skip to content

Commit 814e9ac

Browse files
committed
Merge branch 'master' of github.com:kool-dev/kool
2 parents eb15c2e + 4817533 commit 814e9ac

File tree

10 files changed

+33
-20
lines changed

10 files changed

+33
-20
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,16 +81,29 @@ Execute command in running container.
8181
### kool run
8282

8383
```bash
84-
$ kool run [script/image] [command]
84+
$ kool run [script] [command]
8585
```
8686

8787
Execute script or a docker image.
8888

8989
| Name | Type | Description |
9090
| ---- | ---- | ----------- |
91-
| `script/image` | `string` | Script to run within your `kool.yaml` file.|
91+
| `script` | `string` | Script to run within your `kool.yaml` file. |
9292
| `command` | `string` | The command to run, i.e: `composer install`, `yarn install` |
93-
| `--docker` | `none` | If enabled, `script` param will become `image` and you will run a docker image |
93+
94+
### kool docker
95+
96+
```bash
97+
$ kool docker [image] [command]
98+
```
99+
100+
Execute script or a docker image.
101+
102+
| Name | Type | Description |
103+
| ---- | ---- | ----------- |
104+
| `image` | `string` | Docker image to run, i.e: `fireworkweb/node:14` |
105+
| `command` | `string` | The command to run, i.e: `composer install`, `yarn install` |
106+
| `--disable-tty|-T` | `none` | Force disable tty, good for CI/CI/Automation |
94107

95108
### kool stop
96109

cmd/docker.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ var dockerFlags = &DockerFlags{false}
2525
func init() {
2626
rootCmd.AddCommand(dockerCmd)
2727

28-
dockerCmd.Flags().BoolVarP(&dockerFlags.DisableTty, "disable-tty", "T", false, "Disables TTY (only in case of using --docker)")
28+
dockerCmd.Flags().BoolVarP(&dockerFlags.DisableTty, "disable-tty", "T", false, "Disables TTY")
2929
}
3030

3131
func runDocker(cmd *cobra.Command, originalArgs []string) {

cmd/presets.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ APP_URL=http://localhost:${PORT}`,
125125
126126
install:
127127
- cp .env.example .env
128-
- kool run --docker fireworkweb/node:14 npm install # can change to: yarn,pnpm
128+
- kool docker fireworkweb/node:14 npm install # can change to: yarn,pnpm
129129
- kool start`,
130130
}
131131
presets["adonis"] = map[string]string{
@@ -197,7 +197,7 @@ APP_URL=http://localhost:${PORT}`,
197197
198198
install:
199199
- cp .env.example .env
200-
- kool run --docker fireworkweb/node:14 npm install # can change to: yarn,pnpm
200+
- kool docker fireworkweb/node:14 npm install # can change to: yarn,pnpm
201201
- kool start`,
202202
}
203203
presets["laravel"] = map[string]string{
@@ -263,8 +263,8 @@ networks:
263263
php: kool exec app php
264264
composer: kool exec app composer
265265
266-
node: kool run --docker fireworkweb/node:14 node
267-
npm: kool run --docker fireworkweb/node:14 npm # can change to: yarn,pnpm
266+
node: kool docker fireworkweb/node:14 node
267+
npm: kool docker fireworkweb/node:14 npm # can change to: yarn,pnpm
268268
269269
install:
270270
- kool start
@@ -319,7 +319,7 @@ networks:
319319
npm: kool exec app npm # can change to: yarn,pnpm
320320
321321
install:
322-
- kool run --docker fireworkweb/node:14 npm install # can change to: yarn,pnpm
322+
- kool docker fireworkweb/node:14 npm install # can change to: yarn,pnpm
323323
- kool start`,
324324
}
325325
presets["nextjs"] = map[string]string{
@@ -359,7 +359,7 @@ networks:
359359
npm: kool exec app npm # can change to: yarn,pnpm
360360
361361
install:
362-
- kool run --docker fireworkweb/node:14 npm install # can change to: yarn,pnpm
362+
- kool docker fireworkweb/node:14 npm install # can change to: yarn,pnpm
363363
- kool start`,
364364
}
365365
presets["nuxtjs-static"] = map[string]string{
@@ -406,7 +406,7 @@ networks:
406406
npm: kool exec app npm # can change to: yarn,pnpm
407407
408408
install:
409-
- kool run --docker fireworkweb/node:14 npm install # can change to: yarn,pnpm
409+
- kool docker fireworkweb/node:14 npm install # can change to: yarn,pnpm
410410
- kool start`,
411411
}
412412
presets["nuxtjs"] = map[string]string{
@@ -451,7 +451,7 @@ networks:
451451
npm: kool exec app npm # can change to: yarn,pnpm
452452
453453
install:
454-
- kool run --docker fireworkweb/node:14 npm install # can change to: yarn,pnpm
454+
- kool docker fireworkweb/node:14 npm install # can change to: yarn,pnpm
455455
- kool start`,
456456
}
457457
}

presets/adonis-nextjs/kool.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ scripts:
55

66
install:
77
- cp .env.example .env
8-
- kool run --docker fireworkweb/node:14 npm install # can change to: yarn,pnpm
8+
- kool docker fireworkweb/node:14 npm install # can change to: yarn,pnpm
99
- kool start

presets/adonis/kool.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ scripts:
55

66
install:
77
- cp .env.example .env
8-
- kool run --docker fireworkweb/node:14 npm install # can change to: yarn,pnpm
8+
- kool docker fireworkweb/node:14 npm install # can change to: yarn,pnpm
99
- kool start

presets/laravel/kool.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ scripts:
22
php: kool exec app php
33
composer: kool exec app composer
44

5-
node: kool run --docker fireworkweb/node:14 node
6-
npm: kool run --docker fireworkweb/node:14 npm # can change to: yarn,pnpm
5+
node: kool docker fireworkweb/node:14 node
6+
npm: kool docker fireworkweb/node:14 npm # can change to: yarn,pnpm
77

88
install:
99
- kool start

presets/nextjs-static/kool.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ scripts:
33
npm: kool exec app npm # can change to: yarn,pnpm
44

55
install:
6-
- kool run --docker fireworkweb/node:14 npm install # can change to: yarn,pnpm
6+
- kool docker fireworkweb/node:14 npm install # can change to: yarn,pnpm
77
- kool start

presets/nextjs/kool.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ scripts:
33
npm: kool exec app npm # can change to: yarn,pnpm
44

55
install:
6-
- kool run --docker fireworkweb/node:14 npm install # can change to: yarn,pnpm
6+
- kool docker fireworkweb/node:14 npm install # can change to: yarn,pnpm
77
- kool start

presets/nuxtjs-static/kool.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ scripts:
33
npm: kool exec app npm # can change to: yarn,pnpm
44

55
install:
6-
- kool run --docker fireworkweb/node:14 npm install # can change to: yarn,pnpm
6+
- kool docker fireworkweb/node:14 npm install # can change to: yarn,pnpm
77
- kool start

presets/nuxtjs/kool.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ scripts:
33
npm: kool exec app npm # can change to: yarn,pnpm
44

55
install:
6-
- kool run --docker fireworkweb/node:14 npm install # can change to: yarn,pnpm
6+
- kool docker fireworkweb/node:14 npm install # can change to: yarn,pnpm
77
- kool start

0 commit comments

Comments
 (0)