@k2works/claude-code-booster 0.16.0 → 0.16.2

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 +104 -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 +20 -20
  73. package/lib/assets/ops/nix/shells/shell.nix +21 -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
package/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2025 Katuyuki Kakigi
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Katuyuki Kakigi
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,42 +1,42 @@
1
- # claude-code-booster
2
-
3
- ## What's this
4
-
5
- AI Agent Development Support Tool
6
-
7
- ## Install
8
-
9
- ```
10
- npm install @k2works/claude-code-booster
11
- ```
12
-
13
- ## Usage
14
-
15
- - Initialize/copy all assets to your project root:
16
- ```sh
17
- npx boost
18
- ```
19
-
20
- - Update only .claude and docs directories in an existing project:
21
- ```sh
22
- npx boost --update
23
- ```
24
-
25
- ### What gets updated with --update
26
- - .claude: prompts, commands, and config shipped with this package
27
- - docs: documentation templates
28
-
29
- ### Notes
30
- - Existing files under .claude and docs will be overwritten.
31
- - Other files are left untouched.
32
-
33
- ## Development
34
-
35
- ```
36
- npm install
37
- npm start
38
- ```
39
-
40
- ## License
41
-
42
- MIT. Copyright (c) [k2works](http://feross.org).
1
+ # claude-code-booster
2
+
3
+ ## What's this
4
+
5
+ AI Agent Development Support Tool
6
+
7
+ ## Install
8
+
9
+ ```
10
+ npm install @k2works/claude-code-booster
11
+ ```
12
+
13
+ ## Usage
14
+
15
+ - Initialize/copy all assets to your project root:
16
+ ```sh
17
+ npx boost
18
+ ```
19
+
20
+ - Update only .claude and docs directories in an existing project:
21
+ ```sh
22
+ npx boost --update
23
+ ```
24
+
25
+ ### What gets updated with --update
26
+ - .claude: prompts, commands, and config shipped with this package
27
+ - docs: documentation templates
28
+
29
+ ### Notes
30
+ - Existing files under .claude and docs will be overwritten.
31
+ - Other files are left untouched.
32
+
33
+ ## Development
34
+
35
+ ```
36
+ npm install
37
+ npm start
38
+ ```
39
+
40
+ ## License
41
+
42
+ MIT. Copyright (c) [k2works](http://feross.org).
@@ -1,69 +1,69 @@
1
- #!/usr/bin/env node
2
-
3
- const path = require('path');
4
- const fs = require('fs-extra');
5
-
6
- const TEMPLATE_DIR = 'lib/assets';
7
-
8
- async function setupProject() {
9
- // プロジェクトのルートディレクトリのパスを取得する
10
- const projectDir = process.env.INIT_CWD || process.cwd();
11
-
12
- // パッケージのルートディレクトリのパスを取得する
13
- const packageDir = path.join(__dirname, '..');
14
-
15
- // テンプレートファイルが含まれるディレクトリのパスを取得する
16
- const templateDir = path.join(packageDir, TEMPLATE_DIR);
17
-
18
- // コマンドライン引数の解析
19
- const args = process.argv.slice(2);
20
- const isUpdate = args.includes('--update');
21
-
22
- try {
23
- if (isUpdate) {
24
- // --update オプション時は .claude と docs 配下のみ上書きコピー
25
- const targets = ['.claude', 'docs'];
26
- for (const dir of targets) {
27
- const src = path.join(templateDir, dir);
28
- const dest = path.join(projectDir, dir);
29
- if (await fs.pathExists(src)) {
30
- await fs.ensureDir(dest);
31
-
32
- // docs 配下の index.md は上書き対象から除外する
33
- const copyOptions = dir === 'docs'
34
- ? {
35
- overwrite: true,
36
- errorOnExist: false,
37
- filter: (from, to) => {
38
- // docs 直下の index.md のみ除外する(他は全てコピー)
39
- const indexPath = path.join(src, 'index.md');
40
- return from !== indexPath;
41
- },
42
- }
43
- : { overwrite: true, errorOnExist: false };
44
-
45
- await fs.copy(src, dest, copyOptions);
46
- if (dir === 'docs') {
47
- console.log('[claude-code-booster] Updated "docs" (excluding docs/index.md)');
48
- } else {
49
- console.log(`[claude-code-booster] Updated "${dir}" from "${src}" to "${dest}"`);
50
- }
51
- } else {
52
- console.warn(`[claude-code-booster] Skip: source not found "${src}"`);
53
- }
54
- }
55
- } else {
56
- // それ以外は従来通り assets 全体をコピー
57
- await fs.copy(templateDir, projectDir, { overwrite: true, errorOnExist: false });
58
- console.log(`[claude-code-booster] Copied assets from "${templateDir}" to "${projectDir}"`);
59
- }
60
- } catch (err) {
61
- console.error('[claude-code-booster] Asset copy failed:', err);
62
- process.exitCode = 1;
63
- return;
64
- }
65
-
66
- // 追加のセットアップ処理があればここに記述
67
- }
68
-
1
+ #!/usr/bin/env node
2
+
3
+ const path = require('path');
4
+ const fs = require('fs-extra');
5
+
6
+ const TEMPLATE_DIR = 'lib/assets';
7
+
8
+ async function setupProject() {
9
+ // プロジェクトのルートディレクトリのパスを取得する
10
+ const projectDir = process.env.INIT_CWD || process.cwd();
11
+
12
+ // パッケージのルートディレクトリのパスを取得する
13
+ const packageDir = path.join(__dirname, '..');
14
+
15
+ // テンプレートファイルが含まれるディレクトリのパスを取得する
16
+ const templateDir = path.join(packageDir, TEMPLATE_DIR);
17
+
18
+ // コマンドライン引数の解析
19
+ const args = process.argv.slice(2);
20
+ const isUpdate = args.includes('--update');
21
+
22
+ try {
23
+ if (isUpdate) {
24
+ // --update オプション時は .claude と docs 配下のみ上書きコピー
25
+ const targets = ['.claude', 'docs'];
26
+ for (const dir of targets) {
27
+ const src = path.join(templateDir, dir);
28
+ const dest = path.join(projectDir, dir);
29
+ if (await fs.pathExists(src)) {
30
+ await fs.ensureDir(dest);
31
+
32
+ // docs 配下の index.md は上書き対象から除外する
33
+ const copyOptions = dir === 'docs'
34
+ ? {
35
+ overwrite: true,
36
+ errorOnExist: false,
37
+ filter: (from, to) => {
38
+ // docs 直下の index.md のみ除外する(他は全てコピー)
39
+ const indexPath = path.join(src, 'index.md');
40
+ return from !== indexPath;
41
+ },
42
+ }
43
+ : { overwrite: true, errorOnExist: false };
44
+
45
+ await fs.copy(src, dest, copyOptions);
46
+ if (dir === 'docs') {
47
+ console.log('[claude-code-booster] Updated "docs" (excluding docs/index.md)');
48
+ } else {
49
+ console.log(`[claude-code-booster] Updated "${dir}" from "${src}" to "${dest}"`);
50
+ }
51
+ } else {
52
+ console.warn(`[claude-code-booster] Skip: source not found "${src}"`);
53
+ }
54
+ }
55
+ } else {
56
+ // それ以外は従来通り assets 全体をコピー
57
+ await fs.copy(templateDir, projectDir, { overwrite: true, errorOnExist: false });
58
+ console.log(`[claude-code-booster] Copied assets from "${templateDir}" to "${projectDir}"`);
59
+ }
60
+ } catch (err) {
61
+ console.error('[claude-code-booster] Asset copy failed:', err);
62
+ process.exitCode = 1;
63
+ return;
64
+ }
65
+
66
+ // 追加のセットアップ処理があればここに記述
67
+ }
68
+
69
69
  setupProject();
@@ -1,45 +1,45 @@
1
- {
2
- "mcpServers": {
3
- "Context7": {
4
- "command": "npx",
5
- "args": ["-y", "@upstash/context7-mcp"]
6
- },
7
- "github": {
8
- "command": "npx",
9
- "args": ["-y", "@modelcontextprotocol/server-github"],
10
- "env": {
11
- "GITHUB_PERSONAL_ACCESS_TOKEN": "ghp_*****************"
12
- }
13
- },
14
- "notionMCP": {
15
- "command": "npx",
16
- "args": ["-y", "mcp-remote", "https://mcp.notion.com/sse"]
17
- },
18
- "deepwiki": {
19
- "command": "npx",
20
- "args": ["mcp-remote", "https://mcp.deepwiki.com/sse"]
21
- },
22
- "filesystem": {
23
- "command": "npx",
24
- "args": ["-y", "@modelcontextprotocol/server-filesystem", "~/git"],
25
- "env": {}
26
- },
27
- "fetch": {
28
- "command": "uvx",
29
- "args": ["mcp-server-fetch"],
30
- "env": {}
31
- },
32
- "sequential-thinking": {
33
- "command": "npx",
34
- "args": ["-y", "@modelcontextprotocol/server-sequential-thinking"]
35
- },
36
- "serena": {
37
- "command": "uvx",
38
- "args": [
39
- "--from",
40
- "git+https://github.com/oraios/serena",
41
- "serena-mcp-server"
42
- ]
43
- }
44
- }
45
- }
1
+ {
2
+ "mcpServers": {
3
+ "Context7": {
4
+ "command": "npx",
5
+ "args": ["-y", "@upstash/context7-mcp"]
6
+ },
7
+ "github": {
8
+ "command": "npx",
9
+ "args": ["-y", "@modelcontextprotocol/server-github"],
10
+ "env": {
11
+ "GITHUB_PERSONAL_ACCESS_TOKEN": "ghp_*****************"
12
+ }
13
+ },
14
+ "notionMCP": {
15
+ "command": "npx",
16
+ "args": ["-y", "mcp-remote", "https://mcp.notion.com/sse"]
17
+ },
18
+ "deepwiki": {
19
+ "command": "npx",
20
+ "args": ["mcp-remote", "https://mcp.deepwiki.com/sse"]
21
+ },
22
+ "filesystem": {
23
+ "command": "npx",
24
+ "args": ["-y", "@modelcontextprotocol/server-filesystem", "~/git"],
25
+ "env": {}
26
+ },
27
+ "fetch": {
28
+ "command": "uvx",
29
+ "args": ["mcp-server-fetch"],
30
+ "env": {}
31
+ },
32
+ "sequential-thinking": {
33
+ "command": "npx",
34
+ "args": ["-y", "@modelcontextprotocol/server-sequential-thinking"]
35
+ },
36
+ "serena": {
37
+ "command": "uvx",
38
+ "args": [
39
+ "--from",
40
+ "git+https://github.com/oraios/serena",
41
+ "serena-mcp-server"
42
+ ]
43
+ }
44
+ }
45
+ }
@@ -1,122 +1,122 @@
1
- ## Command Name
2
-
3
- コマンドの簡潔な説明(1 行で何をするコマンドか説明)。
4
-
5
- <!--
6
- テンプレート使用時の注意:
7
- - 必須セクション: タイトル、説明、使い方、基本例、Claude との連携、注意事項
8
- - オプションセクション: オプション、詳細機能、出力例、ベストプラクティス、関連コマンド
9
- - コマンドの複雑さに応じて必要なセクションのみを使用してください
10
- -->
11
-
12
- ### 使い方
13
-
14
- ```bash
15
- /command-name [オプション]
16
- ```
17
-
18
- ### オプション
19
-
20
- - なし : デフォルトの動作
21
- - `--option1` : オプション 1 の説明
22
- - `--option2 <値>` : パラメータを取るオプションの説明
23
- - `--flag` : フラグオプションの説明
24
-
25
- ※ オプションが不要なコマンドの場合は、このセクション全体を省略可能です。
26
-
27
- ### 基本例
28
-
29
- ```bash
30
- # 基本的な使い方
31
- /command-name
32
- 「実行する際の説明」
33
-
34
- # オプション付きの例
35
- /command-name --option1
36
- 「オプション 1 を使った場合の説明」
37
-
38
- # パラメータ付きオプションの例
39
- /command-name --option2 value
40
- 「パラメータ付きオプションの使用例」
41
-
42
- # 複数オプションの組み合わせ
43
- /command-name --option1 --flag
44
- 「複数オプションを組み合わせた例」
45
- ```
46
-
47
- ### 詳細機能(オプション)
48
-
49
- #### 機能カテゴリ 1
50
-
51
- 機能の詳細説明と使用場面の説明。
52
-
53
- ```bash
54
- # 具体的なコード例
55
- command example
56
- ```
57
-
58
- #### 機能カテゴリ 2
59
-
60
- 別の機能の詳細説明。
61
-
62
- - **特徴 1**: 説明
63
- - **特徴 2**: 説明
64
- - **特徴 3**: 説明
65
-
66
- ※ シンプルなコマンドの場合、このセクションは省略可能です。
67
-
68
- ### 出力例(オプション)
69
-
70
- ```
71
- 期待される出力フォーマットの例
72
- ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
73
-
74
- 実際の出力内容のサンプル
75
- ├─ 項目 1: 値
76
- ├─ 項目 2: 値
77
- └─ 項目 3: 値
78
- ```
79
-
80
- ※ 出力が単純な場合や、基本例で十分説明できる場合は、このセクションは省略可能です。
81
-
82
- ### Claude との連携
83
-
84
- ```bash
85
- # ファイルと組み合わせた使用例
86
- cat file.txt
87
- /command-name
88
- 「ファイル内容を含めた分析を依頼」
89
-
90
- # パイプラインでの使用例
91
- command1 | command2
92
- /command-name
93
- 「前のコマンドの出力を使った処理」
94
-
95
- # 複雑な分析の例
96
- ls -la && cat config.json
97
- /command-name --option1
98
- 「複数の情報を組み合わせた分析」
99
- ```
100
-
101
- ### 注意事項
102
-
103
- - **前提条件**: コマンド実行に必要な前提条件
104
- - **制限事項**: 機能の制限や注意すべき点
105
- - **推奨事項**: 効果的な使用方法の推奨
106
-
107
- ### ベストプラクティス(オプション)
108
-
109
- 1. **原則 1**: 推奨される使用方法の説明
110
- 2. **原則 2**: 避けるべき使用方法の説明
111
- 3. **原則 3**: パフォーマンスや効率に関する推奨
112
- 4. **原則 4**: セキュリティや安全性に関する推奨
113
-
114
- ※ シンプルなコマンドで特別な注意点がない場合は、このセクションは省略可能です。
115
-
116
- ### 関連コマンド(オプション)
117
-
118
- - `/related-command1` : 関連する機能を持つコマンド
119
- - `/related-command2` : 組み合わせて使うと効果的なコマンド
120
- - `/related-command3` : 代替として使えるコマンド
121
-
122
- ※ 関連するコマンドがない場合は、このセクションは省略可能です。
1
+ ## Command Name
2
+
3
+ コマンドの簡潔な説明(1 行で何をするコマンドか説明)。
4
+
5
+ <!--
6
+ テンプレート使用時の注意:
7
+ - 必須セクション: タイトル、説明、使い方、基本例、Claude との連携、注意事項
8
+ - オプションセクション: オプション、詳細機能、出力例、ベストプラクティス、関連コマンド
9
+ - コマンドの複雑さに応じて必要なセクションのみを使用してください
10
+ -->
11
+
12
+ ### 使い方
13
+
14
+ ```bash
15
+ /command-name [オプション]
16
+ ```
17
+
18
+ ### オプション
19
+
20
+ - なし : デフォルトの動作
21
+ - `--option1` : オプション 1 の説明
22
+ - `--option2 <値>` : パラメータを取るオプションの説明
23
+ - `--flag` : フラグオプションの説明
24
+
25
+ ※ オプションが不要なコマンドの場合は、このセクション全体を省略可能です。
26
+
27
+ ### 基本例
28
+
29
+ ```bash
30
+ # 基本的な使い方
31
+ /command-name
32
+ 「実行する際の説明」
33
+
34
+ # オプション付きの例
35
+ /command-name --option1
36
+ 「オプション 1 を使った場合の説明」
37
+
38
+ # パラメータ付きオプションの例
39
+ /command-name --option2 value
40
+ 「パラメータ付きオプションの使用例」
41
+
42
+ # 複数オプションの組み合わせ
43
+ /command-name --option1 --flag
44
+ 「複数オプションを組み合わせた例」
45
+ ```
46
+
47
+ ### 詳細機能(オプション)
48
+
49
+ #### 機能カテゴリ 1
50
+
51
+ 機能の詳細説明と使用場面の説明。
52
+
53
+ ```bash
54
+ # 具体的なコード例
55
+ command example
56
+ ```
57
+
58
+ #### 機能カテゴリ 2
59
+
60
+ 別の機能の詳細説明。
61
+
62
+ - **特徴 1**: 説明
63
+ - **特徴 2**: 説明
64
+ - **特徴 3**: 説明
65
+
66
+ ※ シンプルなコマンドの場合、このセクションは省略可能です。
67
+
68
+ ### 出力例(オプション)
69
+
70
+ ```
71
+ 期待される出力フォーマットの例
72
+ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
73
+
74
+ 実際の出力内容のサンプル
75
+ ├─ 項目 1: 値
76
+ ├─ 項目 2: 値
77
+ └─ 項目 3: 値
78
+ ```
79
+
80
+ ※ 出力が単純な場合や、基本例で十分説明できる場合は、このセクションは省略可能です。
81
+
82
+ ### Claude との連携
83
+
84
+ ```bash
85
+ # ファイルと組み合わせた使用例
86
+ cat file.txt
87
+ /command-name
88
+ 「ファイル内容を含めた分析を依頼」
89
+
90
+ # パイプラインでの使用例
91
+ command1 | command2
92
+ /command-name
93
+ 「前のコマンドの出力を使った処理」
94
+
95
+ # 複雑な分析の例
96
+ ls -la && cat config.json
97
+ /command-name --option1
98
+ 「複数の情報を組み合わせた分析」
99
+ ```
100
+
101
+ ### 注意事項
102
+
103
+ - **前提条件**: コマンド実行に必要な前提条件
104
+ - **制限事項**: 機能の制限や注意すべき点
105
+ - **推奨事項**: 効果的な使用方法の推奨
106
+
107
+ ### ベストプラクティス(オプション)
108
+
109
+ 1. **原則 1**: 推奨される使用方法の説明
110
+ 2. **原則 2**: 避けるべき使用方法の説明
111
+ 3. **原則 3**: パフォーマンスや効率に関する推奨
112
+ 4. **原則 4**: セキュリティや安全性に関する推奨
113
+
114
+ ※ シンプルなコマンドで特別な注意点がない場合は、このセクションは省略可能です。
115
+
116
+ ### 関連コマンド(オプション)
117
+
118
+ - `/related-command1` : 関連する機能を持つコマンド
119
+ - `/related-command2` : 組み合わせて使うと効果的なコマンド
120
+ - `/related-command3` : 代替として使えるコマンド
121
+
122
+ ※ 関連するコマンドがない場合は、このセクションは省略可能です。