注意）このプログラムは特定の環境でしか動作しません。

コマンドライン引数に検索条件などをすべて指定して、一気に結果集約・圧縮・指定場所にアップロードまで行う。

npx -p exhaustive-twitter-crawler -- instant <option>

• 2021年10月25日から11月4日においてハロウィンもしくは仮装が含まれた日本語のツイートのうちリツイートではないものを検索し--destinationで指定したWebDAVサーバへアップロードしたい。(Queryサーバ(--url)のURLは管理者から配布する)

npx -y -p exhaustive-twitter-crawler instant --id yokoyama20211208 --term 2022-10-25T00:00~2021-11-05T00:00 --keywords ハロウィン 仮装 --keywords-match text-or --ignore-retweet --url wss://query-server:1111/ --webdav --destination https://web-dav-server:2222/result/ --user username-for-web-dav-server

| セキュリティ上、利用者を限定するために、tokenを用いたクエリ認可の仕組みがあります。クエリを発行する前に、以下の手順に従い管理者からtokensを発行してもらう必要があります。

• まず自分のClient IDを取得する

npx -y -p exhaustive-twitter-crawler -- get-id

• IDが画面に表示されるのでそれをサーバ担当へ通知しトークンをもらう。
• トークン一つにつき一つのクエリが出来ます。またget-idを行った環境からのみ有効です。
• tokenを以下の様なコマンドで登録する。(実際のコマンドは管理者から与えられます。)

npx -y -p exhaustive-twitter-crawler@latest set-tokens <ここにTokenが_区切りで入る>

• クエリを発行する。(クエリ発行の度にtokenは一つずつ消費されます)
• 【方法１】自分が管理しているどこかのWebDAVサーバへアップロードする場合(WebDAVサーバは自前で準備する必要があります。)

npx -y -p exhaustive-twitter-crawler -- instant --term 2022-04-01T00:00~2022-04-02T00:00 --keywords エイプリルフール --giveaway webdav --destination https://web-dav-server:2222/result/ --user shohei --id april-fool

• 【方法２】クエリを発行しているコンピュータに結果を取り寄せる(結果ファイルの転送時間はWebDAVサーバへアップロードするよりかかります)

npx -y -p exhaustive-twitter-crawler -- instant --term 2024-04-01T00:00~2024-04-02T00:00 --keywords エイプリルフール --keywords-match text-or --id april-fool 

• 結果はapil-fool-YYYYMMDDHHMMSS.tar.gzというファイル名で保存されます。
  • YYYYMMDDHHMMSSは結果作成時の時刻

スイッチ	例	説明
--id <identifier>	my-query	〈必須〉クエリ識別ID (ファイル名に使える文字のみ)
--url <url>	wss://query-server:1111/	デフォルトと異なるサーバを指定したいときのみ
--giveaway <method>	no	結果の送信方法(no, local, webdav, curl)
--token <token>		リモートアクセス時に必要なアクセストークン

スイッチ	例	説明
--term <from-to>	2020-05-01T00:00~2021-07-01T00:00	〈必須1〉クロール期間(最初と最後)をチルダ(~)区切りのISO8601形式にて指定
--keywords	コロナ マスク 自粛	〈必須2〉キーワードリスト(半角スペース区切りもしくはJSON)
--no-keywords		〈必須2〉keywordsを指定しない時は必ず--no-keywordsを指定する(全量取得するので注意！)
--keywords-match	text-or	キーワードのOR検索(text-or)かAND検索(text-and)かを指定、RegExpで正規表現も可。また tweet-id で id_str を指定。expanded-url で指定した url を含んだツイートを検索
--lang <lang>		言語(jaとenのみ対応、無指定は全ツイード)
--ignore-retweet		リツイートを結果に含めない
--only-retweet		リツイートのみ取得する
--only-quote		引用リツイートのみ取得する
--only-emoji		絵文字のあるツイートのみ取得する
--retweet-count <min-retweet>		指定数以上 RT されたツイートのみ取得する
--has-geo		ジオタグ付きTweetのみ
--has-geo-point		ジオタグ付きTweetのみ(Pointを持つもの限定)
--bbox <bbox>	139.281801,35.099243,139.781679,35.514684	指定した範囲内のツイートのみ検索(西,南,東,北の順の範囲指定)
--morpheme <type>		形態素解析(sudachi)をして名詞・動詞・形容詞・形状詞のみ配列としてtweet.wordsに格納する(replace:textを置き換える / append:textも残す)
--has-emoji		絵文字を持っているツイートのみ(emojisフィールドが追加されtext中の絵文字一覧が配列で格納されます)
--jst		create_atを日本時間にする
--mask <mask>	id_str,text,user(id_str,name,screen_name)	結果に残すJSONフィールドの指定(書き方)
--verbose		結果にエラーやファイル毎統計情報を含める
--boost		(β版)検索を高速にする(JSONパース前に文字列一致を行う事で検索を高速化します)

• maskの指定がない場合はデフォルトで以下のマスクがかけられます。
  • id_str,text,user(id_str,name,screen_name),is_quote_status,quoted_status_id_str,retweeted_status(id_str,user(id_str,name,screen_name)),entities(hashtags,user_mentions,urls),lang,timestamp_ms,created_at
• keywordsはkeywords-matchがtext-orの時、[[\"A\",\"B\"],[\"C\",\"D\"]]と指定する事で、 (A and B) or (C and D) と解釈されます。text-andの時は (A or B) and (C or D) となります。
• 形態素解析を行う場合はmorphemeを指定してください。
  • このオプションでは形態素解析器sudachiを利用します。
  • 形態素のうち以下の者のみ結果に残します
    • 名詞、動詞、形容詞、形状詞意外は削除します
    • dictionary_formが空でないものあるいは全角カタカナのみで構成される形態素は削除します
    • ただしUNICODE絵文字は結果の末尾に羅列します
    • 結果は得られた形態素のnormalized_formを、Tweetにmorphemesフィールドを追加して配列として構成します
    • --morpheme appendの場合はtextも残しますが--morpheme replaceの場合はtextは結果に残しません。
    • 尚、アルファベット等ラテン文字もそのままsudachiにかけます。(大抵、問題無く形態素に分かれます)
    • 事前にURLとメンションは削除されます。ハッシュタグは削除されませんので形態素として残ります。
    • morpheme指定時にはmaskにの任意の位置にmorphemeフィールドを指定する事ができます。指定されない場合は、末尾に追加されます。

スイッチ	例	説明
--destination <path>	~/exhaustive-twitter/	tokyo012上でtwitterguestsグループが書き込める)保存先ディレクトリ

スイッチ	例	説明
--destination <url>	https://web-dav-server:2222/paht/to/dir/	アップロード先(WebDAVのURL)
--user <username>	shohei	WebDAVサーバにログインするユーザ名(パスワードは実行後に聞かれます)