<commit_before>
go-vaddy: VAddy API Command-Line Tool
=================================

VAddy API Command-Line Tool using golang  
http://vaddy.net

VAddyの脆弱性検査の実行と結果の取得を自動化するコマンドツールです。

## OSの種類

`go-vaddy/bin`ディレクトリに、OS毎の実行ファイルが置いてあります。
もしlinux(64bit)をお使いの場合は、vaddy-linux-64bitというファイルを実行してください。

例： `./vaddy-linux-64bit  api_key userID FQDN`

| OS            | file               | 
| ------------- |:------------------:| 
| Linux(64bit)  | vaddy-linux-64bit  |
| MacOS(64bit)  | vaddy-macosx-64bit |
| Windows(64bit)| vaddy-win-64bit.exe|
| Linux(32bit)  | vaddy-linux-32bit  |
| Windows(32bit)| vaddy-win-32bit.exe|



## 利用方法 (脆弱性検査の実行と結果の取得)

### 終了ステータス
Go-vaddyは、エラーや脆弱性が発見されなかった場合は終了コード 0を返します。これは一般的なコマンドの正常終了と同じ終了コードです。
エラーや脆弱性があった場合は、終了コード1を返します。

### 引数タイプ
Go-vaddyでは、コマンドの引数を指定するパターンと、OSの環境変数にセットするパターンが選べます。


### 環境変数 
環境変数を利用した実行


    export VADDY_TOKEN="<PASSWORD>"  
    export VADDY_USER="ichikaway"  
    export VADDY_HOST="www.examplevaddy.com"  
    export VADDY_CRAWL="30"  


`VADDY_CRAWL`はオプション項目で、指定しない場合は最新のクロールデータを使って検査します。  
下記の例のようにクロールラベルの指定も可能です。

    export VADDY_CRAWL="search result pages"  


### コマンド引数
最後のオプション`crawl_id`は必須ではありません。これを指定しない場合は最新のクロールIDのデータを使って脆弱性検査します。

Usage: `vaddy-linux-64bit auth_key username(LoginID)  hostname crawl_id(optional)`
<commit_msg>change README<commit_after>
go-vaddy: VAddy API Command-Line Tool
=================================

VAddy API Command-Line Tool using golang  
http://vaddy.net

VAddyの脆弱性検査の実行と結果の取得を自動化するコマンドツールです。

## OSの種類

`go-vaddy/bin`ディレクトリに、OS毎の実行ファイルが置いてあります。
もしlinux(64bit)をお使いの場合は、vaddy-linux-64bitというファイルを実行してください。

例： `./vaddy-linux-64bit  api_key userID FQDN`

| OS            | file               | 
| ------------- |:------------------:| 
| Linux(64bit)  | vaddy-linux-64bit  |
| MacOS(64bit)  | vaddy-macosx-64bit |
| Windows(64bit)| vaddy-win-64bit.exe|
| Linux(32bit)  | vaddy-linux-32bit  |
| Windows(32bit)| vaddy-win-32bit.exe|



## 利用方法 (脆弱性検査の実行と結果の取得)

### 終了ステータス
Go-vaddyは、エラーや脆弱性が発見されなかった場合は終了コード 0を返します。これは一般的なコマンドの正常終了と同じ終了コードです。
エラーや脆弱性があった場合は、終了コード1を返します。

### 引数タイプ
Go-vaddyでは、コマンドの引数を指定するパターンと、OSの環境変数にセットするパターンが選べます。


### 環境変数 
環境変数を利用した実行


    export VADDY_TOKEN="<PASSWORD>"  
    export VADDY_USER="ichikaway"  
    export VADDY_HOST="www.examplevaddy.com"  
    export VADDY_CRAWL="30"  


`VADDY_CRAWL`はオプション項目で、指定しない場合は最新のクロールデータを使って検査します。  
下記の例のようにクロールラベルの指定も可能です。

    export VADDY_CRAWL="search result pages"  


環境変数をセットした後は、下記のようにコマンドを実行します。

    vaddy-linux-64bit


### コマンド引数
最後のオプション`crawl_id`は必須ではありません。これを指定しない場合は最新のクロールIDのデータを使って脆弱性検査します。

Usage: `vaddy-linux-64bit auth_key username(LoginID)  hostname crawl_id(optional)`

{'fraction_non_alphanumeric': 0.15517241379310345, 'fraction_numerical': 0.024737631184407798, 'mean_word_length': 4.348697394789579, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2298401', 'n_tokens_mistral': 1693, 'n_tokens_neox': 1545, 'n_words': 135}