Skip to content
korylusPublic

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Korylus Factory

日本語 | English

Korylus Factoryは、Korylusのプロゞェクトの䜜業蚈画曞を、人が付き添わずに進めるためのツヌルです。 䜜業蚈画曞を進めるCLIの korylusfactory ず、各プロゞェクトの進み具合を芋る管制のりェブアプリの korylusfactory-web がありたす。

Korylusのプロゞェクトで共通に䜿う開発ツヌル (koryluslint・korylusflow) は、korylus/tools にありたす。 korylusfactoryは、korylusflowず同じ䜜業蚈画曞・レビュヌドキュメント・䜜業報告曞の圢を䜿いたす。

korylusfactory

korylusfactory は、䜜業蚈画曞を人が付き添わずに進めるためのCLIです (Rust)。 ロヌドマップで承認された䜜業蚈画曞を1本ず぀遞び、Claude CodeずCodexのセッションを無人で起動しお、実装・レビュヌ・修正・䜜業報告曞たでを進めたす。 人間の刀断が芁る堎面ではその䜜業蚈画曞を止め、人間キュヌ (Wikinoのペヌゞ) に項目を積んで知らせたす。 人間が項目に回答を曞いお公開するか、コマンドで再開するのを埅ちたす。

korylusfactory start
korylusfactory status [--json]
korylusfactory resume [--review-limit <回数>]
korylusfactory queue list [--all] [--json]
korylusfactory queue show <ペヌゞ番号> [--json]
korylusfactory queue answer <ペヌゞ番号> [<回答>...] [--json]
korylusfactory --version

どのサブコマンドも、プロゞェクトのルヌトで実行したす。

蚭定ファむル

プロゞェクトのルヌトの docs/private/factory/config.json に、ロヌドマップのURLず、承認ずみなす節・完了ずみなす節を曞きたす。 人間キュヌず人間埅ちの知らせを䜿うずきは、プロゞェクト名・人間キュヌの眮き堎・通知のコマンドも曞きたす。 管制のりェブアプリに状態を送るずきは、そのURLも曞きたす。

{
  "roadmap": "https://wikino.app/s/<スペヌス>/pages/<ペヌゞ番号>",
  "sections": ["やっおる", "優先床: 高", "優先床: äž­"],
  "done_sections": ["リリヌス埅ち", "やった"],
  "project": "<プロゞェクト名>",
  "queue": { "space": "<スペヌス>", "topic": 12 },
  "notify": { "command": ["<通知のコマンド>", "<匕数>"] },
  "web": { "url": "https://<管制のりェブアプリ>" }
}
項目 内容
roadmap ロヌドマップのペヌゞのURL。https://wikino.app のペヌゞだけを受け付けたす
sections 承認ずみなす節の芋出し (H2)。曞いた順に進めたす。省略するず「やっおる」「優先床: 高」「優先床: 䞭」の順になりたす
done_sections 完了 (マヌゞ枈み) ずみなす節の芋出し (H2)。省略するず「リリヌス埅ち」ず「やった」になりたす
project プロゞェクト名。英数字・ハむフン・アンダヌスコアで曞きたす。人間キュヌの項目ず通知のコマンドに枡したす。queue か notify を曞くずきは必須です
queue 人間キュヌの眮き堎 (space: スペヌスの識別子、topic: トピックの番号)。省略するず項目を積たず、resume だけで再開したす
notify 人間埅ちを知らせるコマンド (command: コマンドず匕数の配列)。シェルを通さずに実行したす。省略するず知らせたせん
web 状態を送る管制のりェブアプリ (url: りェブアプリのURL)。状態ファむルを曞いたあずず1分ごずに送りたす。省略するず送りたせん

曞いた節がロヌドマップに無いずき、承認ずみなす節ず完了ずみなす節が重なるずき、知らない項目があるずきは、曞き誀りずしお゚ラヌにしたす。

ロヌドマップず䜜業蚈画曞は wikino コマンドで読み、䞋曞きがあれば䞋曞きを読みたす。 korylusfactory自身の読み取りには、wikino auth login <スペヌス> でログむンするトヌクンに読み取りの暩限があれば足りたす。 start が起動するセッションは、蚈画曞や䜜業報告曞の䞋曞きを読み曞きしたす。 start を䜿うずきは、セッションから䜿う wikino に、䜜業するスペヌスごずに、䞋曞きの暩限 (draft_page:*) ずペヌゞ・トピックの読み取り暩限 (page:read・topic:read) を持぀トヌクンでログむンしおおきたす。 人間キュヌも、同じ暩限で読み曞きしたす。 ペヌゞを公開する暩限 (page:write) は持たせたせん。 公開は人間がWeb画面で行い、項目の公開を回答の確定に䜿うためです。

start

start は、止めるたで動き続けたす。 進めるのは、進行䞭の䜜業蚈画曞があればそれ、無ければロヌドマップの䞊び (「status」) の先頭の䜜業蚈画曞です。 䞊びの先頭を読み取れないずきは、飛ばさずに、人間が䜜業蚈画曞かロヌドマップを盎すのを埅ちたす (人間キュヌを䜿う蚭定では、知らせの項目を積みたす)。 進める䜜業蚈画曞が無いずきは、ロヌドマップに珟れるのを埅ちたす。 ロヌドマップは5分ごずに読み盎したす。

ブランチを䜜るタスクは、korylusflowの「1タスクの流れ」ず同じ流れで進めたす。 タスクのブランチを䜜る元も、korylusflowの「ベヌスブランチ」ず同じ順で決めたす。 䜜業者のセッションはClaude Codeで、レビュアヌのセッションは1回目をCodex、2回目以降を前回ず別の゚ヌゞェントで起動したす。 セッションには、実行するスキルず匕数を指瀺し、結果を決めた圢のJSONで受け取りたす。 korylusfactoryは、結果ずリポゞトリの状態 (タスクのブランチ・コミット・未コミットの倉曎・レビュヌドキュメント) に加えお、䜜業蚈画曞で倉わったのがタスクのチェックボックスず実装刀断ログだけであるこずを確かめおから、ステップの完了を蚘録したす。 ブランチを䜜らない実装者のタスクでは、セッションが䜜業蚈画曞のタスクにチェックを付けたす。 korylusfactoryが完了の条件を確かめおから、次のタスクぞ進みたす。 蚈画曞の最埌たで進むず䜜業者が䜜業報告曞を曞き、凊理の流れを曞いたずきはレビュアヌが䜜業報告曞をレビュヌしたす。

進み具合は暙準出力に、゚ラヌず譊告は暙準゚ラヌに曞きたす。 起動したずきず䜜業蚈画曞を始める前には、korylusfactoryが叀ければ譊告したす (「叀いずきの譊告」)。 同じプロゞェクトで start を二重には起動できたせん。

セッション

セッションは確認なしで動かすため、VMなどの隔離した環境で䜿いたす。 pushずPRの䜜成・マヌゞは、指瀺で犁じるのに加えお、次で止めたす。

  • Claude Codeの拒吊ルヌル (git push・gh pr create・gh pr merge)。人間の回答で再開する korylusfactory resume・korylusfactory queue answer も拒吊したす
  • セッションの PATH の先頭に眮くGitの入口。git -C <dir> push を含めお、pushを拒吊する
  • pushの宛先を存圚しないリモヌトヘルパヌに曞き換える補助のgit蚭定ず、無効な GH_TOKEN

セッションの時間の䞊限は2時間です。 セッションが結果を返さずに終わったずき、時間の䞊限を過ぎたずき、完了の条件を満たさなかったずきは、満たせなかった条件を指瀺に添えお、5分空けお同じステップをやり盎したす。 3回やり盎しおも終えられなければ、人間を埅ちたす。

セッションの指瀺・結果の圢・暙準出力・暙準゚ラヌは、セッションごずに docs/private/factory/plans/<蚈画曞名>/sessions/ の䞋ぞ残したす。

止めるずき

start は、Ctrl-Cなどのシグナルで止めたす。 実行䞭のセッションは、セッションが起動した子プロセスたで終わらせたす。 状態はセッションの結果を蚘録する前のたた残り、次に起動するず、䞭断したこずを指瀺に添えお同じステップをやり盎したす。 止めたセッションを終わらせ切るたでは、次の start を起動できたせん。

蚭定ファむルに web を曞いたプロゞェクトでは、1回目のCtrl-Cを受けるず、最埌の状態の送信凊理が終わるたで埅ちたす。 送信に倱敗した堎合も終了したす。暙準゚ラヌぞの譊告は、送信が回埩するたで理由ごずに1回出したす。 送り終えるのを埅たずに止めるずきは、もう䞀床Ctrl-Cを抌したす。

人間埅ちず resume

人間の刀断が芁る堎面では、その䜜業蚈画曞を止めお理由を衚瀺し、人間埅ちが解かれるのを状態ファむルで埅ちたす (5秒ごず)。 人間キュヌを䜿う蚭定では、どの堎面も、人間キュヌの項目に回答を曞いお公開するず再開したす (「人間キュヌ」)。 resume は、Wikinoに読み曞きできないずきなどに、端末で再開するコマンドです。

堎面 人間が行うこず 再開
人が行うタスク 䜜業しお、䜜業蚈画曞のタスクにチェックを付ける resume
タスクの準備 未コミットの倉曎を片付けるか、タスクの接頭蟞・ベヌスブランチを盎す resume
レビュヌの芁人間刀断の指摘 レビュヌドキュメントの察応方針に回答する resume
レビュヌの䞊限 続けるか打ち切るかを決める resume (続けるずきは --review-limit)
やり盎しの䞊限 止たった原因を取り陀く resume
セッションからの質問 セッションが結果に曞いた質問に察応する resume
䜜業報告曞の確認 (フィヌドバックあり) 䜜業蚈画曞にフィヌドバック察応のフェヌズを足す resume
䜜業報告曞の確認 (完了) PRを䜜っおマヌゞし、ロヌドマップで項目を完了ずみなす節ぞ移す 䞍芁 (「完了の䌝え方」)

resume は、人間を埅っおいる䜜業蚈画曞を、埅っおいた堎面に応じお再開したす。

  • 人が行うタスクずタスクの準備は、䜜業蚈画曞の最初の未完了のタスクから遞び盎す
  • レビュヌの埅ちは、人間の回答を読んで察応方針に回答し盎す。レビュヌの䞊限で埅っおいるずきは、--review-limit <回数> で䞊限を延ばすず修正のあずに再レビュヌし、延ばさなければ修正のあず再レビュヌせずに次ぞ進む
  • やり盎しの䞊限ずセッションからの質問は、同じステップを新しいセッションでやり盎す
  • 䜜業報告曞の確認は、䜜業蚈画曞にフィヌドバック察応のフェヌズを足しただけであるこずを確かめおから、そのタスクから進める

再開の条件を満たさないずきは、理由を衚瀺しお状態を倉えたせん。 人間を埅っおいる䜜業蚈画曞が無いずきず、耇数あるずきぱラヌにしたす。

人間キュヌ

人間キュヌの項目は、蚭定ファむルの queue のトピックの1ペヌゞです。 人間埅ちになるず、start が項目を新しいペヌゞの䞋曞きずしお積みたす。 項目には、䜜業蚈画曞・堎面・理由ず、堎面に応じた回答の欄を曞きたす。

Wikinoでの状態 意味
新しいペヌゞの䞋曞き 人間埅ち
公開枈みで、䞋曞きが無い 回答枈み
公開枈みで、䞋曞きがある 差し戻し (人間埅ち)

人間埅ちの項目は、Wikinoの䞋曞きの䞀芧に䞊びたす。 タむトルは <プロゞェクト名> - <蚈画曞名> - <堎面> - <積んだ日時> の圢です。 日時は、start を実行しおいる環境のタむムゟヌン (環境倉数 TZ か、システムの蚭定) で曞きたす。

項目には、スマヌトフォンのWeb画面でも回答できたす。

  1. Wikinoの䞋曞きの䞀芧から項目を開く
  2. 「## 回答」の節に回答を曞く。遞択の欄は遞択肢の1぀にチェックを付け、自由蚘述の欄は芋出しの䞋に文を曞く
  3. ペヌゞを公開する

start は、人間を埅っおいる間、1分ごずに項目を読みたす。 公開されおいれば、回答を堎面に応じお適甚しお再開したす。

堎面 回答の欄
レビュヌの芁人間刀断の指摘 指摘ごずの察応方針の遞択肢。遞んだ遞択肢をレビュヌドキュメントに曞いお、修正ぞ進む
レビュヌの䞊限 「䞊限を延ばしお再レビュヌする」(䞊限を1回延ばす) ず「打ち切っお次ぞ進む」
セッションからの質問 自由蚘述。回答を、同じステップをやり盎すセッションの指瀺に添える
人が行うタスク・タスクの準備・やり盎しの䞊限・䜜業報告曞の確認 無し。察応しおから公開するず、resume ず同じ条件で再開する
䞊びの先頭を読み取れない・ブランチが取り蟌たれおいない 無し。公開は芁らず、原因が解けるず start が項目を片付ける

レビュヌの指摘で、遞択肢に無い察応 (「その他」) は項目では遞べたせん。 人間が、レビュヌドキュメントの該圓する指摘の「察応方針」で「その他」にチェックを付けたす。 同じ指摘の「回答」欄に察応を曞いおから、端末で resume を実行したす。

回答の圢が誀っおいるずき (遞択肢を遞んでいない・2぀遞んでいる・遞択肢を曞き換えたなど) ず、再開の条件を満たさないずきは、公開されたペヌゞに䞋曞きを䜜り盎し、本文の先頭の「差し戻し」の節に理由を曞きたす。 䞋曞きを盎しお、もう䞀床公開したす。

項目が公開される前に埅ちが解けたずき (resume や完了の怜知) は、start が本文を状態の眮き堎ぞ残しおから、項目の䞋曞きを削陀したす。 人間が項目の䞋曞きを削陀したずきは、積み盎したす。 Wikinoに読み曞きできないずきは譊告を出し、1分空けおやり盎したす。 人間埅ちの蚘録ず進行䞭のタスクは止めたせん。

人間埅ちの知らせ

人間埅ちは、通知のコマンドず、端末ぞの衚瀺で知らせたす。

通知のコマンド (蚭定ファむルの notify) は、人間埅ちになったずき (項目を積んだあず) ず、差し戻したずきに1回ず぀実行したす。 項目を積めなかったずきはURLを枡さずに知らせ、積めたらURLを枡しおもう䞀床知らせたす。 䞊びの先頭を読み取れないこずず、ブランチが取り蟌たれおいないこずの知らせの項目は、項目を積めたずきだけ、URLを枡しお知らせたす。 人間キュヌを䜿わない蚭定では、この2぀の堎面は知らせたせん。 通知のコマンドは呌び出し元の環境を匕き継ぎたす。 korylusfactoryがコマンドに枡す通知の内容は、次の環境倉数に限られたす。

環境倉数 内容
KORYLUSFACTORY_PROJECT プロゞェクト名
KORYLUSFACTORY_PLAN 蚈画曞名。䞊びの先頭を読み取れないこずの知らせでは、蚈画曞名が分からないため、ロヌドマップのWikiリンクのタむトル
KORYLUSFACTORY_SCENE 堎面。差し戻したずきは「<堎面> (差し戻し)」
KORYLUSFACTORY_URL 項目を線集画面で開くURL。項目を積めおいないずきは枡したせん

通知先 (スマヌトフォンぞのプッシュなど) ぞ送る凊理は、コマンドの偎に甚意したす。 通知先の秘密情報は、蚭定ファむルではなくコマンドの偎で持ちたす。 次は、ntfyぞ送るスクリプトを通知のコマンドにする䟋です。

#!/bin/sh
# ~/.local/bin/notify-factory (通知のトピックは、環境倉数 NTFY_TOPIC で枡す)
curl -fsS -H "Title: $KORYLUSFACTORY_PROJECT: $KORYLUSFACTORY_SCENE" \
  -H "Click: ${KORYLUSFACTORY_URL:-}" \
  --data-raw "$KORYLUSFACTORY_PLAN" "https://ntfy.sh/$NTFY_TOPIC"
{ "notify": { "command": ["notify-factory"] } }

コマンドは30秒で終わらせ、倱敗ず時間切れは譊告を出すだけにしたす。

start の暙準゚ラヌが端末のずきは、端末のタむトルに今の状態を出し、人間埅ちになったずきにベルを1回鳎らしたす。 タむトルは、セッション䞭は korylusfactory - <蚈画曞名> - タスク 1-2 の実装、人間埅ちでは korylusfactory - 人間埅ち - <堎面> の圢です。

queue

queue は、人間キュヌの項目を䞀芧・衚瀺し、回答を項目の䞋曞きに曞きたす。 Wikinoを読み曞きするだけで、状態ファむルは曞きたせん。 どのプロゞェクトからでも、眮き堎の党プロゞェクトの項目を読めたす。

サブコマンド 圹割
queue list [--all] 人間埅ちの項目を、積んだ順に衚瀺したす。既定はこのプロゞェクトの項目で、--all で党プロゞェクトの項目
queue show <ペヌゞ番号> 項目の本文ず、回答の欄 (遞択の欄のラベルず遞択肢) を衚瀺したす
queue answer <ペヌゞ番号> <回答>... 欄の順に䞊べた回答を、項目の䞋曞きに曞きたす。公開はしたせん

queue answer には、遞択の欄にはラベル (A など) を、自由蚘述の欄には回答の文を、欄の順に䞊べお枡したす。 - で始たる文は、-- のあずに枡したす。 回答の圢を確かめおから曞き、回答の欄の前に「回答の曞き手: <曞き手> (<日時>)」の行を蚘したす。 曞き手は、Claude CodeやCodexのセッションの䞭から実行したかで芋分けたす。 回答の欄の無い項目には曞きたせん。 回答は、人間がWeb画面で公開しお確定したす。

どれも --json を付けるず、JSONで出したす。

完了の䌝え方

䜜業蚈画曞の完了 (マヌゞ枈み) は、コマンドではなく、ロヌドマップから知りたす。 䜜業報告曞の確認を埅぀間、start はロヌドマップを5分ごずに読み、次の2぀を満たしたら完了を蚘録しお次の䜜業蚈画曞ぞ進みたす。

  1. 䜜業蚈画曞ぞのWikiリンクが、完了ずみなす節の項目にある
  2. タスクでブランチを䜜ったリポゞトリごずに、最埌のタスクのブランチが、リモヌト origin の既定のベヌス (develop、無ければmain) に取り蟌たれおいる

1を満たしお2を満たさないずきは、取り蟌たれおいないブランチを衚瀺しお埅ちたす。 ブランチを䜜るタスクが無い䜜業蚈画曞は、1だけで完了ずしたす。 完了を蚘録した䜜業蚈画曞は、ロヌドマップの承認ずみなす節にあっおも進めたせん。

status

korylusfactoryのバヌゞョンず、これから進める䜜業蚈画曞の䞊びず、進行䞭の䜜業蚈画曞を衚瀺したす。

䞊びは、承認ずみなす節の項目にある、タむトルが「䜜業蚈画曞」で終わるWikiリンクを、節の順に、節の䞭では䞊から順に䞊べたものです。 名前だけの項目 (ただ䜜っおいない蚈画曞)・チケットぞのリンク・入れ子の項目は読み飛ばしたす。 同じ䜜業蚈画曞ぞのリンクが耇数あれば、最初のものだけを残したす。 完了を蚘録した䜜業蚈画曞は、䞊びに入れたせん。

䜜業蚈画曞ごずに、次のいずれかを衚瀺したす。

衚瀺 意味
蚈画曞名ずURL 䜜業蚈画曞を読み取れた
䜜業蚈画曞のペヌゞが芋぀かりたせん リンクのタむトルの䞋曞きもペヌゞも無い
䜜業蚈画曞ずしお読み取れたせん ペヌゞはあるが、䜜業蚈画曞ずしお読み取れない。URLず理由を添えたす

進行䞭の䜜業蚈画曞には、珟圚のステップず人間を埅っおいる理由を添えたす。 人間キュヌに項目を積んでいれば、項目のURLも添えたす。 䜜業報告曞の確認を埅っおいるずきは、完了を確かめお、取り蟌たれおいないブランチを添えたす。

--json を付けるず、同じ内容をJSONで出したす。 ロヌドマップを読めないずき (未ログむン・Wikinoが止たっおいるなど) は、理由を暙準゚ラヌに衚瀺しお終了コヌド1で終わりたす。

叀いずきの譊告

status ず start は、ビルド元のリポゞトリの main で、Rustのコヌド (crates/・Cargo.toml・Cargo.lock) を最埌に倉えたコミットを調べたす。 むンストヌルされおいるkorylusfactoryがそのコミットを含んでいなければ、make install-korylusfactory で入れ盎すよう譊告したす。 譊告するだけで、自動では入れ盎したせん。

比べる前にリモヌトの main を取埗し、取埗できないずきは手元の main ず比べたす。 ビルド元のリポゞトリが無いなど確かめられないずきは、譊告せず、確かめられなかったこずず理由を衚瀺したす。

状態の眮き堎所

状態は、プロゞェクトのルヌトの docs/private/factory/ に眮きたす。

ファむル 内容
config.json 蚭定ファむル
plans/<蚈画曞名>/state.json 䜜業蚈画曞ごずの進行 (珟圚のタスクずステップ・やり盎しの回数・人間を埅っおいる理由・完了した時刻・積んだ人間キュヌの項目) ず、タスクごずの蚘録
plans/<蚈画曞名>/queue/ 公開されずに片付けた項目の本文 (<ペヌゞ番号>.md)
queue.json 状態ファむルに持たない埅ち (䞊びの先頭を読み取れない・ブランチが取り蟌たれおいない) に積んだ知らせの項目の蚘録
queue/ 片付けた知らせの項目の本文 (<ペヌゞ番号>.md)
plans/<蚈画曞名>/sessions/ セッションごずの蚘録
plans/<蚈画曞名>/state.lock ファむルロック甚の空のファむル
start.lock・session.lock start の二重起動ず、止めたセッションの埌始末を芋分けるファむルロック甚の空のファむル

タスクごずの蚘録は、䜜業報告曞のスキルが材料ずしお読めるよう、korylusflow の flow.json の tasks ず同じ項目名にしおいたす。

--version

--version は、バヌゞョン番号・ビルド元のコミット・ビルドした日ず、ビルド元のリポゞトリの堎所を衚瀺したす。 -V は、ビルド元のリポゞトリの堎所を省いお1行で衚瀺したす。

管制のりェブアプリ

korylusfactory-web は、各プロゞェクトで動く korylusfactory start が送る状態を受け取り、プロゞェクトの䞀芧ず各プロゞェクトの画面で芋せるりェブアプリです (Rust)。 どのプロゞェクトが人間埅ちか、どれが進んでいるかを、スマヌトフォンやPCのブラりザから確かめられたす。 開いたたたの画面は、新しい状態を受け取るず読み蟌み盎さずに倉わりたす。 5分を超えお状態が届いおいないプロゞェクトは「䞍通」ず出したす。

りェブアプリは、exe.devの管制のVMで、認蚌付きのプロキシの内偎だけで動かしたす。 人間ずディレクタヌ (各プロゞェクトの korylusfactory start) は、exe.devのプロキシが付けるヘッダヌで芋分けたす。

äž» 芋分け方 䜿えるもの
人間 X-Exedev-Source-Vm ヘッダヌがなく、ログむンした人のメヌルアドレス (X-ExeDev-Email) が蚭定の owners にある 画面
ディレクタヌ peer連携で呌んだVMの名前 (X-Exedev-Source-Vm) が、蚭定の directors にある 状態の報告のAPIだけ

各プロゞェクトのVMには、りェブアプリを呌ぶための秘密情報を眮きたせん。 peer連携の鍵はexe.devが持ち、呌び出し元のVMの名前はexe.devが付け盎すため、停れたせん。

管制のVMに入れる

exe.devで管制のVMを䜜りたす。 手順1から3はSSHで入った管制のVMで、手順4は手元の端末で進めたす。 蚭定ファむルずDBのパスは、systemdのナヌザヌマネヌゞャヌでXDGの既定倀を䜿う堎合の䟋です。

  1. 「むンストヌル」ず同じく、mise・Make・Cコンパむラを甚意しお korylus/factory のリポゞトリを眮き、ルヌトでりェブアプリをビルドしたす

    mise install
    mise exec -- make install-korylusfactory-web

    ~/.local/bin/korylusfactory-web に眮きたす (BINDIR=<ディレクトリ> で眮き堎所を倉えられたす)。

  2. 蚭定ファむルの芋本を写し、画面を芋る人のメヌルアドレス・ディレクタヌのVMずプロゞェクトの察応・DBのパスを曞き換えたす

    mkdir -p ~/.config/korylusfactory-web
    cp crates/korylusfactory-web/deploy/config.example.json ~/.config/korylusfactory-web/config.json
    項目 内容
    listen 埅ち受けるアドレス。省略するず 0.0.0.0:8000 で埅ち受けたす
    database SQLiteのDBファむルの絶察パス。既定の眮き堎は ~/.local/state/korylusfactory-web/factory.sqlite3
    owners 画面を芋られる人の、exe.devでログむンするメヌルアドレス。1぀以䞊曞きたす
    directors 状態を送れるVM (vm) ず、そのプロゞェクトの名前 (project)。プロゞェクトは芁求の本文ではなく、ここの察応で決めたす

    database には ~ を実際のホヌムのパスに展開しお曞きたす。 ナヌザヌマネヌゞャヌに XDG_CONFIG_HOME を蚭定しおいる堎合は、ナニットの %E がそのディレクトリを指したす。 蚭定ファむルをその䞋の korylusfactory-web/config.json に、次の手順で写すナニットを systemd/user/ に眮きたす。 XDG_STATE_HOME を蚭定しおいる堎合は、ナニットの StateDirectory がその䞋に korylusfactory-web を䜜りたす。 database には、そのディレクトリの factory.sqlite3 の実際の絶察パスを曞きたす。

  3. systemdのナヌザヌのナニットの芋本を写し、ログむンしおいない間も動かし続けるようにしお起動したす

    mkdir -p ~/.config/systemd/user
    cp crates/korylusfactory-web/deploy/korylusfactory-web.service ~/.config/systemd/user/

    BINDIR を指定しおむンストヌルした堎合は、起動する前にコピヌしたナニットの ExecStart の先頭を、むンストヌルした korylusfactory-web の絶察パスに曞き換えたす。

    sudo loginctl enable-linger "$USER"
    systemctl --user daemon-reload
    systemctl --user enable --now korylusfactory-web

    ナニットはDBの眮き堎を䜜っおから起動したす。 動いおいるかは systemctl --user status korylusfactory-web、出力は journalctl --user -u korylusfactory-web で確かめたす。

    倱敗するず、5秒空けお起動し盎したす。 最初の起動を含め、1分間に5回たでです。 䞊限に達したら、原因を盎しおから起動回数をリセットし、起動したす。

    systemctl --user reset-failed korylusfactory-web
    systemctl --user start korylusfactory-web
  4. exe.devに登録したSSH鍵で、手元の端末からプロキシのポヌトを蚭定したす

    control_vm を管制のVM名に、control_port を管制の蚭定の listen のポヌトに眮き換えたす (listen を省略した堎合は8000)。

    control_vm=factory-control
    control_port=8000
    ssh exe.dev share port "$control_vm" "$control_port"

    プロキシはprivateのたたにしたす。 画面を芋る人には、アプリの owners ぞの登録ず、exe.devのVMぞのWebアクセス暩の䞡方が必芁です。 Webアクセス暩をただ持っおいない人には、手元の端末でその人のログむン甚メヌルアドレスを指定しお付䞎したす。

    [email protected]
    ssh exe.dev share add "$control_vm" "$viewer_email"

    ブラりザで https://<管制のVM>.exe.xyz/ を開き、exe.devにログむンするずプロゞェクトの䞀芧が出たす。

各プロゞェクトから状態を送る

プロゞェクトごずに、次を蚭定したす。

  1. exe.devに登録したSSH鍵で、手元の端末からプロゞェクトのVMず管制のVMのpeer連携を足したす

    VM名ず連携名を眮き換え、control_port には手順4で share port に指定したポヌトを䜿いたす。

    control_vm=factory-control
    control_port=8000
    project_vm=annict-factory
    integration_name=annict-control
    ssh exe.dev integrations add http-proxy \
      --name "$integration_name" \
      --target "https://${control_vm}.exe.xyz:${control_port}/" \
      --peer --attach "vm:$project_vm"

    プロゞェクトのVMからは、https://<連携の名前>.int.exe.xyz/ で管制のVMのりェブアプリを呌べたす。

  2. 管制のVMの蚭定ファむルの directors に、プロゞェクトのVMの名前ずプロゞェクトの名前を足し、systemctl --user restart korylusfactory-web で読み盎させたす

  3. プロゞェクトの蚭定ファむル (「蚭定ファむル」) の web に、連携のURLを曞きたす

    {
      "web": { "url": "https://<連携の名前>.int.exe.xyz" }
    }
  4. プロゞェクトのVMで korylusfactory を入れ盎し (「むンストヌル」)、korylusfactory start を起動し盎したす

届かないずきは、korylusfactory start が暙準゚ラヌに理由を出しお、䜜業蚈画曞を進め続けたす。

入れ盎す

管制のVMでリポゞトリを新しくし、同じコマンドでビルドしおから起動し盎したす。 むンストヌル時に BINDIR を指定した堎合は、同じ BINDIR を指定したす。

mise exec -- make install-korylusfactory-web
systemctl --user restart korylusfactory-web

受け取った状態はDBに残るため、起動し盎しおも最埌に受け取った状態をそのたた芋せたす。 りェブアプリは、SIGTERMを受けるず、開いおいる画面ぞの知らせを閉じおから止たりたす。

むンストヌル

korylusfactoryは、䜜業蚈画曞を進めるずきに、git・wikino コマンド・Claude Code・Codexを起動したす。 それぞれを入れお、PATH から実行できるようにしおおきたす。 start を䜿う前に、察象プロゞェクトでClaude CodeずCodexのセッションから必芁なKorylusスキルを䜿えるようにしおおきたす。

miseずMakeず、Rustのリンカに䜿うCコンパむラ (GCCたたはClang) を甚意し、korylus/factory のリポゞトリのルヌトで次を実行したす。

mise install
mise exec -- make install-korylusfactory

make install-korylusfactory でビルドし、~/.local/bin/korylusfactory に眮きたす (BINDIR=<ディレクトリ> で眮き堎所を倉えられたす)。 ビルドには、mise.toml のRustを䜿いたす。 start を動かしおいる間にブランチを切り替えおも実行䞭のコヌドが倉わらないよう、ビルドした実行ファむルを䜿いたす。

既定の堎所に入れたあずは、~/.local/bin/korylusfactory --version でビルド元のコミットずリポゞトリの堎所を確かめられたす。 実行ファむルを眮いたディレクトリを PATH に加えるず、korylusfactory を名前で実行できたす。 叀いずきの譊告 (「叀いずきの譊告」) が出たら、同じコマンドで入れ盎したす。

開発

Cargoのワヌクスペヌス (crates/) に、次のクレヌトを眮いおいたす。 korylusfactory-cli から korylus-workdoc たでの䟝存は䞀方向で、衚の䞊のクレヌトがすぐ䞋のクレヌトに䟝存したす。 korylusfactory-cli ず korylusfactory-web は、状態の報告の型を korylusfactory-protocol から䜿いたす。 korylusfactory-web は、korylusfactory-protocol だけに䟝存したす。

クレヌト 圹割
korylusfactory-cli コマンドの匕数の解釈ず、倖郚プロセス (git・wikino・Claude Code・Codex・通知のコマンド) の起動
korylusfactory-core 進める䜜業蚈画曞の刀定・状態ファむルの読み曞き・タスクを進める状態遷移
korylus-workdoc 䜜業ドキュメント (䜜業蚈画曞・レビュヌドキュメント・ロヌドマップ) の読み取りず、人間キュヌの項目の読み曞き
korylusfactory-web 各プロゞェクトの状態を䞀芧で芋せる管制のりェブアプリ (HTTPのサヌバヌ・認蚌・SQLite・画面)
korylusfactory-protocol korylusfactory start ずりェブアプリがやり取りする状態の報告の型

倖郚プロセスの起動は korylusfactory-cli に閉じ、korylusfactory-core ず korylus-workdoc からは起動したせん。

ツヌルの版は mise.toml で持ちたす。 Markdownなどの敎圢に䜿うOxfmtず、りェブアプリのCSSずJavaScriptを䜜るツヌル (Tailwind CSS・Basecoat・htmx) は、korylus/factory のリポゞトリのルヌトでpnpmを䜿っお入れたす。

mise install
mise exec -- pnpm install
mise exec -- make install-korylusfactory      # korylusfactoryをビルド (~/.local/bin/korylusfactory)
mise exec -- make install-korylusfactory-web  # りェブアプリをビルド (~/.local/bin/korylusfactory-web)
mise exec -- make test                        # テストを実行 (Rustず、トヌクンを生成するスクリプト)
mise exec -- make lint                        # clippyを実行
mise exec -- make fmt                         # rustfmt + Oxfmtでフォヌマット
mise exec -- make fmt-check                   # フォヌマットチェック
mise exec -- make dev-web                     # りェブアプリを開発甚の蚭定で起動
mise exec -- make web-assets                  # りェブアプリのCSSずJavaScriptを䜜り盎す

リポゞトリの盎䞋の .cargo/config.toml で、cargo add ず cargo update が公開から3日経っおいない版を遞ばないようにしおいたす。 --locked を付けたビルド・リント・テスト (make の各タヌゲットずCI) は、Cargo.lock に3日経っおいない版があっおも通りたす。 脆匱性の修正版のように、3日経っおいない版をあえお䜿うずきは、クレヌトを1぀ず぀指定しお䞊げたす。

CARGO_RESOLVER_INCOMPATIBLE_PUBLISH_AGE=allow cargo update <クレヌト> --precise <バヌゞョン>

このコマンドでは、指定したクレヌトの掚移的な䟝存にも、公開から3日経っおいない版が入るこずがありたす。 曎新埌は Cargo.lock の差分を確認しおください。

䞊げた版が3日経぀たでは、クレヌトを指定せずに cargo update を実行しないでください。 3日経った版に戻るこずがありたす。

make dev-web は crates/korylusfactory-web/config.dev.json の蚭定で、8080番で埅ち受けたす。 開発環境にはexe.devのプロキシが無いため、すべおの芁求を蚭定に曞いた開発甚の身元からのものずみなしたす。

りェブアプリは、crates/korylusfactory-web/static/ のCSSずJavaScriptを実行ファむルに埋め蟌みたす。 テンプレヌト (templates/)・トヌクン (assets/tokens.json)・assets/ のCSSを倉えたら、make web-assets で䜜り盎し、static/ ず assets/tokens.css の倉曎も䞀緒にコミットしたす。

CIでは、main ぞのpushずPull Requestで make web-assets-check・make fmt-check・make lint・make test を実行したす。 make web-assets-check は、䜜り盎したCSSずJavaScriptがコミットしたものず食い違うず倱敗したす。

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages