Skip to content

Commit 0e7384f

Browse files
committed
docs: execute shell-command
1 parent 66bea33 commit 0e7384f

2 files changed

Lines changed: 25 additions & 1 deletion

File tree

lib/doc.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,15 @@ Executes any command with console privileges.
3737

3838
- command: string - The command to execute
3939
- result?: boolean = false - If true, the result can be received
40+
41+
## executeShellCommand
42+
43+
Executes any shell command.
44+
45+
### Arguments
46+
47+
- mainCommand: string - Specify an executable file
48+
- ex) Type `"git"` when you run `git pull`
49+
- args?: string[] - Specify command arguments
50+
- ex) Type `["pull"]` when you run `git pull`
51+
- result?: boolean - If true, the result can be received

lib/doc_ja.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,16 @@ mcfunction とスクリプトを再読み込みします。
3636
### 引数
3737

3838
- command: string - 実行するコマンド
39-
- result?: boolean = false - trueの場合,結果を受け取れる
39+
- result?: boolean - `true`の場合, 結果を受け取れる
40+
41+
## executeShellCommand
42+
43+
任意のシェルコマンドを実行します。
44+
45+
### Arguments
46+
47+
- mainCommand: string - 実行ファイル
48+
- ex) `git pull`を実行する場合は`"git"`を入力する
49+
- args?: string[] - コマンド引数
50+
- ex) `git pull`を実行する場合は`["pull"]`を入力する
51+
- result?: boolean - `true`の場合, 結果を受け取れる

0 commit comments

Comments
 (0)