@k2works/claude-code-booster 0.16.0 → 0.16.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (79) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +42 -42
  3. package/bin/claude-code-booster +68 -68
  4. package/lib/assets/.claude/.mcp.json +45 -45
  5. package/lib/assets/.claude/COMMAND_TEMPLATE.md +122 -122
  6. package/lib/assets/.claude/README.md +140 -140
  7. package/lib/assets/.claude/commands/analysis-architecture.md +98 -98
  8. package/lib/assets/.claude/commands/analysis-data-model.md +94 -94
  9. package/lib/assets/.claude/commands/analysis-domain-model.md +101 -101
  10. package/lib/assets/.claude/commands/analysis-non-functional.md +103 -103
  11. package/lib/assets/.claude/commands/analysis-operation.md +104 -104
  12. package/lib/assets/.claude/commands/analysis-requirements.md +100 -100
  13. package/lib/assets/.claude/commands/analysis-tech-stack.md +113 -113
  14. package/lib/assets/.claude/commands/analysis-test-strategy.md +101 -101
  15. package/lib/assets/.claude/commands/analysis-ui-design.md +100 -100
  16. package/lib/assets/.claude/commands/analysis-usecases.md +100 -100
  17. package/lib/assets/.claude/commands/analysis.md +103 -103
  18. package/lib/assets/.claude/commands/dev-backend.md +144 -144
  19. package/lib/assets/.claude/commands/dev-frontend.md +126 -126
  20. package/lib/assets/.claude/commands/dev.md +96 -96
  21. package/lib/assets/.claude/commands/docs.md +213 -213
  22. package/lib/assets/.claude/commands/git-commit.md +47 -47
  23. package/lib/assets/.claude/commands/kill.md +108 -108
  24. package/lib/assets/.claude/commands/ops.md +507 -507
  25. package/lib/assets/.claude/commands/plan-github.md +212 -212
  26. package/lib/assets/.claude/commands/plan.md +237 -237
  27. package/lib/assets/.claude/commands/progress.md +171 -171
  28. package/lib/assets/.claude/settings.json +8 -7
  29. package/lib/assets/.claude/skills/ai-agent-guidelines/SKILL.md +119 -119
  30. package/lib/assets/.claude/skills/git-commit/SKILL.md +106 -106
  31. package/lib/assets/.devcontainer/devcontainer.json +34 -34
  32. package/lib/assets/.github/workflows/docker-publish.yml +77 -77
  33. package/lib/assets/.github/workflows/mkdocs.yml +39 -39
  34. package/lib/assets/AGENTS.md +94 -94
  35. package/lib/assets/CLAUDE.md +319 -319
  36. package/lib/assets/Dockerfile +100 -97
  37. package/lib/assets/README.md +234 -234
  38. package/lib/assets/docker-compose.yml +33 -33
  39. package/lib/assets/docs/assets/css/extra.css +29 -29
  40. package/lib/assets/docs/assets/js/extra.js +44 -44
  41. package/lib/assets/docs/index.md +14 -14
  42. package/lib/assets/docs/reference/Java/343/202/242/343/203/227/343/203/252/343/202/261/343/203/274/343/202/267/343/203/247/343/203/263/347/222/260/345/242/203/346/247/213/347/257/211/343/202/254/343/202/244/343/203/211.md +569 -569
  43. package/lib/assets/docs/reference/TypeScript/343/202/242/343/203/227/343/203/252/343/202/261/343/203/274/343/202/267/343/203/247/343/203/263/347/222/260/345/242/203/346/247/213/347/257/211/343/202/254/343/202/244/343/203/211.md +464 -464
  44. package/lib/assets/docs/reference/UI/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +445 -445
  45. package/lib/assets/docs/reference//343/202/210/343/201/204/343/202/275/343/203/225/343/203/210/343/202/246/343/202/247/343/202/242/343/201/250/343/201/257.md +219 -219
  46. package/lib/assets/docs/reference//343/202/242/343/203/274/343/202/255/343/203/206/343/202/257/343/203/201/343/203/243/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +2193 -2193
  47. package/lib/assets/docs/reference//343/202/244/343/203/263/343/203/225/343/203/251/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +1878 -1878
  48. package/lib/assets/docs/reference//343/202/250/343/202/257/343/202/271/343/203/210/343/203/252/343/203/274/343/203/240/343/203/227/343/203/255/343/202/260/343/203/251/343/203/237/343/203/263/343/202/260.md +554 -554
  49. package/lib/assets/docs/reference//343/202/263/343/203/274/343/203/207/343/202/243/343/203/263/343/202/260/343/201/250/343/203/206/343/202/271/343/203/210/343/202/254/343/202/244/343/203/211.md +703 -703
  50. package/lib/assets/docs/reference//343/203/206/343/202/271/343/203/210/346/210/246/347/225/245/343/202/254/343/202/244/343/203/211.md +1309 -1309
  51. package/lib/assets/docs/reference//343/203/207/343/203/274/343/202/277/343/203/242/343/203/207/343/203/253/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +311 -311
  52. package/lib/assets/docs/reference//343/203/211/343/203/241/343/202/244/343/203/263/343/203/242/343/203/207/343/203/253/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +599 -599
  53. package/lib/assets/docs/reference//343/203/246/343/203/274/343/202/271/343/202/261/343/203/274/343/202/271/344/275/234/346/210/220/343/202/254/343/202/244/343/203/211.md +671 -671
  54. package/lib/assets/docs/reference//343/203/252/343/203/252/343/203/274/343/202/271/343/203/273/343/202/244/343/203/206/343/203/254/343/203/274/343/202/267/343/203/247/343/203/263/350/250/210/347/224/273/343/202/254/343/202/244/343/203/211.md +523 -523
  55. package/lib/assets/docs/reference//350/246/201/344/273/266/345/256/232/347/276/251/343/202/254/343/202/244/343/203/211.md +1248 -1248
  56. package/lib/assets/docs/reference//351/201/213/347/224/250/350/246/201/344/273/266/345/256/232/347/276/251/343/202/254/343/202/244/343/203/211.md +392 -392
  57. package/lib/assets/docs/reference//351/226/213/347/231/272/343/202/254/343/202/244/343/203/211.md +235 -235
  58. package/lib/assets/docs/reference//351/235/236/346/251/237/350/203/275/350/246/201/344/273/266/345/256/232/347/276/251/343/202/254/343/202/244/343/203/211.md +1230 -1230
  59. package/lib/assets/docs/template/ADR.md +30 -30
  60. package/lib/assets/docs/template/README.md +50 -50
  61. package/lib/assets/docs/template//343/201/276/343/201/232/343/201/223/343/202/214/343/202/222/350/252/255/343/202/202/343/201/206/343/203/252/343/202/271/343/203/210.md +12 -12
  62. package/lib/assets/docs/template//343/202/244/343/203/206/343/203/254/343/203/274/343/202/267/343/203/247/343/203/263/345/256/214/344/272/206/345/240/261/345/221/212/346/233/270.md +58 -58
  63. package/lib/assets/docs/template//343/202/244/343/203/263/343/202/273/343/203/227/343/202/267/343/203/247/343/203/263/343/203/207/343/203/203/343/202/255.md +13 -13
  64. package/lib/assets/docs/template//345/256/214/345/205/250/345/275/242/345/274/217/343/201/256/343/203/246/343/203/274/343/202/271/343/202/261/343/203/274/343/202/271.md +68 -68
  65. package/lib/assets/docs/template//350/246/201/344/273/266/345/256/232/347/276/251.md +669 -669
  66. package/lib/assets/docs/template//350/250/255/350/250/210.md +163 -163
  67. package/lib/assets/flake.nix +22 -22
  68. package/lib/assets/gulpfile.js +18 -18
  69. package/lib/assets/mkdocs.yml +63 -63
  70. package/lib/assets/ops/docker/mkdoc/Dockerfile +19 -19
  71. package/lib/assets/ops/nix/environments/node/shell.nix +20 -20
  72. package/lib/assets/ops/nix/environments/python/shell.nix +19 -20
  73. package/lib/assets/ops/nix/shells/shell.nix +17 -17
  74. package/lib/assets/ops/scripts/journal.js +180 -180
  75. package/lib/assets/ops/scripts/mkdocs.js +113 -113
  76. package/lib/assets/package-lock.json +1640 -1640
  77. package/lib/assets/package.json +34 -33
  78. package/lib/gulpfile.js +37 -37
  79. package/package.json +40 -40
@@ -1,98 +1,101 @@
1
- # ベースイメージとして Ubuntu 22.04 を使用
2
- FROM ubuntu:22.04 AS base
3
-
4
- # 環境変数の設定
5
- ARG NODE_MAJOR=22
6
- ENV DEBIAN_FRONTEND=noninteractive \
7
- LANG=ja_JP.UTF-8 \
8
- LC_ALL=ja_JP.UTF-8 \
9
- LC_CTYPE=ja_JP.UTF-8 \
10
- NODE_VER=$NODE_MAJOR
11
-
12
- # ユーザーの設定
13
- ARG USERNAME=developer
14
- ARG USER_UID=1000
15
- ARG USER_GID=$USER_UID
16
-
17
- RUN groupadd --gid $USER_GID $USERNAME \
18
- && useradd --uid $USER_UID --gid $USER_GID -m $USERNAME \
19
- && apt-get update \
20
- && apt-get install -y sudo \
21
- && echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME \
22
- && chmod 0440 /etc/sudoers.d/$USERNAME
23
-
24
- # ロケールのセットアップ
25
- RUN apt-get update && apt-get install -y \
26
- language-pack-ja-base \
27
- language-pack-ja \
28
- && update-locale LANG=ja_JP.UTF-8 LANGUAGE=ja_JP:ja \
29
- && rm -rf /var/lib/apt/lists/*
30
-
31
- # 基本的なパッケージのインストール
32
- RUN apt-get update && \
33
- apt-get install -y \
34
- build-essential \
35
- zip \
36
- unzip \
37
- git \
38
- curl \
39
- wget \
40
- vim \
41
- tmux \
42
- xz-utils \
43
- && apt-get clean \
44
- && rm -rf /var/lib/apt/lists/*
45
-
46
- # Nixのインストール
47
- ENV NIX_INSTALL_DIR=/nix
48
- RUN mkdir -m 0755 $NIX_INSTALL_DIR && chown $USERNAME $NIX_INSTALL_DIR
49
- USER $USERNAME
50
- ENV USER=$USERNAME
51
- ENV HOME=/home/$USERNAME
52
- RUN curl -L https://nixos.org/nix/install | sh -s -- --no-daemon \
53
- && echo '. /home/'$USERNAME'/.nix-profile/etc/profile.d/nix.sh' >> /home/$USERNAME/.bashrc \
54
- && mkdir -p /home/$USERNAME/.config/nix \
55
- && echo "experimental-features = nix-command flakes" >> /home/$USERNAME/.config/nix/nix.conf
56
-
57
- # Nix環境変数の設定
58
- ENV PATH="/home/$USERNAME/.nix-profile/bin:/nix/var/nix/profiles/default/bin:${PATH}" \
59
- NIX_PATH="/home/$USERNAME/.nix-profile/etc/profile.d/nix.sh:/nix/var/nix/profiles/default/etc/profile.d/nix.sh" \
60
- NIX_SSL_CERT_FILE=/etc/ssl/certs/ca-certificates.crt
61
-
62
- USER root
63
-
64
- # Node.jsのインストール
65
- RUN curl -fsSL https://deb.nodesource.com/setup_$NODE_VER.x | bash - \
66
- && apt-get install -y nodejs \
67
- && npm install -g yarn \
68
- && mkdir -p /home/$USERNAME/.nvm \
69
- && chown -R $USERNAME:$USERNAME /home/$USERNAME/.nvm \
70
- && echo '#!/bin/bash\n\
71
- curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.37.2/install.sh | bash\n\
72
- . /home/'$USERNAME'/.nvm/nvm.sh\n\
73
- nvm install "'$NODE_VER'"\n\
74
- nvm use "'$NODE_VER'"' > /tmp/nvm_install.sh \
75
- && chmod +x /tmp/nvm_install.sh \
76
- && su - $USERNAME -c /tmp/nvm_install.sh \
77
- && rm /tmp/nvm_install.sh
78
-
79
- # Gemini CLIのインストール
80
- RUN npm install -g @google/gemini-cli
81
-
82
- # Claude Codeのインストール
83
- RUN npm install -g @anthropic-ai/claude-code
84
-
85
- # Copilot CLIのインストール
86
- RUN npm install -g @github/copilot
87
-
88
- # すべてのインストールが完了した後、ユーザーのホームディレクトリの所有権を確保
89
- RUN chown -R $USERNAME:$USERNAME /home/$USERNAME
90
-
91
- # 作業ディレクトリの設定
92
- WORKDIR /srv
93
-
94
- # ユーザーを設定したユーザーに切り替える
95
- USER $USERNAME
96
-
97
- # デフォルトのシェルを bash に設定
1
+ # ベースイメージとして Ubuntu 22.04 を使用
2
+ FROM ubuntu:22.04 AS base
3
+
4
+ # 環境変数の設定
5
+ ARG NODE_MAJOR=22
6
+ ENV DEBIAN_FRONTEND=noninteractive \
7
+ LANG=ja_JP.UTF-8 \
8
+ LC_ALL=ja_JP.UTF-8 \
9
+ LC_CTYPE=ja_JP.UTF-8 \
10
+ NODE_VER=$NODE_MAJOR
11
+
12
+ # ユーザーの設定
13
+ ARG USERNAME=developer
14
+ ARG USER_UID=1000
15
+ ARG USER_GID=$USER_UID
16
+
17
+ RUN groupadd --gid $USER_GID $USERNAME \
18
+ && useradd --uid $USER_UID --gid $USER_GID -m $USERNAME \
19
+ && apt-get update \
20
+ && apt-get install -y sudo \
21
+ && echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME \
22
+ && chmod 0440 /etc/sudoers.d/$USERNAME
23
+
24
+ # ロケールのセットアップ
25
+ RUN apt-get update && apt-get install -y \
26
+ language-pack-ja-base \
27
+ language-pack-ja \
28
+ && update-locale LANG=ja_JP.UTF-8 LANGUAGE=ja_JP:ja \
29
+ && rm -rf /var/lib/apt/lists/*
30
+
31
+ # 基本的なパッケージのインストール
32
+ RUN apt-get update && \
33
+ apt-get install -y \
34
+ build-essential \
35
+ zip \
36
+ unzip \
37
+ git \
38
+ curl \
39
+ wget \
40
+ vim \
41
+ tmux \
42
+ xz-utils \
43
+ && apt-get clean \
44
+ && rm -rf /var/lib/apt/lists/*
45
+
46
+ # Nixのインストール
47
+ ENV NIX_INSTALL_DIR=/nix
48
+ RUN mkdir -m 0755 $NIX_INSTALL_DIR && chown $USERNAME $NIX_INSTALL_DIR
49
+ USER $USERNAME
50
+ ENV USER=$USERNAME
51
+ ENV HOME=/home/$USERNAME
52
+ RUN curl -L https://nixos.org/nix/install | sh -s -- --no-daemon \
53
+ && echo '. /home/'$USERNAME'/.nix-profile/etc/profile.d/nix.sh' >> /home/$USERNAME/.bashrc \
54
+ && mkdir -p /home/$USERNAME/.config/nix \
55
+ && echo "experimental-features = nix-command flakes" >> /home/$USERNAME/.config/nix/nix.conf
56
+
57
+ # Nix環境変数の設定
58
+ ENV PATH="/home/$USERNAME/.nix-profile/bin:/nix/var/nix/profiles/default/bin:${PATH}" \
59
+ NIX_PATH="/home/$USERNAME/.nix-profile/etc/profile.d/nix.sh:/nix/var/nix/profiles/default/etc/profile.d/nix.sh" \
60
+ NIX_SSL_CERT_FILE=/etc/ssl/certs/ca-certificates.crt
61
+
62
+ USER root
63
+
64
+ # Node.jsのインストール
65
+ RUN curl -fsSL https://deb.nodesource.com/setup_$NODE_VER.x | bash - \
66
+ && apt-get install -y nodejs \
67
+ && npm install -g yarn \
68
+ && mkdir -p /home/$USERNAME/.nvm \
69
+ && chown -R $USERNAME:$USERNAME /home/$USERNAME/.nvm \
70
+ && echo '#!/bin/bash\n\
71
+ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.37.2/install.sh | bash\n\
72
+ . /home/'$USERNAME'/.nvm/nvm.sh\n\
73
+ nvm install "'$NODE_VER'"\n\
74
+ nvm use "'$NODE_VER'"' > /tmp/nvm_install.sh \
75
+ && chmod +x /tmp/nvm_install.sh \
76
+ && su - $USERNAME -c /tmp/nvm_install.sh \
77
+ && rm /tmp/nvm_install.sh
78
+
79
+ # Gemini CLIのインストール
80
+ RUN npm install -g @google/gemini-cli
81
+
82
+ # Claude Codeのインストール
83
+ RUN npm install -g @anthropic-ai/claude-code
84
+
85
+ # Copilot CLIのインストール
86
+ RUN npm install -g @github/copilot
87
+
88
+ # Codex CLIのインストール
89
+ RUN npm install -g @openai/codex
90
+
91
+ # すべてのインストールが完了した後、ユーザーのホームディレクトリの所有権を確保
92
+ RUN chown -R $USERNAME:$USERNAME /home/$USERNAME
93
+
94
+ # 作業ディレクトリの設定
95
+ WORKDIR /srv
96
+
97
+ # ユーザーを設定したユーザーに切り替える
98
+ USER $USERNAME
99
+
100
+ # デフォルトのシェルを bash に設定
98
101
  SHELL ["/bin/bash", "-c"]
@@ -1,234 +1,234 @@
1
- # {project-name}
2
-
3
- ## 概要
4
-
5
- ### 目的
6
-
7
- ### 前提
8
-
9
- | ソフトウェア | バージョン | 備考 |
10
- | :----------- | :--------- | :--- |
11
- | nodejs | 22.x | |
12
-
13
- ## 構成
14
-
15
- - [構築](#構築)
16
- - [配置](#配置)
17
- - [運用](#運用)
18
- - [Nix による開発環境](#nix-による開発環境)
19
- - [開発](#開発)
20
-
21
- ## 詳細
22
-
23
- ### Qick Start
24
-
25
- ```bash
26
- npm install
27
- npm start
28
- ```
29
-
30
- ### 構築
31
-
32
- ```bash
33
- claude mcp add github npx @modelcontextprotocol/server-github -e GITHUB_PERSONAL_ACCESS_TOKEN=xxxxxxxxxxxxxxx
34
- claude mcp add --transport http byterover-mcp --scope user https://mcp.byterover.dev/v2/mcp
35
- claude mcp add github npx -y @modelcontextprotocol/server-github -s project
36
- ```
37
-
38
- **[⬆ back to top](#構成)**
39
-
40
- ### 配置
41
-
42
- #### GitHub Pages セットアップ
43
-
44
- 1. **GitHub リポジトリの Settings を開く**
45
- - リポジトリページで `Settings` タブをクリック
46
-
47
- 2. **Pages 設定を開く**
48
- - 左サイドバーの `Pages` をクリック
49
-
50
- 3. **Source を設定**
51
- - `Source` で `Deploy from a branch` を選択
52
- - `Branch` で `gh-pages` を選択し、フォルダは `/ (root)` を選択
53
- - `Save` をクリック
54
-
55
- 4. **初回デプロイ**
56
- - main ブランチにプッシュすると GitHub Actions が自動実行
57
- - Actions タブでデプロイ状況を確認
58
-
59
- **[⬆ back to top](#構成)**
60
-
61
- ### 運用
62
-
63
- #### ドキュメントの編集
64
-
65
- 1. ローカル環境でMkDocsサーバーを起動
66
- ```
67
- docker-compose up mkdocs
68
- ```
69
- または、Gulpタスクを使用:
70
- ```
71
- npm run docs:serve
72
- ```
73
-
74
- 2. ブラウザで http://localhost:8000 にアクセスして編集結果をプレビュー
75
-
76
- 3. `docs/`ディレクトリ内のMarkdownファイルを編集
77
-
78
- 4. 変更をコミットしてプッシュ
79
- ```
80
- git add .
81
- git commit -m "ドキュメントの更新"
82
- git push
83
- ```
84
-
85
- #### Gulpタスクの使用
86
-
87
- プロジェクトには以下のGulpタスクが用意されています:
88
-
89
- ##### MkDocsタスク
90
-
91
- - MkDocsサーバーの起動:
92
- ```
93
- npm run docs:serve
94
- ```
95
- または
96
- ```
97
- npx gulp mkdocs:serve
98
- ```
99
-
100
- - MkDocsサーバーの停止:
101
- ```
102
- npm run docs:stop
103
- ```
104
- または
105
- ```
106
- npx gulp mkdocs:stop
107
- ```
108
-
109
- - MkDocsドキュメントのビルド:
110
- ```
111
- npm run docs:build
112
- ```
113
- または
114
- ```
115
- npx gulp mkdocs:build
116
- ```
117
-
118
- ##### 作業履歴(ジャーナル)タスク
119
-
120
- - すべてのコミット日付の作業履歴を生成:
121
- ```
122
- npm run journal
123
- ```
124
- または
125
- ```
126
- npx gulp journal:generate
127
- ```
128
-
129
- - 特定の日付の作業履歴を生成:
130
- ```
131
- npx gulp journal:generate:date --date=YYYY-MM-DD
132
- ```
133
- (例: `npx gulp journal:generate:date --date=2023-04-01`)
134
-
135
- 生成された作業履歴は `docs/journal/` ディレクトリに保存され、各ファイルには指定された日付のコミット情報が含まれます。
136
-
137
- #### GitHub Container Registry
138
-
139
- このプロジェクトでは、GitHub Container Registry(GHCR)を使用して開発コンテナイメージを管理しています。
140
-
141
- ##### 自動ビルド・プッシュ
142
-
143
- タグをプッシュすると、GitHub Actions が自動的にコンテナイメージをビルドし、GHCR にプッシュします。
144
-
145
- ```bash
146
- # タグを作成してプッシュ
147
- git tag 0.0.1
148
- git push origin 0.0.1
149
- ```
150
-
151
- ##### イメージの取得・実行
152
-
153
- GHCR からイメージを取得して実行するには:
154
-
155
- ```bash
156
- # イメージをプル
157
- docker pull ghcr.io/k2works/{project_name}:latest
158
-
159
- # または特定バージョン
160
- docker pull ghcr.io/k2works/{project_name}:0.0.1
161
-
162
- # コンテナを実行
163
- docker run -it -v $(pwd):/srv ghcr.io/k2works/{project_name}:latest
164
- ```
165
-
166
- または、docker-compose を使用してローカルでビルド・実行することもできます:
167
-
168
- ```bash
169
- # 開発環境を起動して中に入る
170
- docker-compose run --rm dev bash
171
- ```
172
-
173
- 認証が必要な場合は、以下のコマンドでログインします:
174
-
175
- ```bash
176
- # GitHub Personal Access Token でログイン
177
- echo $GITHUB_TOKEN | docker login ghcr.io -u <username> --password-stdin
178
- ```
179
-
180
- ##### 権限設定
181
-
182
- - リポジトリの Settings → Actions → General で `Read and write permissions` を設定
183
- - `GITHUB_TOKEN` に `packages: write` 権限が付与されています
184
-
185
- ##### Dev Container の使用
186
-
187
- VS Code で Dev Container を使用する場合:
188
-
189
- 1. VS Code で「Dev Containers: Reopen in Container」を実行
190
- 2. または「Dev Containers: Rebuild and Reopen in Container」で再ビルド
191
-
192
- **[⬆ back to top](#構成)**
193
-
194
- ### Nix による開発環境
195
-
196
- Nix を使用して、再現可能な開発環境を構築できます。
197
-
198
- #### 準備
199
-
200
- 1. [Nix をインストール](https://nixos.org/download.html)します。
201
- 2. Flakes を有効にします(`~/.config/nix/nix.conf` に `experimental-features = nix-command flakes` を追加)。
202
-
203
- #### 環境の利用
204
-
205
- - **デフォルト環境(共通ツール)に入る:**
206
- ```bash
207
- nix develop
208
- ```
209
-
210
- - **Node.js 環境に入る:**
211
- ```bash
212
- nix develop .#node
213
- ```
214
-
215
- - **Python/MkDocs 環境に入る:**
216
- ```bash
217
- nix develop .#python
218
- ```
219
-
220
- 環境から抜けるには `exit` を入力します。
221
-
222
- #### 依存関係の更新
223
-
224
- ```bash
225
- nix flake update
226
- ```
227
-
228
- **[⬆ back to top](#構成)**
229
-
230
- ### 開発
231
-
232
- **[⬆ back to top](#構成)**
233
-
234
- ## 参照
1
+ # {project-name}
2
+
3
+ ## 概要
4
+
5
+ ### 目的
6
+
7
+ ### 前提
8
+
9
+ | ソフトウェア | バージョン | 備考 |
10
+ | :----------- | :--------- | :--- |
11
+ | nodejs | 22.x | |
12
+
13
+ ## 構成
14
+
15
+ - [構築](#構築)
16
+ - [配置](#配置)
17
+ - [運用](#運用)
18
+ - [Nix による開発環境](#nix-による開発環境)
19
+ - [開発](#開発)
20
+
21
+ ## 詳細
22
+
23
+ ### Quick Start
24
+
25
+ ```bash
26
+ npm install
27
+ npm start
28
+ ```
29
+
30
+ ### 構築
31
+
32
+ ```bash
33
+ claude mcp add github npx @modelcontextprotocol/server-github -e GITHUB_PERSONAL_ACCESS_TOKEN=xxxxxxxxxxxxxxx
34
+ claude mcp add --transport http byterover-mcp --scope user https://mcp.byterover.dev/v2/mcp
35
+ claude mcp add github npx -y @modelcontextprotocol/server-github -s project
36
+ ```
37
+
38
+ **[⬆ back to top](#構成)**
39
+
40
+ ### 配置
41
+
42
+ #### GitHub Pages セットアップ
43
+
44
+ 1. **GitHub リポジトリの Settings を開く**
45
+ - リポジトリページで `Settings` タブをクリック
46
+
47
+ 2. **Pages 設定を開く**
48
+ - 左サイドバーの `Pages` をクリック
49
+
50
+ 3. **Source を設定**
51
+ - `Source` で `Deploy from a branch` を選択
52
+ - `Branch` で `gh-pages` を選択し、フォルダは `/ (root)` を選択
53
+ - `Save` をクリック
54
+
55
+ 4. **初回デプロイ**
56
+ - main ブランチにプッシュすると GitHub Actions が自動実行
57
+ - Actions タブでデプロイ状況を確認
58
+
59
+ **[⬆ back to top](#構成)**
60
+
61
+ ### 運用
62
+
63
+ #### ドキュメントの編集
64
+
65
+ 1. ローカル環境でMkDocsサーバーを起動
66
+ ```
67
+ docker-compose up mkdocs
68
+ ```
69
+ または、Gulpタスクを使用:
70
+ ```
71
+ npm run docs:serve
72
+ ```
73
+
74
+ 2. ブラウザで http://localhost:8000 にアクセスして編集結果をプレビュー
75
+
76
+ 3. `docs/`ディレクトリ内のMarkdownファイルを編集
77
+
78
+ 4. 変更をコミットしてプッシュ
79
+ ```
80
+ git add .
81
+ git commit -m "ドキュメントの更新"
82
+ git push
83
+ ```
84
+
85
+ #### Gulpタスクの使用
86
+
87
+ プロジェクトには以下のGulpタスクが用意されています:
88
+
89
+ ##### MkDocsタスク
90
+
91
+ - MkDocsサーバーの起動:
92
+ ```
93
+ npm run docs:serve
94
+ ```
95
+ または
96
+ ```
97
+ npx gulp mkdocs:serve
98
+ ```
99
+
100
+ - MkDocsサーバーの停止:
101
+ ```
102
+ npm run docs:stop
103
+ ```
104
+ または
105
+ ```
106
+ npx gulp mkdocs:stop
107
+ ```
108
+
109
+ - MkDocsドキュメントのビルド:
110
+ ```
111
+ npm run docs:build
112
+ ```
113
+ または
114
+ ```
115
+ npx gulp mkdocs:build
116
+ ```
117
+
118
+ ##### 作業履歴(ジャーナル)タスク
119
+
120
+ - すべてのコミット日付の作業履歴を生成:
121
+ ```
122
+ npm run journal
123
+ ```
124
+ または
125
+ ```
126
+ npx gulp journal:generate
127
+ ```
128
+
129
+ - 特定の日付の作業履歴を生成:
130
+ ```
131
+ npx gulp journal:generate:date --date=YYYY-MM-DD
132
+ ```
133
+ (例: `npx gulp journal:generate:date --date=2023-04-01`)
134
+
135
+ 生成された作業履歴は `docs/journal/` ディレクトリに保存され、各ファイルには指定された日付のコミット情報が含まれます。
136
+
137
+ #### GitHub Container Registry
138
+
139
+ このプロジェクトでは、GitHub Container Registry(GHCR)を使用して開発コンテナイメージを管理しています。
140
+
141
+ ##### 自動ビルド・プッシュ
142
+
143
+ タグをプッシュすると、GitHub Actions が自動的にコンテナイメージをビルドし、GHCR にプッシュします。
144
+
145
+ ```bash
146
+ # タグを作成してプッシュ
147
+ git tag 0.0.1
148
+ git push origin 0.0.1
149
+ ```
150
+
151
+ ##### イメージの取得・実行
152
+
153
+ GHCR からイメージを取得して実行するには:
154
+
155
+ ```bash
156
+ # イメージをプル
157
+ docker pull ghcr.io/k2works/{project_name}:latest
158
+
159
+ # または特定バージョン
160
+ docker pull ghcr.io/k2works/{project_name}:0.0.1
161
+
162
+ # コンテナを実行
163
+ docker run -it -v $(pwd):/srv ghcr.io/k2works/{project_name}:latest
164
+ ```
165
+
166
+ または、docker-compose を使用してローカルでビルド・実行することもできます:
167
+
168
+ ```bash
169
+ # 開発環境を起動して中に入る
170
+ docker-compose run --rm dev bash
171
+ ```
172
+
173
+ 認証が必要な場合は、以下のコマンドでログインします:
174
+
175
+ ```bash
176
+ # GitHub Personal Access Token でログイン
177
+ echo $GITHUB_TOKEN | docker login ghcr.io -u <username> --password-stdin
178
+ ```
179
+
180
+ ##### 権限設定
181
+
182
+ - リポジトリの Settings → Actions → General で `Read and write permissions` を設定
183
+ - `GITHUB_TOKEN` に `packages: write` 権限が付与されています
184
+
185
+ ##### Dev Container の使用
186
+
187
+ VS Code で Dev Container を使用する場合:
188
+
189
+ 1. VS Code で「Dev Containers: Reopen in Container」を実行
190
+ 2. または「Dev Containers: Rebuild and Reopen in Container」で再ビルド
191
+
192
+ **[⬆ back to top](#構成)**
193
+
194
+ ### Nix による開発環境
195
+
196
+ Nix を使用して、再現可能な開発環境を構築できます。
197
+
198
+ #### 準備
199
+
200
+ 1. [Nix をインストール](https://nixos.org/download.html)します。
201
+ 2. Flakes を有効にします(`~/.config/nix/nix.conf` に `experimental-features = nix-command flakes` を追加)。
202
+
203
+ #### 環境の利用
204
+
205
+ - **デフォルト環境(共通ツール)に入る:**
206
+ ```bash
207
+ nix develop
208
+ ```
209
+
210
+ - **Node.js 環境に入る:**
211
+ ```bash
212
+ nix develop .#node
213
+ ```
214
+
215
+ - **Python/MkDocs 環境に入る:**
216
+ ```bash
217
+ nix develop .#python
218
+ ```
219
+
220
+ 環境から抜けるには `exit` を入力します。
221
+
222
+ #### 依存関係の更新
223
+
224
+ ```bash
225
+ nix flake update
226
+ ```
227
+
228
+ **[⬆ back to top](#構成)**
229
+
230
+ ### 開発
231
+
232
+ **[⬆ back to top](#構成)**
233
+
234
+ ## 参照