-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathusage_for_beginner.html
More file actions
346 lines (320 loc) · 18.7 KB
/
usage_for_beginner.html
File metadata and controls
346 lines (320 loc) · 18.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
<!DOCTYPE html>
<html lang="ja">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>yarc の使い方 — 初心者向け</title>
<style>
* { box-sizing: border-box; }
body {
font-family: "Hiragino Sans", "Hiragino Kaku Gothic ProN", "Yu Gothic", Meiryo, sans-serif;
line-height: 1.7;
max-width: 720px;
margin: 0 auto;
padding: 24px 20px 48px;
color: #1a1a1a;
background: #f8f6f3;
}
h1 {
font-size: 1.5rem;
margin: 0 0 8px;
color: #2c5282;
}
.sub { font-size: 0.95rem; color: #555; margin-bottom: 24px; }
h2 {
font-size: 1.15rem;
margin: 28px 0 12px;
padding-bottom: 6px;
border-bottom: 2px solid #c9d6e3;
color: #2c5282;
}
h3 { font-size: 1rem; margin: 20px 0 8px; color: #333; }
p { margin: 0 0 12px; }
ul, ol { margin: 0 0 12px; padding-left: 1.4em; }
li { margin: 4px 0; }
code, .cmd, .file {
background: #e8ecf1;
padding: 2px 8px;
border-radius: 4px;
font-size: 0.9em;
}
pre {
background: #2d3748;
color: #e2e8f0;
padding: 14px 16px;
border-radius: 8px;
overflow-x: auto;
font-size: 0.85rem;
line-height: 1.5;
}
pre code { background: none; padding: 0; color: inherit; }
.box {
background: #fff;
border: 1px solid #e2e8f0;
border-radius: 8px;
padding: 14px 18px;
margin: 12px 0;
}
table {
width: 100%;
border-collapse: collapse;
font-size: 0.9rem;
margin: 12px 0;
}
th, td {
border: 1px solid #c9d6e3;
padding: 10px 12px;
text-align: left;
}
th { background: #edf2f7; color: #2d3748; }
tr:nth-child(even) { background: #f7fafc; }
.note { font-size: 0.9rem; color: #555; margin-top: 6px; }
.step { font-weight: bold; color: #2c5282; }
.tabs { display: flex; gap: 0; margin: 16px 0 0; border-bottom: 2px solid #c9d6e3; }
.tabs button {
padding: 10px 20px;
border: none;
background: #edf2f7;
color: #2d3748;
font-size: 0.95rem;
cursor: pointer;
border-radius: 8px 8px 0 0;
margin-bottom: -2px;
}
.tabs button:hover { background: #e2e8f0; }
.tabs button.active { background: #fff; color: #2c5282; font-weight: bold; border: 1px solid #c9d6e3; border-bottom: 2px solid #fff; }
.tab-panel { display: none; padding: 16px 0 0; }
.tab-panel.active { display: block; }
.cmd-block { margin: 12px 0; padding: 12px 14px; background: #fff; border: 1px solid #e2e8f0; border-radius: 8px; }
.cmd-block .cmd-name { font-weight: bold; color: #2c5282; margin-bottom: 4px; }
.cmd-block .cmd-desc { font-size: 0.9rem; color: #555; margin-bottom: 8px; }
.cmd-block table { margin: 0; font-size: 0.85rem; }
.cmd-block td:first-child { width: 38%; vertical-align: top; }
</style>
</head>
<body>
<h1>yarc（ヤーク）の使い方</h1>
<p class="sub">プログラミングが初めての人向け</p>
<h2>yarc って何？</h2>
<p>Yay（イェイ）用の「アカウントを自動で作る」「指定した人を自動でフォローする」ツールです。パソコンの黒い画面（コマンド）で操作します。</p>
<h2>最初に用意するもの</h2>
<ol>
<li><strong>パソコン</strong>（Windows / Mac どちらでも可）</li>
<li><strong>Node.js</strong> — ツールを動かすためのソフト<br>
<a href="https://nodejs.org/">https://nodejs.org/</a> から「LTS」を選んでダウンロード・インストール</li>
<li><strong>MongoDB</strong> — 作ったアカウント情報を保存するデータベース<br>
無料の「MongoDB Atlas」がおすすめ。<a href="https://www.mongodb.com/cloud/atlas">MongoDB Atlas</a> でアカウントを作り、クラスターを1つ作って、ユーザー名・パスワード・接続用アドレスをメモする</li>
<li><strong>Yay 用の API 情報</strong>（apiKey と signedInfo など）— 別途取得が必要です</li>
</ol>
<h2>手順1：yarc のフォルダを用意する</h2>
<p>Git でクローンするか、GitHub から「Download ZIP」でダウンロードして解凍します。解凍したフォルダの中に <span class="file">package.json</span> や <span class="file">bin</span> フォルダがあることを確認してください。</p>
<h2>手順2：黒い画面（コマンド）を開く</h2>
<ul>
<li><strong>Windows</strong>：スタートで「cmd」または「PowerShell」と入力して開く</li>
<li><strong>Mac</strong>：Spotlight で「ターミナル」と入力して開く</li>
</ul>
<p>開いたら、yarc のフォルダに移動します。</p>
<pre><code># Windows の例
cd C:\Users\あなたの名前\Documents\YAF
# Mac の例
cd /Users/あなたの名前/Downloads/YAF</code></pre>
<p class="note">「あなたの名前」「YAF」は実際の場所に合わせて書き換えてください。<code>cd</code> は「このフォルダに移動する」という意味です。</p>
<h2>手順3：ツールの準備（初回だけ）</h2>
<p>次のどちらかを入力して Enter を押します。</p>
<pre><code>yarn install</code></pre>
<p>または</p>
<pre><code>npm install</code></pre>
<p>必要な部品がダウンロードされて終わるまで待ちます。</p>
<h2>手順4：設定ファイルを2つ作る</h2>
<p>yarc は <span class="file">.env</span> と <span class="file">config.json</span> が同じフォルダにないと動きません。</p>
<h3>4-1. .env ファイル</h3>
<p>メモ帳で新規作成し、次のように書いて、ファイル名 <span class="file">.env</span> で yarc のフォルダに保存します。</p>
<pre><code>DB_USER=ここにMongoDBのユーザー名
DB_PASSWORD=ここにMongoDBのパスワード
DB_NAME=yarc
DB_HOST=ここにMongoDBのホスト名（例：cluster0.xxxx.mongodb.net）</code></pre>
<p class="note">MongoDB Atlas の場合：Connect → Connect your application で表示されるアドレスの「cluster0.xxxx.mongodb.net」の部分だけを DB_HOST に書きます。</p>
<h3>4-2. config.json ファイル</h3>
<p>同じくメモ帳で新規作成し、次のように書いて <span class="file">config.json</span> で保存します。</p>
<pre><code>{
"api": {
"apiKey": "あなたのAPIキー",
"signedInfo": "あなたのsignedInfo",
"yayApiHost": "https://api.yay.space",
"userAgent": "YayWeb 4.20.0"
},
"storage": { "mode": "json" },
"proxy": { "url": "" }
}</code></pre>
<p class="note">apiKey と signedInfo は Yay の開発者向け情報として別途取得が必要です。プロキシを使わない場合は <code>"url": ""</code> のままで大丈夫です。</p>
<h2>手順5：動いているか確認する</h2>
<p>yarc のフォルダで、次のコマンドを打ちます。</p>
<pre><code>yarc status</code></pre>
<p>または</p>
<pre><code>node bin/yarc-cli.cjs status</code></pre>
<p>環境やアカウント数が表示されれば設定は成功です。</p>
<h2>コマンド</h2>
<p>いずれも「yarc のフォルダで」実行します。</p>
<div class="tabs" role="tablist">
<button type="button" role="tab" aria-selected="true" data-tab="main" class="active">代表的なコマンド</button>
<button type="button" role="tab" aria-selected="false" data-tab="all">全コマンド一覧</button>
</div>
<div id="tab-main" class="tab-panel active">
<table>
<thead>
<tr><th>コマンド</th><th>意味</th></tr>
</thead>
<tbody>
<tr><td><code>yarc status</code></td><td>状態確認（設定・アカウント数など）</td></tr>
<tr><td><code>yarc config show</code></td><td>設定内容を表示</td></tr>
<tr><td><code>yarc generate once --count 5</code></td><td>アカウントを5個だけ作る</td></tr>
<tr><td><code>yarc target set --user 123</code></td><td>フォローしたい人のユーザーIDを 123 に設定</td></tr>
<tr><td><code>yarc target get</code></td><td>今のフォロー対象IDを表示</td></tr>
<tr><td><code>yarc follow --mode all</code></td><td>設定した対象を全員フォローする</td></tr>
<tr><td><code>yarc autofollow enable</code></td><td>自動フォローをONにする</td></tr>
<tr><td><code>yarc autofollow disable</code></td><td>自動フォローをOFFにする</td></tr>
<tr><td><code>yarc autofollow run-once</code></td><td>自動フォローを1回だけ実行</td></tr>
<tr><td><code>yarc run</code></td><td>常駐モード（生成・自動フォローを繰り返す）</td></tr>
<tr><td><code>yarc app start</code></td><td>PM2 でバックグラウンド常駐を開始</td></tr>
<tr><td><code>yarc app stop</code> / <code>yarc app logs</code></td><td>PM2 の停止 / ログ表示</td></tr>
</tbody>
</table>
<p class="note">「yarc」が動かないときは <code>node bin/yarc-cli.cjs コマンド</code> の形で試してください。例：<code>node bin/yarc-cli.cjs status</code></p>
</div>
<div id="tab-all" class="tab-panel">
<p class="note">各コマンドの <code>[]</code> は省略可能なオプションです。</p>
<div class="cmd-block">
<div class="cmd-name">yarc --help</div>
<div class="cmd-desc">ヘルプ（使えるコマンド一覧）を表示します。</div>
<table><tr><td><code>yarc -h</code></td><td>上と同じ（短い形式）</td></tr></table>
</div>
<div class="cmd-block">
<div class="cmd-name">yarc --version</div>
<div class="cmd-desc">yarc のバージョンを表示します。</div>
</div>
<div class="cmd-block">
<div class="cmd-name">yarc status</div>
<div class="cmd-desc">環境・設定・アカウント数などの要約を表示します。</div>
</div>
<div class="cmd-block">
<div class="cmd-name">yarc config <action> [--scope 対象] [--key キー] [--value 値]</div>
<div class="cmd-desc">設定の表示・取得・更新（config.json / admin-config.json）。</div>
<table>
<tr><td><code>config show</code></td><td>設定内容をすべて表示</td></tr>
<tr><td><code>config get --key キー名</code></td><td>指定キーの値を表示（例: api.apiKey）</td></tr>
<tr><td><code>config set --key キー名 --value 値</code></td><td>指定キーに値を保存</td></tr>
<tr><td><code>--scope config</code></td><td>config.json を対象（省略時はこれ）</td></tr>
<tr><td><code>--scope admin</code></td><td>admin-config.json を対象</td></tr>
</table>
</div>
<div class="cmd-block">
<div class="cmd-name">yarc proxy <action> [--url URL]</div>
<div class="cmd-desc">プロキシの設定・確認・テスト。</div>
<table>
<tr><td><code>proxy get</code></td><td>現在のプロキシURLを表示</td></tr>
<tr><td><code>proxy set --url "http://user:pass@host:port"</code></td><td>プロキシを設定</td></tr>
<tr><td><code>proxy clear</code></td><td>プロキシを解除</td></tr>
<tr><td><code>proxy test</code></td><td>プロキシ接続をテスト</td></tr>
</table>
</div>
<div class="cmd-block">
<div class="cmd-name">yarc target <action> [--user ユーザーID]</div>
<div class="cmd-desc">フォロー対象のユーザーIDを設定・取得（複数IDをカンマ区切りで登録可能）。</div>
<table>
<tr><td><code>target get</code></td><td>登録済みのフォロー対象IDを表示</td></tr>
<tr><td><code>target set --user 123456789</code></td><td>フォロー対象として 123456789 を登録（<code>-u</code> も可）</td></tr>
</table>
</div>
<div class="cmd-block">
<div class="cmd-name">yarc follow [--user ユーザーID] [--mode one|all]</div>
<div class="cmd-desc">指定ユーザーをフォロー。user を省略すると target で登録した対象を使います。</div>
<table>
<tr><td><code>--user 123</code> / <code>-u 123</code></td><td>このユーザーIDをフォロー対象にする（target より優先）</td></tr>
<tr><td><code>--mode one</code></td><td>1件だけフォロー（省略時はこれ）</td></tr>
<tr><td><code>--mode all</code></td><td>対象を全員フォロー</td></tr>
</table>
</div>
<div class="cmd-block">
<div class="cmd-name">yarc autofollow <action></div>
<div class="cmd-desc">自動フォローのON/OFFと、常駐時の「1回だけ実行」。</div>
<table>
<tr><td><code>autofollow status</code></td><td>自動フォローがONかOFFか表示</td></tr>
<tr><td><code>autofollow enable</code></td><td>自動フォローをON（admin-config に保存）</td></tr>
<tr><td><code>autofollow disable</code></td><td>自動フォローをOFF</td></tr>
<tr><td><code>autofollow run-once</code></td><td>自動フォローを1回だけ実行して終了</td></tr>
</table>
</div>
<div class="cmd-block">
<div class="cmd-name">yarc generate <action> [--count 数] [--max 数]</div>
<div class="cmd-desc">アカウント生成（1回だけ / ループ / 常駐用のON・OFF）。</div>
<table>
<tr><td><code>generate once</code></td><td>1件だけ生成して終了</td></tr>
<tr><td><code>generate once --count 5</code> / <code>-c 5</code></td><td>5件だけ生成して終了</td></tr>
<tr><td><code>generate loop [--max 数]</code></td><td>最大で指定件数まで生成し続ける（--max 0 で無制限）。Ctrl+C で停止</td></tr>
<tr><td><code>generate status</code></td><td>生成ON/OFFと最大件数を表示</td></tr>
<tr><td><code>generate enable [--max 数]</code></td><td>常駐モード用に「生成ON」を保存。--max 0 で無制限、--max 20 で20件まで</td></tr>
<tr><td><code>generate disable</code></td><td>常駐モード用の生成をOFFに保存</td></tr>
</table>
</div>
<div class="cmd-block">
<div class="cmd-name">yarc run [--interval 秒数]</div>
<div class="cmd-desc">ヘッドレス常駐。admin-config の generateEnabled / autoFollowEnabled が true のとき、生成・自動フォローを実行します。Ctrl+C で終了。</div>
<table>
<tr><td><code>--interval 300</code></td><td>監視間隔を300秒（5分）に（省略時は300）。5未満は5として扱われます</td></tr>
</table>
</div>
<div class="cmd-block">
<div class="cmd-name">yarc app <action> [--lines 数]</div>
<div class="cmd-desc">PM2 で yarc をバックグラウンド常駐させるコマンド。どこから実行しても yarc のプロジェクトを参照します。PM2 未導入の場合は <code>npm install -g pm2</code> で入れます。</div>
<table>
<tr><td><code>yarc app start</code></td><td>PM2 で yarc を起動（バックグラウンドで <code>yarc run</code> が動く）</td></tr>
<tr><td><code>yarc app stop</code></td><td>PM2 の yarc を停止</td></tr>
<tr><td><code>yarc app restart</code></td><td>PM2 の yarc を再起動</td></tr>
<tr><td><code>yarc app logs [--lines 200]</code></td><td>PM2 の yarc のログを表示（行数指定可能）</td></tr>
</table>
<p class="note" style="margin-top: 8px;"><strong>PC を再起動したら？</strong> そのままでは PM2 も止まるので、yarc は起動したままにはなりません。<br>
<strong>Windows の場合：</strong> <code>pm2 startup</code> は Windows では使えません（「Init system not found」と出ます）。再起動後も自動で動かしたい場合は、<code>npm install -g pm2-windows-startup</code> を実行したあと、<code>pm2-startup install</code> を実行してから <code>pm2 save</code> で保存します。または、再起動後に手動で <code>yarc app start</code> を実行してもかまいません。<br>
<strong>Mac / Linux の場合：</strong> yarc を起動した状態で <code>pm2 save</code> を実行し、<code>pm2 startup</code> で表示されたコマンドを実行します。設定後は PC 起動時に PM2 が立ち上がり、保存した yarc が自動で起動します。</p>
</div>
<p class="note" style="margin-top: 16px;">「yarc」が動かないときは <code>node bin/yarc-cli.cjs コマンド</code> で実行できます。例：<code>node bin/yarc-cli.cjs status</code></p>
</div>
<script>
(function() {
var tabs = document.querySelectorAll('.tabs button[data-tab]');
var panels = document.querySelectorAll('.tab-panel');
tabs.forEach(function(btn) {
btn.addEventListener('click', function() {
var id = 'tab-' + btn.getAttribute('data-tab');
tabs.forEach(function(b) { b.classList.remove('active'); b.setAttribute('aria-selected', 'false'); });
panels.forEach(function(p) { p.classList.remove('active'); });
btn.classList.add('active');
btn.setAttribute('aria-selected', 'true');
var panel = document.getElementById(id);
if (panel) panel.classList.add('active');
});
});
})();
</script>
<h2>よくあるエラーと対処</h2>
<div class="box">
<p><strong>「yarc は認識されていません」</strong><br>
→ yarc のフォルダに <code>cd</code> で移動してから実行していますか？ または <code>node bin/yarc-cli.cjs コマンド</code> で試す。</p>
<p><strong>「Cannot find module」</strong><br>
→ 手順3の <code>yarn install</code> または <code>npm install</code> をやり直す。</p>
<p><strong>「MongoDB」「接続できません」</strong><br>
→ .env の DB_USER、DB_PASSWORD、DB_HOST が正しいか確認。Atlas なら IP を 0.0.0.0/0 で許可しているか確認。</p>
<p><strong>「API_KEY」「signedInfo」のエラー</strong><br>
→ config.json の apiKey と signedInfo が正しく入っているか確認。</p>
</div>
<h2>まとめの流れ（初回）</h2>
<ol>
<li>Node.js と MongoDB（Atlas）を用意する</li>
<li>yarc のフォルダをダウンロードして用意する</li>
<li>黒い画面を開いて、そのフォルダに <code>cd</code> で移動する</li>
<li><code>yarn install</code> または <code>npm install</code> を実行する</li>
<li>.env と config.json を作って同じフォルダに保存する</li>
<li><code>yarc status</code> で動作確認する</li>
<li>アカウントを作りたいときは <code>generate</code>、フォローしたいときは <code>target set</code> → <code>follow</code> を参照</li>
</ol>
</body>
</html>