@sk8metal/michi-cli 0.0.5 → 0.0.7
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.
- package/CHANGELOG.md +32 -0
- package/README.md +43 -31
- package/dist/src/cli.d.ts.map +1 -1
- package/dist/src/cli.js +30 -7
- package/dist/src/cli.js.map +1 -1
- package/docs/README.md +93 -0
- package/docs/contributing/development.md +304 -0
- package/docs/{new-project-setup.md → getting-started/new-project-setup.md} +2 -2
- package/docs/getting-started/quick-start.md +145 -0
- package/docs/{setup.md → getting-started/setup.md} +58 -46
- package/docs/{customization-guide.md → guides/customization.md} +4 -4
- package/docs/{multi-project.md → guides/multi-project.md} +4 -4
- package/package.json +3 -1
- package/scripts/set-permissions.js +29 -0
- /package/docs/{release.md → contributing/release.md} +0 -0
- /package/docs/{phase-automation.md → guides/phase-automation.md} +0 -0
- /package/docs/{workflow.md → guides/workflow.md} +0 -0
- /package/docs/{config-reference.md → reference/config.md} +0 -0
- /package/docs/{quick-reference.md → reference/quick-reference.md} +0 -0
- /package/docs/{tasks-template.md → reference/tasks-template.md} +0 -0
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,38 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [0.0.7] - 2025-11-14
|
|
9
|
+
|
|
10
|
+
### Fixed
|
|
11
|
+
- CLIバージョン表示が正しく動作しない問題を修正
|
|
12
|
+
- `michi --version`が`1.0.0`と表示されていた問題を修正
|
|
13
|
+
- `package.json`から動的にバージョンを読み込むように変更
|
|
14
|
+
- シンボリックリンク経由での実行時も正しく動作するように条件チェックを改善(`fileURLToPath`と`realpathSync`を使用)
|
|
15
|
+
|
|
16
|
+
## [0.0.6] - 2025-11-14
|
|
17
|
+
|
|
18
|
+
### Fixed
|
|
19
|
+
- NPM公開パッケージのCLIコマンドが実行権限不足で動作しない問題を修正
|
|
20
|
+
- Windows互換のNode.jsスクリプト(`scripts/set-permissions.js`)を追加
|
|
21
|
+
- `postbuild`を`chmod`コマンドから`node scripts/set-permissions.js`に変更
|
|
22
|
+
- Windows環境では権限設定をスキップし、Unix系OSでのみ実行権限を付与
|
|
23
|
+
- これにより`npm install -g @sk8metal/michi-cli`後、すべてのプラットフォームで`michi --version`や`michi --help`が正常に動作するようになります
|
|
24
|
+
|
|
25
|
+
### Changed
|
|
26
|
+
- ドキュメント構造を大幅に再編成(目的別カテゴリに分類)
|
|
27
|
+
- `docs/getting-started/`: 初めてMichiを使う方向けのガイド
|
|
28
|
+
- `docs/guides/`: 実践的な開発ガイド
|
|
29
|
+
- `docs/reference/`: コマンド・設定値リファレンス
|
|
30
|
+
- `docs/contributing/`: コントリビューター向けガイド
|
|
31
|
+
- `setup.md`を利用者向け(`docs/getting-started/setup.md`)と開発者向け(`docs/contributing/development.md`)に分離
|
|
32
|
+
- ルートに`CONTRIBUTING.md`を追加(コントリビューションガイドラインの明確化)
|
|
33
|
+
- `docs/README.md`を追加(ドキュメントハブとして機能)
|
|
34
|
+
|
|
35
|
+
### Added
|
|
36
|
+
- `docs/getting-started/quick-start.md`: 5分で始めるクイックスタートガイド
|
|
37
|
+
- 39箇所以上のドキュメント内リンクを新しい構造に合わせて更新
|
|
38
|
+
- `npm run format`コマンドを追加(Prettierによるコードフォーマット)
|
|
39
|
+
|
|
8
40
|
## [0.0.5] - 2025-11-13
|
|
9
41
|
|
|
10
42
|
### Changed
|
package/README.md
CHANGED
|
@@ -48,16 +48,11 @@ JIRA ← タスク管理・進捗追跡
|
|
|
48
48
|
# グローバルインストール
|
|
49
49
|
npm install -g @sk8metal/michi-cli
|
|
50
50
|
|
|
51
|
-
#
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
# 使用方法
|
|
55
|
-
npx @sk8metal/michi-cli --help
|
|
56
|
-
# または、グローバルインストール後
|
|
57
|
-
michi --help
|
|
51
|
+
# インストール確認
|
|
52
|
+
michi --version
|
|
58
53
|
```
|
|
59
54
|
|
|
60
|
-
#### 方法2:
|
|
55
|
+
#### 方法2: リポジトリからクローン(開発者向け)
|
|
61
56
|
|
|
62
57
|
```bash
|
|
63
58
|
# リポジトリのクローン
|
|
@@ -68,21 +63,27 @@ cd michi
|
|
|
68
63
|
# jj git clone https://github.com/sk8metalme/michi
|
|
69
64
|
# cd michi
|
|
70
65
|
|
|
66
|
+
# 依存関係のインストール
|
|
67
|
+
npm install
|
|
68
|
+
|
|
69
|
+
# ビルド
|
|
70
|
+
npm run build
|
|
71
|
+
|
|
72
|
+
# グローバルコマンドとしてリンク
|
|
73
|
+
npm link
|
|
74
|
+
|
|
71
75
|
# cc-sddのインストール(AI駆動開発ワークフローのコア)
|
|
72
76
|
npx cc-sdd@latest --lang ja --cursor
|
|
73
77
|
# または Claude Code の場合: npx cc-sdd@latest --lang ja --claude
|
|
74
78
|
|
|
75
|
-
# 依存関係のインストール
|
|
76
|
-
npm install
|
|
77
|
-
|
|
78
79
|
# 環境変数の設定
|
|
79
80
|
cp env.example .env
|
|
80
81
|
# .env ファイルを編集して認証情報を設定
|
|
81
|
-
#
|
|
82
|
+
#
|
|
82
83
|
# 【重要】JIRA Issue Type IDの設定
|
|
83
84
|
# JIRA_ISSUE_TYPE_STORY と JIRA_ISSUE_TYPE_SUBTASK は必須です。
|
|
84
85
|
# これらの値はJIRAインスタンス固有のため、各デプロイメントで設定が必要です。
|
|
85
|
-
#
|
|
86
|
+
#
|
|
86
87
|
# 確認方法:
|
|
87
88
|
# 1. JIRA管理画面: Settings > Issues > Issue types で確認
|
|
88
89
|
# 2. REST API: GET https://your-domain.atlassian.net/rest/api/3/issuetype
|
|
@@ -90,10 +91,10 @@ cp env.example .env
|
|
|
90
91
|
|
|
91
92
|
# MCP設定(Cursor用)
|
|
92
93
|
# mcp.json.example を参考に ~/.cursor/mcp.json を作成
|
|
93
|
-
# (詳細はdocs/setup.md参照)
|
|
94
|
+
# (詳細はdocs/getting-started/setup.md参照)
|
|
94
95
|
```
|
|
95
96
|
|
|
96
|
-
詳細なセットアップ手順は [docs/setup.md](./docs/setup.md) を参照してください。
|
|
97
|
+
詳細なセットアップ手順は [docs/getting-started/setup.md](./docs/getting-started/setup.md) を参照してください。
|
|
97
98
|
|
|
98
99
|
## 使い方
|
|
99
100
|
|
|
@@ -221,7 +222,7 @@ OSS公開に対応するため、以下のテンプレートファイルを用
|
|
|
221
222
|
- Confluenceページ作成粒度の設定
|
|
222
223
|
- JIRAストーリー作成粒度の設定
|
|
223
224
|
- ワークフロー設定
|
|
224
|
-
- 詳細は [設定値リファレンス](./docs/config
|
|
225
|
+
- 詳細は [設定値リファレンス](./docs/reference/config.md) を参照
|
|
225
226
|
- **注意**: 以前は `.kiro/config.json` を使用していましたが、Michi専用の設定ファイルとして `.michi/config.json` に変更されました。
|
|
226
227
|
|
|
227
228
|
**初回セットアップ時:**
|
|
@@ -237,7 +238,7 @@ cp mcp.json.example ~/.cursor/mcp.json
|
|
|
237
238
|
|
|
238
239
|
# プロジェクト固有設定(オプション)
|
|
239
240
|
# .michi/config.json を作成して、Confluence/JIRAの動作をカスタマイズ
|
|
240
|
-
# 詳細は docs/config
|
|
241
|
+
# 詳細は docs/reference/config.md を参照
|
|
241
242
|
```
|
|
242
243
|
|
|
243
244
|
**承認者の設定:**
|
|
@@ -255,7 +256,7 @@ APPROVAL_GATES_DESIGN=アーキテクト,部長
|
|
|
255
256
|
APPROVAL_GATES_RELEASE=SM,部長
|
|
256
257
|
```
|
|
257
258
|
|
|
258
|
-
詳細は [セットアップガイド](./docs/setup.md#
|
|
259
|
+
詳細は [セットアップガイド](./docs/getting-started/setup.md#3-3-ワークフロー承認ゲートの設定オプション) を参照してください。
|
|
259
260
|
|
|
260
261
|
## 他のリポジトリでプロジェクトを進める
|
|
261
262
|
|
|
@@ -287,20 +288,31 @@ npm run create-project -- \
|
|
|
287
288
|
--jira-key "PRJA"
|
|
288
289
|
```
|
|
289
290
|
|
|
290
|
-
詳細: [新規プロジェクトセットアップガイド](./docs/new-project-setup.md)
|
|
291
|
+
詳細: [新規プロジェクトセットアップガイド](./docs/getting-started/new-project-setup.md)
|
|
291
292
|
|
|
292
293
|
## ドキュメント
|
|
293
294
|
|
|
294
|
-
|
|
295
|
-
- [
|
|
296
|
-
- [
|
|
297
|
-
- [
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
- [ワークフローガイド](./docs/workflow.md) - AI開発フロー
|
|
301
|
-
- [
|
|
302
|
-
- [
|
|
303
|
-
- [
|
|
295
|
+
### はじめに
|
|
296
|
+
- [クイックスタート](./docs/getting-started/quick-start.md) - 5分で始める ⭐
|
|
297
|
+
- [セットアップガイド](./docs/getting-started/setup.md) - インストール・設定手順
|
|
298
|
+
- [新規プロジェクトセットアップ](./docs/getting-started/new-project-setup.md) - 他リポジトリでの開始方法
|
|
299
|
+
|
|
300
|
+
### 実践ガイド
|
|
301
|
+
- [ワークフローガイド](./docs/guides/workflow.md) - AI開発フロー ⭐
|
|
302
|
+
- [フェーズ自動化ガイド](./docs/guides/phase-automation.md) - Confluence/JIRA自動作成 ⭐
|
|
303
|
+
- [マルチプロジェクト管理](./docs/guides/multi-project.md) - 複数プロジェクト管理
|
|
304
|
+
- [カスタマイズガイド](./docs/guides/customization.md) - Confluence/JIRA階層構造のカスタマイズ
|
|
305
|
+
|
|
306
|
+
### リファレンス
|
|
307
|
+
- [クイックリファレンス](./docs/reference/quick-reference.md) - コマンド一覧、チートシート ⭐
|
|
308
|
+
- [設定値リファレンス](./docs/reference/config.md) - `.michi/config.json`の全設定値の説明
|
|
309
|
+
|
|
310
|
+
### コントリビューター向け
|
|
311
|
+
- [コントリビューションガイド](./CONTRIBUTING.md) - 貢献方法
|
|
312
|
+
- [開発環境セットアップ](./docs/contributing/development.md) - 開発者向けセットアップ
|
|
313
|
+
- [リリース手順](./docs/contributing/release.md) - バージョンアップ・NPM公開手順
|
|
314
|
+
|
|
315
|
+
すべてのドキュメントは [docs/README.md](./docs/README.md) から参照できます。
|
|
304
316
|
|
|
305
317
|
|
|
306
318
|
## CI/CD
|
|
@@ -320,13 +332,13 @@ npm run create-project -- \
|
|
|
320
332
|
- **自動リリース**: `v*`タグ作成時に自動NPMパッケージ公開
|
|
321
333
|
- **Dependabot**: 依存関係の自動更新プルリクエスト
|
|
322
334
|
|
|
323
|
-
詳細は [CI/CD整備計画](./docs/
|
|
335
|
+
詳細は [CI/CD整備計画](./docs/contributing/ci-cd.md) を参照してください。
|
|
324
336
|
|
|
325
337
|
### NPM_TOKEN設定
|
|
326
338
|
|
|
327
339
|
リリース自動化を有効にするには、NPM_TOKENの設定が必要です。
|
|
328
340
|
|
|
329
|
-
**設定手順**: [NPM_TOKEN設定ガイド](./docs/npm-token-setup.md)
|
|
341
|
+
**設定手順**: [NPM_TOKEN設定ガイド](./docs/contributing/npm-token-setup.md)
|
|
330
342
|
|
|
331
343
|
**設定内容**:
|
|
332
344
|
1. NPMアカウントでAutomation Tokenを生成
|
package/dist/src/cli.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":";AACA;;;GAGG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;
|
|
1
|
+
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":";AACA;;;GAGG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AA6CpC;;GAEG;AACH,wBAAgB,SAAS,IAAI,OAAO,CA2LnC"}
|
package/dist/src/cli.js
CHANGED
|
@@ -4,6 +4,8 @@
|
|
|
4
4
|
* AI駆動開発ワークフロー自動化コマンドラインツール
|
|
5
5
|
*/
|
|
6
6
|
import { Command } from 'commander';
|
|
7
|
+
import { fileURLToPath } from 'url';
|
|
8
|
+
import { realpathSync } from 'fs';
|
|
7
9
|
import { syncTasksToJIRA } from '../scripts/jira-sync.js';
|
|
8
10
|
import { syncToConfluence } from '../scripts/confluence-sync.js';
|
|
9
11
|
import { runPhase } from '../scripts/phase-runner.js';
|
|
@@ -15,12 +17,19 @@ import { WorkflowOrchestrator } from '../scripts/workflow-orchestrator.js';
|
|
|
15
17
|
import { configInteractive } from '../scripts/config-interactive.js';
|
|
16
18
|
import { validateAndReport } from '../scripts/utils/config-validator.js';
|
|
17
19
|
import { config } from 'dotenv';
|
|
20
|
+
import { readFileSync, existsSync } from 'fs';
|
|
21
|
+
import { dirname, join } from 'path';
|
|
22
|
+
// package.jsonからバージョンを読み込む
|
|
23
|
+
// コンパイル後は dist/src/cli.js から実行されるため、2階層上がる必要がある
|
|
24
|
+
// テスト環境では src/cli.ts から直接実行されるため、process.cwd()も考慮する
|
|
25
|
+
const __filename = fileURLToPath(import.meta.url);
|
|
26
|
+
const __dirname = dirname(__filename);
|
|
27
|
+
// まず、コンパイル後のパス(dist/src/cli.js)を試す
|
|
28
|
+
const distPath = join(__dirname, '..', '..', 'package.json');
|
|
29
|
+
const packageJsonPath = existsSync(distPath) ? distPath : join(process.cwd(), 'package.json');
|
|
30
|
+
const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));
|
|
18
31
|
// 環境変数読み込み
|
|
19
32
|
config();
|
|
20
|
-
const packageJson = {
|
|
21
|
-
name: '@michi/cli',
|
|
22
|
-
version: '1.0.0'
|
|
23
|
-
};
|
|
24
33
|
/**
|
|
25
34
|
* 環境変数から承認ゲートのロールリストを取得
|
|
26
35
|
* @param envVar 環境変数名
|
|
@@ -222,8 +231,22 @@ export function createCLI() {
|
|
|
222
231
|
return program;
|
|
223
232
|
}
|
|
224
233
|
// CLI実行(直接実行時)
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
234
|
+
// import.meta.urlとprocess.argv[1]を正規化して比較(シンボリックリンク対応)
|
|
235
|
+
if (process.argv[1]) {
|
|
236
|
+
try {
|
|
237
|
+
const currentFile = fileURLToPath(import.meta.url);
|
|
238
|
+
const executedFile = realpathSync(process.argv[1]);
|
|
239
|
+
if (currentFile === executedFile) {
|
|
240
|
+
const program = createCLI();
|
|
241
|
+
program.parse();
|
|
242
|
+
}
|
|
243
|
+
}
|
|
244
|
+
catch {
|
|
245
|
+
// realpathSyncが失敗した場合は、直接比較を試みる
|
|
246
|
+
if (fileURLToPath(import.meta.url) === process.argv[1]) {
|
|
247
|
+
const program = createCLI();
|
|
248
|
+
program.parse();
|
|
249
|
+
}
|
|
250
|
+
}
|
|
228
251
|
}
|
|
229
252
|
//# sourceMappingURL=cli.js.map
|
package/dist/src/cli.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":";AACA;;;GAGG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAC3E,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAC;AACzE,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;
|
|
1
|
+
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":";AACA;;;GAGG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,IAAI,CAAC;AAClC,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAC3E,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAC;AACzE,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAErC,2BAA2B;AAC3B,gDAAgD;AAChD,oDAAoD;AACpD,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClD,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AACtC,mCAAmC;AACnC,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;AAC7D,MAAM,eAAe,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC;AAC9F,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;AAEvE,WAAW;AACX,MAAM,EAAE,CAAC;AAET;;;;;GAKG;AACH,SAAS,gBAAgB,CAAC,MAAc,EAAE,YAAsB;IAC9D,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACrC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,YAAY,CAAC;IACtB,CAAC;IACD,uBAAuB;IACvB,OAAO,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AACtF,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,SAAS;IACvB,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;IAE9B,OAAO;SACJ,IAAI,CAAC,OAAO,CAAC;SACb,WAAW,CAAC,uEAAuE,CAAC;SACpF,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAEhC,iBAAiB;IACjB,OAAO;SACJ,OAAO,CAAC,WAAW,CAAC;SACpB,WAAW,CAAC,oCAAoC,CAAC;SACjD,QAAQ,CAAC,WAAW,EAAE,cAAc,CAAC;SACrC,MAAM,CAAC,KAAK,EAAE,OAAe,EAAE,EAAE;QAChC,IAAI,CAAC;YACH,MAAM,eAAe,CAAC,OAAO,CAAC,CAAC;QACjC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,qBAAqB,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YACrF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC,CAAC,CAAC;IAEL,uBAAuB;IACvB,OAAO;SACJ,OAAO,CAAC,iBAAiB,CAAC;SAC1B,WAAW,CAAC,yBAAyB,CAAC;SACtC,QAAQ,CAAC,WAAW,EAAE,cAAc,CAAC;SACrC,QAAQ,CAAC,QAAQ,EAAE,sCAAsC,EAAE,cAAc,CAAC;SAC1E,MAAM,CAAC,KAAK,EAAE,OAAe,EAAE,IAAa,EAAE,EAAE;QAC/C,IAAI,CAAC;YACH,MAAM,gBAAgB,CAAC,OAAO,EAAE,IAAuD,CAAC,CAAC;QAC3F,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,2BAA2B,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YAC3F,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC,CAAC,CAAC;IAEL,iBAAiB;IACjB,OAAO;SACJ,OAAO,CAAC,WAAW,CAAC;SACpB,WAAW,CAAC,6BAA6B,CAAC;SAC1C,QAAQ,CAAC,WAAW,EAAE,cAAc,CAAC;SACrC,QAAQ,CAAC,SAAS,EAAE,0CAA0C,CAAC;SAC/D,MAAM,CAAC,KAAK,EAAE,OAAe,EAAE,KAAa,EAAE,EAAE;QAC/C,MAAM,WAAW,GAAG,CAAC,cAAc,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACxD,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACjC,OAAO,CAAC,KAAK,CAAC,6BAA6B,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACrE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QAED,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,OAAO,EAAE,KAA4C,CAAC,CAAC;YACrF,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;YACrC,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,GAAG,CAAC,2CAA2C,CAAC,CAAC;gBACzD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAClB,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,2BAA2B,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YAC3F,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC,CAAC,CAAC;IAEL,sBAAsB;IACtB,OAAO;SACJ,OAAO,CAAC,gBAAgB,CAAC;SACzB,WAAW,CAAC,2BAA2B,CAAC;SACxC,QAAQ,CAAC,WAAW,EAAE,cAAc,CAAC;SACrC,QAAQ,CAAC,SAAS,EAAE,0CAA0C,CAAC;SAC/D,MAAM,CAAC,KAAK,EAAE,OAAe,EAAE,KAAa,EAAE,EAAE;QAC/C,MAAM,WAAW,GAAG,CAAC,cAAc,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACxD,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACjC,OAAO,CAAC,KAAK,CAAC,6BAA6B,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACrE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QAED,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,aAAa,CAAC,OAAO,EAAE,KAA4C,CAAC,CAAC;YACpF,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACrC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,sBAAsB,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YACtF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC,CAAC,CAAC;IAEL,iBAAiB;IACjB,OAAO;SACJ,OAAO,CAAC,WAAW,CAAC;SACpB,WAAW,CAAC,uBAAuB,CAAC;SACpC,QAAQ,CAAC,SAAS,EAAE,qCAAqC,EAAE,KAAK,CAAC;SACjE,MAAM,CAAC,KAAK,EAAE,KAAa,EAAE,EAAE;QAC9B,MAAM,WAAW,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;QAClD,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACjC,OAAO,CAAC,KAAK,CAAC,6BAA6B,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACrE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QAED,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,iBAAiB,CAAC,KAAsC,CAAC,CAAC;YAC/E,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACrC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,4BAA4B,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YAC5F,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC,CAAC,CAAC;IAEL,oBAAoB;IACpB,OAAO;SACJ,OAAO,CAAC,cAAc,CAAC;SACvB,WAAW,CAAC,mBAAmB,CAAC;SAChC,MAAM,CAAC,KAAK,IAAI,EAAE;QACjB,IAAI,CAAC;YACH,MAAM,YAAY,EAAE,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,4BAA4B,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YAC5F,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC,CAAC,CAAC;IAEL,yBAAyB;IACzB,OAAO;SACJ,OAAO,CAAC,mBAAmB,CAAC;SAC5B,WAAW,CAAC,2BAA2B,CAAC;SACxC,MAAM,CAAC,KAAK,IAAI,EAAE;QACjB,IAAI,CAAC;YACH,MAAM,uBAAuB,EAAE,CAAC;QAClC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,+BAA+B,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YAC/F,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC,CAAC,CAAC;IAEL,oBAAoB;IACpB,OAAO;SACJ,OAAO,CAAC,cAAc,CAAC;SACvB,WAAW,CAAC,uBAAuB,CAAC;SACpC,cAAc,CAAC,kBAAkB,EAAE,cAAc,CAAC;SAClD,MAAM,CAAC,KAAK,EAAE,OAA4B,EAAE,EAAE;QAC7C,IAAI,CAAC;YACH,MAAM,cAAc,GAAG;gBACrB,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,MAAM,EAAE,CAAC,cAAc,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,CAA+E;gBACzJ,aAAa,EAAE;oBACb,YAAY,EAAE,gBAAgB,CAAC,6BAA6B,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;oBACjF,MAAM,EAAE,gBAAgB,CAAC,uBAAuB,EAAE,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;oBAC5E,OAAO,EAAE,gBAAgB,CAAC,wBAAwB,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;iBACxE;aACF,CAAC;YAEF,MAAM,YAAY,GAAG,IAAI,oBAAoB,CAAC,cAAc,CAAC,CAAC;YAC9D,MAAM,YAAY,CAAC,GAAG,EAAE,CAAC;QAC3B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,oBAAoB,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YACpF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC,CAAC,CAAC;IAEL,0BAA0B;IAC1B,OAAO;SACJ,OAAO,CAAC,oBAAoB,CAAC;SAC7B,KAAK,CAAC,aAAa,CAAC;SACpB,WAAW,CAAC,wDAAwD,CAAC;SACrE,MAAM,CAAC,KAAK,IAAI,EAAE;QACjB,IAAI,CAAC;YACH,MAAM,iBAAiB,EAAE,CAAC;QAC5B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,+BAA+B,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YAC/F,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC,CAAC,CAAC;IAEL,uBAAuB;IACvB,OAAO;SACJ,OAAO,CAAC,iBAAiB,CAAC;SAC1B,WAAW,CAAC,6BAA6B,CAAC;SAC1C,MAAM,CAAC,KAAK,IAAI,EAAE;QACjB,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,iBAAiB,EAAE,CAAC;YAClC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,sBAAsB,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YACtF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC,CAAC,CAAC;IAEL,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,eAAe;AACf,uDAAuD;AACvD,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IACpB,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnD,MAAM,YAAY,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACnD,IAAI,WAAW,KAAK,YAAY,EAAE,CAAC;YACjC,MAAM,OAAO,GAAG,SAAS,EAAE,CAAC;YAC5B,OAAO,CAAC,KAAK,EAAE,CAAC;QAClB,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,gCAAgC;QAChC,IAAI,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YACvD,MAAM,OAAO,GAAG,SAAS,EAAE,CAAC;YAC5B,OAAO,CAAC,KAAK,EAAE,CAAC;QAClB,CAAC;IACH,CAAC;AACH,CAAC"}
|
package/docs/README.md
ADDED
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
# Michiドキュメント
|
|
2
|
+
|
|
3
|
+
Michiは、AI駆動開発ワークフロー自動化プラットフォームです。このドキュメントでは、Michiの使い方と開発方法を説明します。
|
|
4
|
+
|
|
5
|
+
## ドキュメント構造
|
|
6
|
+
|
|
7
|
+
Michiのドキュメントは、目的別に以下のカテゴリに整理されています。
|
|
8
|
+
|
|
9
|
+
### 🚀 はじめに ([getting-started/](./getting-started/))
|
|
10
|
+
|
|
11
|
+
初めてMichiを使う方向けのガイドです。
|
|
12
|
+
|
|
13
|
+
| ドキュメント | 説明 |
|
|
14
|
+
|------------|------|
|
|
15
|
+
| [セットアップガイド](./getting-started/setup.md) | Michiのインストールと設定手順 |
|
|
16
|
+
| [クイックスタート](./getting-started/quick-start.md) | 5分で始めるMichi |
|
|
17
|
+
| [新規プロジェクト作成](./getting-started/new-project-setup.md) | 他のリポジトリでMichiを使い始める方法 |
|
|
18
|
+
|
|
19
|
+
### 📖 実践ガイド ([guides/](./guides/))
|
|
20
|
+
|
|
21
|
+
Michiを使った開発の実践的なガイドです。
|
|
22
|
+
|
|
23
|
+
| ドキュメント | 説明 |
|
|
24
|
+
|------------|------|
|
|
25
|
+
| [ワークフローガイド](./guides/workflow.md) ⭐ | AI開発フローの詳細 |
|
|
26
|
+
| [フェーズ自動化ガイド](./guides/phase-automation.md) ⭐ | Confluence/JIRA自動作成 |
|
|
27
|
+
| [マルチプロジェクト管理](./guides/multi-project.md) | 複数プロジェクトの同時管理 |
|
|
28
|
+
| [カスタマイズガイド](./guides/customization.md) | Confluence/JIRA階層構造のカスタマイズ |
|
|
29
|
+
|
|
30
|
+
### 📚 リファレンス ([reference/](./reference/))
|
|
31
|
+
|
|
32
|
+
コマンドや設定値のリファレンス資料です。
|
|
33
|
+
|
|
34
|
+
| ドキュメント | 説明 |
|
|
35
|
+
|------------|------|
|
|
36
|
+
| [クイックリファレンス](./reference/quick-reference.md) ⭐ | コマンド一覧・チートシート |
|
|
37
|
+
| [設定値リファレンス](./reference/config.md) | `.michi/config.json`の全設定値 |
|
|
38
|
+
| [タスクテンプレート](./reference/tasks-template.md) | タスク記述のテンプレート |
|
|
39
|
+
|
|
40
|
+
### 🛠️ コントリビューター向け ([contributing/](./contributing/))
|
|
41
|
+
|
|
42
|
+
Michiプロジェクトに貢献したい開発者向けのガイドです。
|
|
43
|
+
|
|
44
|
+
| ドキュメント | 説明 |
|
|
45
|
+
|------------|------|
|
|
46
|
+
| [開発環境セットアップ](./contributing/development.md) | 開発者向けセットアップ手順 |
|
|
47
|
+
| [リリース手順](./contributing/release.md) | バージョンアップ・NPM公開 |
|
|
48
|
+
| [CI/CD設定](./contributing/ci-cd.md) | CI/CD整備計画 |
|
|
49
|
+
|
|
50
|
+
### 📝 一時ドキュメント ([tmp/](./tmp/))
|
|
51
|
+
|
|
52
|
+
プロジェクト管理や計画のための一時的なドキュメントです(gitで管理されません)。
|
|
53
|
+
|
|
54
|
+
## おすすめの読み方
|
|
55
|
+
|
|
56
|
+
### Michiを初めて使う場合
|
|
57
|
+
|
|
58
|
+
1. [セットアップガイド](./getting-started/setup.md) - Michiをインストール
|
|
59
|
+
2. [クイックスタート](./getting-started/quick-start.md) - 5分で基本的な使い方を習得
|
|
60
|
+
3. [ワークフローガイド](./guides/workflow.md) - AI開発フローを理解
|
|
61
|
+
|
|
62
|
+
### Michiを別のプロジェクトで使う場合
|
|
63
|
+
|
|
64
|
+
1. [新規プロジェクト作成](./getting-started/new-project-setup.md) - 他のリポジトリでの始め方
|
|
65
|
+
2. [クイックリファレンス](./reference/quick-reference.md) - コマンド一覧を確認
|
|
66
|
+
|
|
67
|
+
### Confluence/JIRAの設定をカスタマイズする場合
|
|
68
|
+
|
|
69
|
+
1. [カスタマイズガイド](./guides/customization.md) - カスタマイズ方法
|
|
70
|
+
2. [設定値リファレンス](./reference/config.md) - 全設定値の詳細
|
|
71
|
+
|
|
72
|
+
### Michiの開発に貢献する場合
|
|
73
|
+
|
|
74
|
+
1. [コントリビューションガイド](../CONTRIBUTING.md) - 貢献方法の概要
|
|
75
|
+
2. [開発環境セットアップ](./contributing/development.md) - 開発環境の構築
|
|
76
|
+
3. [リリース手順](./contributing/release.md) - リリースプロセス
|
|
77
|
+
|
|
78
|
+
## アイコンの意味
|
|
79
|
+
|
|
80
|
+
- ⭐: 重要度が高いドキュメント
|
|
81
|
+
- 🚧: 作成中のドキュメント
|
|
82
|
+
- 📦: 外部リンク
|
|
83
|
+
|
|
84
|
+
## 質問・フィードバック
|
|
85
|
+
|
|
86
|
+
ドキュメントに関する質問やフィードバックがある場合は、[issue](https://github.com/sk8metalme/michi/issues)を作成してください。
|
|
87
|
+
|
|
88
|
+
## 参考リンク
|
|
89
|
+
|
|
90
|
+
- [Michiリポジトリ](https://github.com/sk8metalme/michi)
|
|
91
|
+
- [cc-sdd公式ドキュメント](https://github.com/gotalab/cc-sdd)
|
|
92
|
+
- [Cursor IDE](https://cursor.sh/)
|
|
93
|
+
- [Atlassian MCP Server](https://www.atlassian.com/ja/platform/remote-mcp-server)
|
|
@@ -0,0 +1,304 @@
|
|
|
1
|
+
# Michi 開発環境セットアップガイド
|
|
2
|
+
|
|
3
|
+
このガイドは、Michiプロジェクト自体の開発に貢献したい開発者向けのセットアップ手順です。
|
|
4
|
+
|
|
5
|
+
Michiを使ってプロジェクト開発を始めたい場合は、[利用者向けセットアップガイド](../getting-started/setup.md)を参照してください。
|
|
6
|
+
|
|
7
|
+
## 前提条件
|
|
8
|
+
|
|
9
|
+
- Node.js 20.x以上
|
|
10
|
+
- npm 10.x以上
|
|
11
|
+
- Git または Jujutsu (jj)
|
|
12
|
+
- Cursor IDE または VS Code
|
|
13
|
+
- GitHub CLI (gh) - PR作成時に使用
|
|
14
|
+
|
|
15
|
+
## 1. リポジトリのフォーク・クローン
|
|
16
|
+
|
|
17
|
+
### Gitを使う場合
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
# リポジトリをフォーク(GitHubのWebインターフェースで実行)
|
|
21
|
+
|
|
22
|
+
# フォークしたリポジトリをクローン
|
|
23
|
+
git clone https://github.com/YOUR_USERNAME/michi
|
|
24
|
+
cd michi
|
|
25
|
+
|
|
26
|
+
# 上流リポジトリをremoteに追加
|
|
27
|
+
git remote add upstream https://github.com/sk8metalme/michi
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### Jujutsu (jj) を使う場合
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
# リポジトリをクローン
|
|
34
|
+
jj git clone https://github.com/YOUR_USERNAME/michi
|
|
35
|
+
cd michi
|
|
36
|
+
|
|
37
|
+
# 上流リポジトリを設定
|
|
38
|
+
jj git remote add upstream https://github.com/sk8metalme/michi
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## 2. 依存関係のインストール
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
npm install
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## 3. cc-sddのインストール(開発用)
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
# Cursor IDE を使用する場合
|
|
51
|
+
npx cc-sdd@latest --lang ja --cursor
|
|
52
|
+
|
|
53
|
+
# Claude Code を使用する場合
|
|
54
|
+
npx cc-sdd@latest --lang ja --claude
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## 4. 環境変数の設定
|
|
58
|
+
|
|
59
|
+
開発環境でも、Confluence/JIRA連携のテストのために環境変数が必要です。
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
# テンプレートファイルをコピー
|
|
63
|
+
cp env.example .env
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
詳細な設定方法は、[利用者向けセットアップガイド](../getting-started/setup.md#3-環境変数の設定)を参照してください。
|
|
67
|
+
|
|
68
|
+
## 5. 開発ワークフロー
|
|
69
|
+
|
|
70
|
+
### ブランチ戦略
|
|
71
|
+
|
|
72
|
+
- `main`: 本番環境相当(常にデプロイ可能な状態)
|
|
73
|
+
- `feature/XXX`: 機能開発用
|
|
74
|
+
- `bugfix/XXX`: バグ修正用
|
|
75
|
+
- `docs/XXX`: ドキュメント更新用
|
|
76
|
+
|
|
77
|
+
### 開発サイクル
|
|
78
|
+
|
|
79
|
+
1. **issueを作成** または 既存のissueを確認
|
|
80
|
+
2. **ブランチを作成**
|
|
81
|
+
```bash
|
|
82
|
+
git checkout -b feature/your-feature-name
|
|
83
|
+
# または jj new -m "feature/your-feature-name"
|
|
84
|
+
```
|
|
85
|
+
3. **コードを実装**
|
|
86
|
+
4. **テストを追加・実行**
|
|
87
|
+
5. **コミット**
|
|
88
|
+
6. **PRを作成**
|
|
89
|
+
|
|
90
|
+
## 6. コーディング規約
|
|
91
|
+
|
|
92
|
+
### TypeScript
|
|
93
|
+
|
|
94
|
+
- **Strict Mode**: `tsconfig.json`で厳格な型チェックを有効化
|
|
95
|
+
- **ESLint**: すべてのコードはESLintルールに準拠
|
|
96
|
+
- **Prettier**: コードフォーマットは自動化
|
|
97
|
+
|
|
98
|
+
### コミットメッセージ
|
|
99
|
+
|
|
100
|
+
[Conventional Commits](https://www.conventionalcommits.org/)形式を使用:
|
|
101
|
+
|
|
102
|
+
```
|
|
103
|
+
<type>(<scope>): <subject>
|
|
104
|
+
|
|
105
|
+
<body>
|
|
106
|
+
|
|
107
|
+
<footer>
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
**Type:**
|
|
111
|
+
- `feat`: 新機能
|
|
112
|
+
- `fix`: バグ修正
|
|
113
|
+
- `docs`: ドキュメント変更
|
|
114
|
+
- `style`: コードフォーマット(ロジック変更なし)
|
|
115
|
+
- `refactor`: リファクタリング
|
|
116
|
+
- `test`: テスト追加・修正
|
|
117
|
+
- `chore`: ビルドプロセスやツールの変更
|
|
118
|
+
|
|
119
|
+
**例:**
|
|
120
|
+
```
|
|
121
|
+
feat(confluence): Confluence階層構造のカスタマイズ機能を追加
|
|
122
|
+
|
|
123
|
+
- config.jsonでhierarchy.modeを設定可能に
|
|
124
|
+
- simple/detailedの2モードをサポート
|
|
125
|
+
|
|
126
|
+
Closes #123
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
## 7. テストの実行
|
|
130
|
+
|
|
131
|
+
### 全テストを実行
|
|
132
|
+
|
|
133
|
+
```bash
|
|
134
|
+
npm run test:run
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### watchモードでテスト
|
|
138
|
+
|
|
139
|
+
```bash
|
|
140
|
+
npm test
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### カバレッジ確認
|
|
144
|
+
|
|
145
|
+
```bash
|
|
146
|
+
npm run test:coverage
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
**カバレッジ目標**: 95%以上
|
|
150
|
+
|
|
151
|
+
### 型チェック
|
|
152
|
+
|
|
153
|
+
```bash
|
|
154
|
+
npm run type-check
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
## 8. リントとフォーマット
|
|
158
|
+
|
|
159
|
+
### リント実行
|
|
160
|
+
|
|
161
|
+
```bash
|
|
162
|
+
npm run lint
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
### リント自動修正
|
|
166
|
+
|
|
167
|
+
```bash
|
|
168
|
+
npm run lint:fix
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
### フォーマット
|
|
172
|
+
|
|
173
|
+
```bash
|
|
174
|
+
npm run format
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
## 9. ビルドとパッケージング
|
|
178
|
+
|
|
179
|
+
### TypeScriptビルド
|
|
180
|
+
|
|
181
|
+
```bash
|
|
182
|
+
npm run build
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
### ローカルでのパッケージテスト
|
|
186
|
+
|
|
187
|
+
```bash
|
|
188
|
+
# パッケージをリンク
|
|
189
|
+
npm link
|
|
190
|
+
|
|
191
|
+
# 他のプロジェクトでテスト
|
|
192
|
+
cd /path/to/test-project
|
|
193
|
+
npm link @sk8metal/michi-cli
|
|
194
|
+
|
|
195
|
+
# テスト後、リンクを解除
|
|
196
|
+
npm unlink @sk8metal/michi-cli
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
## 10. PRの作成
|
|
200
|
+
|
|
201
|
+
### PR作成前のチェックリスト
|
|
202
|
+
|
|
203
|
+
- [ ] すべてのテストがパス
|
|
204
|
+
- [ ] カバレッジが95%以上
|
|
205
|
+
- [ ] ESLintエラーが0件
|
|
206
|
+
- [ ] TypeScript型エラーが0件
|
|
207
|
+
- [ ] コミットメッセージがConventional Commits形式
|
|
208
|
+
- [ ] ドキュメントを更新(必要に応じて)
|
|
209
|
+
|
|
210
|
+
### PRの作成
|
|
211
|
+
|
|
212
|
+
```bash
|
|
213
|
+
# GitHubにプッシュ
|
|
214
|
+
git push origin feature/your-feature-name
|
|
215
|
+
|
|
216
|
+
# PRを作成
|
|
217
|
+
gh pr create --title "feat: 機能の説明" --body "詳細な説明"
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
### Jujutsuの場合
|
|
221
|
+
|
|
222
|
+
```bash
|
|
223
|
+
# 変更をコミット
|
|
224
|
+
jj commit -m "feat: 機能の説明"
|
|
225
|
+
|
|
226
|
+
# GitHubにプッシュ
|
|
227
|
+
jj git push
|
|
228
|
+
|
|
229
|
+
# PRを作成
|
|
230
|
+
gh pr create --title "feat: 機能の説明" --body "詳細な説明"
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
### PRテンプレート
|
|
234
|
+
|
|
235
|
+
```markdown
|
|
236
|
+
## 概要
|
|
237
|
+
何を実装したか簡潔に説明
|
|
238
|
+
|
|
239
|
+
## 変更内容
|
|
240
|
+
- 変更点1
|
|
241
|
+
- 変更点2
|
|
242
|
+
|
|
243
|
+
## テスト
|
|
244
|
+
- [ ] 単体テスト追加
|
|
245
|
+
- [ ] E2Eテスト追加(必要に応じて)
|
|
246
|
+
- [ ] 手動テスト実施
|
|
247
|
+
|
|
248
|
+
## チェックリスト
|
|
249
|
+
- [ ] テストがパス
|
|
250
|
+
- [ ] カバレッジ95%以上
|
|
251
|
+
- [ ] ESLintエラー0件
|
|
252
|
+
- [ ] ドキュメント更新
|
|
253
|
+
|
|
254
|
+
## 関連Issue
|
|
255
|
+
Closes #123
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
## 11. CI/CDパイプライン
|
|
259
|
+
|
|
260
|
+
プッシュすると、以下のCI/CDパイプラインが自動実行されます:
|
|
261
|
+
|
|
262
|
+
- **リント**: ESLint実行
|
|
263
|
+
- **型チェック**: TypeScriptコンパイル
|
|
264
|
+
- **テスト**: Vitest実行
|
|
265
|
+
- **カバレッジ**: Codecovにアップロード
|
|
266
|
+
- **セキュリティスキャン**: npm auditとSnyk
|
|
267
|
+
|
|
268
|
+
詳細は [CI/CDガイド](./ci-cd.md) を参照してください。
|
|
269
|
+
|
|
270
|
+
## 12. トラブルシューティング
|
|
271
|
+
|
|
272
|
+
### npm install でエラーが出る
|
|
273
|
+
|
|
274
|
+
キャッシュをクリア:
|
|
275
|
+
```bash
|
|
276
|
+
npm cache clean --force
|
|
277
|
+
rm -rf node_modules package-lock.json
|
|
278
|
+
npm install
|
|
279
|
+
```
|
|
280
|
+
|
|
281
|
+
### テストが失敗する
|
|
282
|
+
|
|
283
|
+
```bash
|
|
284
|
+
# キャッシュをクリア
|
|
285
|
+
npm run test:run -- --clearCache
|
|
286
|
+
|
|
287
|
+
# 特定のテストのみ実行
|
|
288
|
+
npm run test:run -- path/to/test-file.test.ts
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
### GitHub認証エラー
|
|
292
|
+
|
|
293
|
+
```bash
|
|
294
|
+
gh auth status
|
|
295
|
+
gh auth login
|
|
296
|
+
gh auth setup-git
|
|
297
|
+
```
|
|
298
|
+
|
|
299
|
+
## 参考リンク
|
|
300
|
+
|
|
301
|
+
- [コントリビューションガイド](../../CONTRIBUTING.md)
|
|
302
|
+
- [リリース手順](./release.md)
|
|
303
|
+
- [CI/CD設定](./ci-cd.md)
|
|
304
|
+
- [Jujutsu公式ドキュメント](https://martinvonz.github.io/jj/)
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
# Michi クイックスタート
|
|
2
|
+
|
|
3
|
+
このガイドでは、Michiを5分で始める方法を説明します。
|
|
4
|
+
|
|
5
|
+
## 前提条件
|
|
6
|
+
|
|
7
|
+
- Node.js 20.x以上
|
|
8
|
+
- Cursor IDE または VS Code
|
|
9
|
+
|
|
10
|
+
## 1. Michiをインストール
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
# NPMパッケージからインストール(推奨)
|
|
14
|
+
npm install -g @sk8metal/michi-cli
|
|
15
|
+
|
|
16
|
+
# インストール確認
|
|
17
|
+
michi --version
|
|
18
|
+
michi --help
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
**注意**: 初回実行時は依存関係のダウンロードに時間がかかる場合があります。
|
|
22
|
+
|
|
23
|
+
## 2. cc-sddをインストール
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
# Cursor IDE を使用する場合
|
|
27
|
+
npx cc-sdd@latest --lang ja --cursor
|
|
28
|
+
|
|
29
|
+
# Claude Code を使用する場合
|
|
30
|
+
npx cc-sdd@latest --lang ja --claude
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
cc-sddは、Michiの仕様駆動開発ワークフローのコアフレームワークです。
|
|
34
|
+
|
|
35
|
+
## 3. 環境変数を設定
|
|
36
|
+
|
|
37
|
+
最小限の設定で始める場合:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
# プロジェクトディレクトリに移動
|
|
41
|
+
cd your-project
|
|
42
|
+
|
|
43
|
+
# .envファイルを作成
|
|
44
|
+
cat > .env <<EOF
|
|
45
|
+
# GitHub設定(必須)
|
|
46
|
+
GITHUB_TOKEN=your-github-token
|
|
47
|
+
GITHUB_ORG=your-org
|
|
48
|
+
GITHUB_REPO=your-org/your-repo
|
|
49
|
+
|
|
50
|
+
# JIRA設定(オプション)
|
|
51
|
+
ATLASSIAN_URL=https://your-domain.atlassian.net
|
|
52
|
+
ATLASSIAN_EMAIL=your-email@company.com
|
|
53
|
+
ATLASSIAN_API_TOKEN=your-token
|
|
54
|
+
JIRA_PROJECT_KEYS=YOUR_PROJECT
|
|
55
|
+
|
|
56
|
+
# JIRA Issue Type IDs(JIRAインスタンス固有 - 必須)
|
|
57
|
+
JIRA_ISSUE_TYPE_STORY=10036
|
|
58
|
+
JIRA_ISSUE_TYPE_SUBTASK=10037
|
|
59
|
+
EOF
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
詳細な設定方法は、[セットアップガイド](./setup.md#3-環境変数の設定)を参照してください。
|
|
63
|
+
|
|
64
|
+
## 4. 最初の機能を作成
|
|
65
|
+
|
|
66
|
+
Cursor/VS CodeでAIコマンドを実行:
|
|
67
|
+
|
|
68
|
+
```
|
|
69
|
+
/kiro:spec-init ユーザー認証機能
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
これにより、`.kiro/specs/user-authentication/`ディレクトリが作成され、以下が自動生成されます:
|
|
73
|
+
|
|
74
|
+
- `requirements.md`: 要件定義
|
|
75
|
+
- `spec.json`: 機能メタデータ
|
|
76
|
+
|
|
77
|
+
## 5. 設計を作成
|
|
78
|
+
|
|
79
|
+
```
|
|
80
|
+
/kiro:spec-design user-authentication
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
これにより、`design.md`が生成されます。
|
|
84
|
+
|
|
85
|
+
## 6. タスクを作成
|
|
86
|
+
|
|
87
|
+
```
|
|
88
|
+
/kiro:spec-tasks user-authentication
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
これにより、以下が自動実行されます:
|
|
92
|
+
|
|
93
|
+
- `tasks.md`の生成
|
|
94
|
+
- Confluenceページの自動作成(要件・設計)
|
|
95
|
+
- JIRA Epicとストーリーの自動作成
|
|
96
|
+
|
|
97
|
+
## 7. 実装を開始
|
|
98
|
+
|
|
99
|
+
```
|
|
100
|
+
/kiro:spec-impl user-authentication task-1
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
TDD(テスト駆動開発)で実装が進められます。
|
|
104
|
+
|
|
105
|
+
## 次のステップ
|
|
106
|
+
|
|
107
|
+
### より詳しく学ぶ
|
|
108
|
+
|
|
109
|
+
- [ワークフローガイド](../guides/workflow.md) - AI開発フローの詳細
|
|
110
|
+
- [フェーズ自動化ガイド](../guides/phase-automation.md) - Confluence/JIRA自動化
|
|
111
|
+
- [クイックリファレンス](../reference/quick-reference.md) - コマンド一覧
|
|
112
|
+
|
|
113
|
+
### 高度な設定
|
|
114
|
+
|
|
115
|
+
- [カスタマイズガイド](../guides/customization.md) - Confluence/JIRA階層のカスタマイズ
|
|
116
|
+
- [設定値リファレンス](../reference/config.md) - `.michi/config.json`の全設定値
|
|
117
|
+
|
|
118
|
+
### 複数プロジェクトの管理
|
|
119
|
+
|
|
120
|
+
- [マルチプロジェクト管理](../guides/multi-project.md) - 3-5プロジェクトの同時管理
|
|
121
|
+
|
|
122
|
+
## トラブルシューティング
|
|
123
|
+
|
|
124
|
+
### GitHub Tokenが無効
|
|
125
|
+
|
|
126
|
+
```bash
|
|
127
|
+
gh auth login
|
|
128
|
+
gh auth token
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
### JIRA Issue Type IDが不明
|
|
132
|
+
|
|
133
|
+
```bash
|
|
134
|
+
# REST APIで確認
|
|
135
|
+
curl -u your-email@company.com:your-token \
|
|
136
|
+
https://your-domain.atlassian.net/rest/api/3/issuetype
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### コマンドが見つからない
|
|
140
|
+
|
|
141
|
+
Cursor/VS Codeを再起動してください。
|
|
142
|
+
|
|
143
|
+
## ヘルプ
|
|
144
|
+
|
|
145
|
+
質問がある場合は、[issue](https://github.com/sk8metalme/michi/issues)を作成してください。
|
|
@@ -9,18 +9,45 @@
|
|
|
9
9
|
- GitHub CLI (gh) - PR作成時に使用
|
|
10
10
|
- **cc-sdd**: AI駆動開発ワークフローのコアフレームワーク
|
|
11
11
|
|
|
12
|
-
## 1.
|
|
12
|
+
## 1. Michiのインストール
|
|
13
|
+
|
|
14
|
+
### 方法1: NPMパッケージとしてインストール(推奨)
|
|
13
15
|
|
|
14
16
|
```bash
|
|
15
|
-
#
|
|
17
|
+
# グローバルインストール
|
|
18
|
+
npm install -g @sk8metal/michi-cli
|
|
19
|
+
|
|
20
|
+
# インストール確認
|
|
21
|
+
michi --version
|
|
22
|
+
michi --help
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
**注意**: 初回実行時は依存関係のダウンロードに時間がかかる場合があります。
|
|
26
|
+
|
|
27
|
+
### 方法2: リポジトリから使用(開発者向け)
|
|
28
|
+
|
|
29
|
+
Michiの開発に貢献したい場合や、最新の開発版を使用したい場合:
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
# リポジトリをクローン
|
|
16
33
|
git clone https://github.com/sk8metalme/michi
|
|
17
34
|
cd michi
|
|
18
35
|
|
|
19
|
-
#
|
|
20
|
-
|
|
21
|
-
|
|
36
|
+
# 依存関係をインストール
|
|
37
|
+
npm install
|
|
38
|
+
|
|
39
|
+
# ビルド
|
|
40
|
+
npm run build
|
|
41
|
+
|
|
42
|
+
# グローバルコマンドとしてリンク
|
|
43
|
+
npm link
|
|
44
|
+
|
|
45
|
+
# 使用
|
|
46
|
+
michi --help
|
|
22
47
|
```
|
|
23
48
|
|
|
49
|
+
詳細は [開発環境セットアップガイド](../contributing/development.md)を参照してください。
|
|
50
|
+
|
|
24
51
|
## 2. cc-sddのインストール
|
|
25
52
|
|
|
26
53
|
cc-sddは、Michiの仕様駆動開発ワークフローのコアフレームワークです。
|
|
@@ -52,22 +79,16 @@ npx cc-sdd@next --lang ja --windsurf
|
|
|
52
79
|
|
|
53
80
|
詳細: [cc-sdd公式ドキュメント](https://github.com/gotalab/cc-sdd/blob/main/tools/cc-sdd/README_ja.md)
|
|
54
81
|
|
|
55
|
-
## 3.
|
|
82
|
+
## 3. 環境変数の設定
|
|
56
83
|
|
|
57
|
-
|
|
58
|
-
npm install
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
## 4. 環境変数の設定
|
|
62
|
-
|
|
63
|
-
### 4-1. .env ファイルの作成
|
|
84
|
+
### 3-1. .env ファイルの作成
|
|
64
85
|
|
|
65
86
|
```bash
|
|
66
87
|
# テンプレートファイルをコピー
|
|
67
88
|
cp env.example .env
|
|
68
89
|
```
|
|
69
90
|
|
|
70
|
-
###
|
|
91
|
+
### 3-2. 認証情報の設定
|
|
71
92
|
|
|
72
93
|
`.env` ファイルを編集して、実際の認証情報を設定します:
|
|
73
94
|
|
|
@@ -111,7 +132,7 @@ APPROVAL_GATES_DESIGN=architect,director
|
|
|
111
132
|
APPROVAL_GATES_RELEASE=sm,director
|
|
112
133
|
```
|
|
113
134
|
|
|
114
|
-
###
|
|
135
|
+
### 3-3. ワークフロー承認ゲートの設定(オプション)
|
|
115
136
|
|
|
116
137
|
ワークフロー実行時(`michi workflow:run`)の承認ゲートで使用するロール名を設定できます。
|
|
117
138
|
|
|
@@ -168,7 +189,7 @@ APPROVAL_GATES_RELEASE=リリースマネージャー,QAリード,部長
|
|
|
168
189
|
- 空のロール名は無視されます
|
|
169
190
|
- 環境変数が未設定の場合は、デフォルト値が使用されます
|
|
170
191
|
|
|
171
|
-
###
|
|
192
|
+
### 3-4. 認証トークンの取得方法
|
|
172
193
|
|
|
173
194
|
#### Atlassian API Token
|
|
174
195
|
1. https://id.atlassian.com/manage-profile/security/api-tokens にアクセス
|
|
@@ -190,9 +211,9 @@ gh auth token
|
|
|
190
211
|
3. Incoming Webhooks を有効化
|
|
191
212
|
4. Webhook URL を生成して `.env` に設定
|
|
192
213
|
|
|
193
|
-
##
|
|
214
|
+
## 4. Atlassian MCP サーバーの設定
|
|
194
215
|
|
|
195
|
-
###
|
|
216
|
+
### 4-1. MCP設定ファイルの作成
|
|
196
217
|
|
|
197
218
|
プロジェクトルートの `mcp.json.example` を参考に、ホームディレクトリに `~/.cursor/mcp.json` を作成:
|
|
198
219
|
|
|
@@ -202,7 +223,7 @@ mkdir -p ~/.cursor
|
|
|
202
223
|
cp mcp.json.example ~/.cursor/mcp.json
|
|
203
224
|
```
|
|
204
225
|
|
|
205
|
-
###
|
|
226
|
+
### 4-2. 実際の認証情報に置き換え
|
|
206
227
|
|
|
207
228
|
`~/.cursor/mcp.json` を編集して、`.env` と同じ認証情報を設定:
|
|
208
229
|
|
|
@@ -222,7 +243,7 @@ cp mcp.json.example ~/.cursor/mcp.json
|
|
|
222
243
|
}
|
|
223
244
|
```
|
|
224
245
|
|
|
225
|
-
##
|
|
246
|
+
## 5. プロジェクトメタデータの確認
|
|
226
247
|
|
|
227
248
|
`.kiro/project.json` を確認・編集:
|
|
228
249
|
|
|
@@ -238,7 +259,7 @@ cp mcp.json.example ~/.cursor/mcp.json
|
|
|
238
259
|
}
|
|
239
260
|
```
|
|
240
261
|
|
|
241
|
-
##
|
|
262
|
+
## 5-2. プロジェクト固有設定ファイル(オプション)
|
|
242
263
|
|
|
243
264
|
`.michi/config.json` を作成することで、Confluence/JIRAの動作をカスタマイズできます。
|
|
244
265
|
|
|
@@ -284,7 +305,7 @@ cp mcp.json.example ~/.cursor/mcp.json
|
|
|
284
305
|
|
|
285
306
|
### 設定値の詳細
|
|
286
307
|
|
|
287
|
-
すべての設定値の詳細は [設定値リファレンス](
|
|
308
|
+
すべての設定値の詳細は [設定値リファレンス](../reference/config.md) を参照してください。
|
|
288
309
|
|
|
289
310
|
### 設定の優先順位
|
|
290
311
|
|
|
@@ -309,17 +330,17 @@ npx tsx /path/to/michi/scripts/utils/config-validator.ts /path/to/project
|
|
|
309
330
|
|
|
310
331
|
### よくある設定パターン
|
|
311
332
|
|
|
312
|
-
詳細は [カスタマイズガイド](
|
|
333
|
+
詳細は [カスタマイズガイド](../guides/customization.md) を参照してください。
|
|
313
334
|
|
|
314
|
-
##
|
|
335
|
+
## 6. Cursor IDE の設定
|
|
315
336
|
|
|
316
|
-
###
|
|
337
|
+
### 6-1. Cursor でプロジェクトを開く
|
|
317
338
|
|
|
318
339
|
```bash
|
|
319
340
|
cursor .
|
|
320
341
|
```
|
|
321
342
|
|
|
322
|
-
###
|
|
343
|
+
### 6-2. 利用可能なコマンドの確認
|
|
323
344
|
|
|
324
345
|
Cursor のコマンドパネル(Cmd+Shift+P)で `/kiro:` と入力すると、以下のコマンドが表示されます:
|
|
325
346
|
|
|
@@ -332,32 +353,23 @@ Cursor のコマンドパネル(Cmd+Shift+P)で `/kiro:` と入力すると
|
|
|
332
353
|
|
|
333
354
|
凡例の詳細は [README.md#凡例の記号説明](../README.md#凡例の記号説明) を参照してください。
|
|
334
355
|
|
|
335
|
-
##
|
|
356
|
+
## 7. 動作確認
|
|
336
357
|
|
|
337
|
-
###
|
|
358
|
+
### 7-1. 基本的な動作確認
|
|
338
359
|
|
|
339
360
|
```bash
|
|
340
|
-
|
|
341
|
-
|
|
361
|
+
# Michiコマンドが利用可能か確認
|
|
362
|
+
michi --version
|
|
342
363
|
|
|
343
|
-
|
|
364
|
+
# ヘルプを表示
|
|
365
|
+
michi --help
|
|
344
366
|
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
npm run project:list
|
|
367
|
+
# 利用可能なコマンド一覧
|
|
368
|
+
michi help
|
|
348
369
|
```
|
|
349
370
|
|
|
350
371
|
## トラブルシューティング
|
|
351
372
|
|
|
352
|
-
### npm install でエラーが出る
|
|
353
|
-
|
|
354
|
-
キャッシュをクリア:
|
|
355
|
-
```bash
|
|
356
|
-
npm cache clean --force
|
|
357
|
-
rm -rf node_modules package-lock.json
|
|
358
|
-
npm install
|
|
359
|
-
```
|
|
360
|
-
|
|
361
373
|
### MCP サーバーが動作しない
|
|
362
374
|
|
|
363
375
|
1. Cursor を再起動
|
|
@@ -376,9 +388,9 @@ gh auth setup-git
|
|
|
376
388
|
|
|
377
389
|
セットアップが完了したら、以下のドキュメントを参照:
|
|
378
390
|
|
|
379
|
-
- [
|
|
380
|
-
- [
|
|
381
|
-
- [
|
|
391
|
+
- [クイックスタート](./quick-start.md) - 5分で始める
|
|
392
|
+
- [ワークフローガイド](../guides/workflow.md) - AI開発フロー
|
|
393
|
+
- [マルチプロジェクト管理](../guides/multi-project.md) - 複数プロジェクト管理
|
|
382
394
|
|
|
383
395
|
## 参考リンク
|
|
384
396
|
|
|
@@ -71,7 +71,7 @@ Michiは[cc-sdd](https://github.com/gotalab/cc-sdd)をベースとしており
|
|
|
71
71
|
|
|
72
72
|
### 設定値の詳細
|
|
73
73
|
|
|
74
|
-
すべての設定値の詳細は [設定値リファレンス](
|
|
74
|
+
すべての設定値の詳細は [設定値リファレンス](../reference/config.md) を参照してください。
|
|
75
75
|
|
|
76
76
|
## Confluence階層構造のカスタマイズ
|
|
77
77
|
|
|
@@ -472,10 +472,10 @@ npm run config:validate
|
|
|
472
472
|
## 参考リンク
|
|
473
473
|
|
|
474
474
|
### Michi関連
|
|
475
|
-
- [セットアップガイド](
|
|
475
|
+
- [セットアップガイド](../getting-started/setup.md)
|
|
476
476
|
- [ワークフローガイド](./workflow.md)
|
|
477
|
-
- [新規プロジェクトセットアップ](
|
|
478
|
-
- [設定値リファレンス](
|
|
477
|
+
- [新規プロジェクトセットアップ](../getting-started/new-project-setup.md)
|
|
478
|
+
- [設定値リファレンス](../reference/config.md)
|
|
479
479
|
|
|
480
480
|
### cc-sdd関連
|
|
481
481
|
- [cc-sdd カスタマイズガイド](https://github.com/gotalab/cc-sdd/blob/main/docs/guides/ja/customization-guide.md) - テンプレート・ルール・Steeringのカスタマイズ方法
|
|
@@ -47,7 +47,7 @@ repository/ ← 1つのGitHubリポジトリ
|
|
|
47
47
|
|
|
48
48
|
### 新規プロジェクト追加
|
|
49
49
|
|
|
50
|
-
詳細な手順は [新規プロジェクトセットアップガイド](
|
|
50
|
+
詳細な手順は [新規プロジェクトセットアップガイド](../getting-started/new-project-setup.md) を参照してください。
|
|
51
51
|
|
|
52
52
|
**クイックスタート**:
|
|
53
53
|
1. 既存リポジトリに追加: `bash /path/to/michi/scripts/setup-existing.sh`
|
|
@@ -62,7 +62,7 @@ repository/ ← 1つのGitHubリポジトリ
|
|
|
62
62
|
|
|
63
63
|
### 環境変数設定
|
|
64
64
|
|
|
65
|
-
各プロジェクトで`.env`ファイルを設定します。詳細は [新規プロジェクトセットアップガイド](
|
|
65
|
+
各プロジェクトで`.env`ファイルを設定します。詳細は [新規プロジェクトセットアップガイド](../getting-started/new-project-setup.md#step-5-環境変数設定) を参照してください。
|
|
66
66
|
|
|
67
67
|
### 動作確認
|
|
68
68
|
|
|
@@ -210,7 +210,7 @@ ls -la .kiro/specs/
|
|
|
210
210
|
|
|
211
211
|
**解決方法**:
|
|
212
212
|
1. プロジェクトディレクトリが正しいか確認
|
|
213
|
-
2. `.kiro/project.json`を作成([新規プロジェクトセットアップガイド](
|
|
213
|
+
2. `.kiro/project.json`を作成([新規プロジェクトセットアップガイド](../getting-started/new-project-setup.md)を参照)
|
|
214
214
|
|
|
215
215
|
## プロジェクト横断操作
|
|
216
216
|
|
|
@@ -322,7 +322,7 @@ shared-infrastructure/
|
|
|
322
322
|
**Confluenceラベル**: `project:{projectId}, service:{service}`
|
|
323
323
|
- 例: `project:20240115-payment-api, service:payment`
|
|
324
324
|
|
|
325
|
-
**ラベル生成ロジック**: 詳細は [新規プロジェクトセットアップガイド](
|
|
325
|
+
**ラベル生成ロジック**: 詳細は [新規プロジェクトセットアップガイド](../getting-started/new-project-setup.md#ラベル生成ロジック) を参照してください。
|
|
326
326
|
### チーム構成の明確化
|
|
327
327
|
|
|
328
328
|
各プロジェクトの `team` フィールドに担当者を記載:
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sk8metal/michi-cli",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.7",
|
|
4
4
|
"description": "Managed Intelligent Comprehensive Hub for Integration - AI-driven development workflow automation",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -43,6 +43,7 @@
|
|
|
43
43
|
],
|
|
44
44
|
"scripts": {
|
|
45
45
|
"build": "tsc",
|
|
46
|
+
"postbuild": "node scripts/set-permissions.js",
|
|
46
47
|
"prepare": "npm run build",
|
|
47
48
|
"setup:env": "bash scripts/setup-env.sh",
|
|
48
49
|
"create-project": "tsx scripts/create-project.ts",
|
|
@@ -67,6 +68,7 @@
|
|
|
67
68
|
"test:coverage": "vitest --run --coverage",
|
|
68
69
|
"lint": "eslint .",
|
|
69
70
|
"lint:fix": "eslint . --fix",
|
|
71
|
+
"format": "prettier --write .",
|
|
70
72
|
"type-check": "tsc --noEmit"
|
|
71
73
|
},
|
|
72
74
|
"dependencies": {
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
/**
|
|
3
|
+
* Set executable permissions on CLI entry point
|
|
4
|
+
* Cross-platform script to ensure dist/src/cli.js has execute permissions
|
|
5
|
+
*/
|
|
6
|
+
|
|
7
|
+
import { chmodSync } from 'fs';
|
|
8
|
+
import { join, dirname } from 'path';
|
|
9
|
+
import { fileURLToPath } from 'url';
|
|
10
|
+
|
|
11
|
+
const __filename = fileURLToPath(import.meta.url);
|
|
12
|
+
const __dirname = dirname(__filename);
|
|
13
|
+
|
|
14
|
+
const cliPath = join(__dirname, '..', 'dist', 'src', 'cli.js');
|
|
15
|
+
|
|
16
|
+
// Skip on Windows where chmod is not needed
|
|
17
|
+
if (process.platform === 'win32') {
|
|
18
|
+
console.log('Skipping chmod on Windows (not required)');
|
|
19
|
+
process.exit(0);
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
try {
|
|
23
|
+
chmodSync(cliPath, 0o755);
|
|
24
|
+
console.log(`✓ Set executable permissions on ${cliPath}`);
|
|
25
|
+
} catch (error) {
|
|
26
|
+
console.error(`Failed to set permissions on ${cliPath}:`, error.message);
|
|
27
|
+
// Don't fail the build if this fails
|
|
28
|
+
process.exit(0);
|
|
29
|
+
}
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|