updated readme #391

This commit is contained in:
Alan Smithee
2022-02-03 23:24:32 +09:00
parent 73552914ab
commit 7b8d60fe1a
2 changed files with 12 additions and 5 deletions

View File

@@ -79,7 +79,13 @@ You can download the latest Hayabusa version from the [Releases](https://github.
You can also `git clone` the repository with the following command and compile binary from source code.:
```bash
git clone https://github.com/Yamato-Security/hayabusa.git --recursive
git clone https://github.com/Yamato-Security/hayabusa.git
```
You can get latest Hayabusa rules with the execute following command.
```bash
.\hayabusa.exe -U
```
If you forget to use `--recursive` option, `rules/` files which managed in submodule did not cloned.
@@ -129,6 +135,7 @@ USAGE:
-v --verbose 'Output verbose information'
-D --enable-deprecated-rules 'Enable sigma rules marked as deprecated'
-n --enable-noisy-rules 'Enable rules marked as noisy'
-U --rule-update 'Clone latest hayabusa-rule'
-m --min-level=[LEVEL] 'Minimum level for rules (default: informational)'
--start-timeline=[STARTTIMELINE] 'Start time of the event to load from event file. Example: '2018/11/28 12:00:00 +09:00''
--end-timeline=[ENDTIMELINE] 'End time of the event to load from event file. Example: '2018/11/28 12:00:00 +09:00''

View File

@@ -80,14 +80,13 @@ Hayabusaの[Releases](https://github.com/Yamato-Security/hayabusa/releases)か
または、以下の`git clone`コマンドでレポジトリをダウンロードし、ソースコードからコンパイルして使用することも可能です。
```bash
git clone https://github.com/Yamato-Security/hayabusa.git --recursive
git clone https://github.com/Yamato-Security/hayabusa.git
```
`--recursive` をつけ忘れた場合、サブモジュールとして管理されている `rules/` 内のファイルが取得できません
以下のコマンドでサブモジュールを取得してください。
Hayabusaでは検知ルールを`rules/`フォルダの取得はコンパイル後に以下のコマンドでルールの最新版を取得することができま
```bash
git submodule update --init
.\hayabusa.exe -U
```
# ソースコードからのコンパイル(任意)
@@ -130,6 +129,7 @@ USAGE:
-v --verbose 'Output verbose information'
-D --enable-deprecated-rules 'Enable sigma rules marked as deprecated'
-n --enable-noisy-rules 'Enable rules marked as noisy'
-U --rule-update 'Clone latest hayabusa-rule'
-m --min-level=[LEVEL] 'Minimum level for rules (default: informational)'
--start-timeline=[STARTTIMELINE] 'Start time of the event to load from event file. Example: '2018/11/28 12:00:00 +09:00''
--end-timeline=[ENDTIMELINE] 'End time of the event to load from event file. Example: '2018/11/28 12:00:00 +09:00''