@ncukondo/slide-generation 0.1.0 → 0.2.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.
package/README.md CHANGED
@@ -10,6 +10,7 @@ A CLI tool to generate Marp-compatible Markdown from YAML source files, designed
10
10
  - **Reference management** - Integration with reference-manager CLI for citations
11
11
  - **Watch mode** - Auto-convert on file changes
12
12
  - **Marp compatible** - Output works directly with Marp CLI
13
+ - **AI assistant integration** - Built-in configuration for Claude Code, OpenCode, Cursor, and other AI assistants
13
14
 
14
15
  ## Installation
15
16
 
@@ -151,6 +152,30 @@ Initialize a new project.
151
152
  slide-gen init [directory]
152
153
  ```
153
154
 
155
+ Options:
156
+ - `--template <name>` - Initial template
157
+ - `--no-examples` - Do not create sample files
158
+ - `--no-ai-config` - Do not create AI assistant config files
159
+ - `--skip-marp-install` - Skip Marp CLI installation prompt
160
+
161
+ ### sources
162
+
163
+ Manage source materials for slide creation.
164
+
165
+ ```bash
166
+ # Initialize source management (interactive)
167
+ slide-gen sources init
168
+
169
+ # Import materials from directory
170
+ slide-gen sources init --from-directory ~/Projects/materials/
171
+
172
+ # Add material file
173
+ slide-gen sources import ~/data.xlsx
174
+
175
+ # Check source status
176
+ slide-gen sources status
177
+ ```
178
+
154
179
  ### preview
155
180
 
156
181
  Preview with Marp CLI (requires @marp-team/marp-cli).
@@ -221,6 +246,86 @@ Config file search order:
221
246
  3. `./slide-gen.yaml`
222
247
  4. `~/.slide-gen/config.yaml`
223
248
 
249
+ ## AI Assistant Integration
250
+
251
+ > **For AI Assistants:** If you are an AI assistant reading this README, see [AI-GUIDE.md](./AI-GUIDE.md) for a quick start guide optimized for AI workflows.
252
+
253
+ When you run `slide-gen init`, AI assistant configuration files are automatically generated:
254
+
255
+ ### Supported AI Assistants
256
+
257
+ | Assistant | Configuration Files |
258
+ |-----------|---------------------|
259
+ | Claude Code | `CLAUDE.md`, `.claude/commands/*.md` |
260
+ | OpenCode | `AGENTS.md`, `.opencode/agent/slide.md` |
261
+ | Cursor | `.cursorrules` |
262
+ | All (AgentSkills) | `.skills/slide-assistant/` |
263
+
264
+ ### Generated Files
265
+
266
+ ```
267
+ my-presentation/
268
+ ├── .skills/
269
+ │ └── slide-assistant/
270
+ │ ├── SKILL.md # AgentSkills format (common)
271
+ │ └── references/
272
+ │ ├── templates.md # Template reference
273
+ │ └── workflows.md # Workflow reference
274
+ ├── .claude/
275
+ │ └── commands/ # Claude Code Slash Commands
276
+ │ ├── slide-create.md
277
+ │ ├── slide-validate.md
278
+ │ └── ...
279
+ ├── .opencode/
280
+ │ └── agent/
281
+ │ └── slide.md # OpenCode sub-agent
282
+ ├── AGENTS.md # OpenCode project guide
283
+ ├── CLAUDE.md # Claude Code project guide
284
+ └── .cursorrules # Cursor rules
285
+ ```
286
+
287
+ ### AI-Optimized Output
288
+
289
+ Use `--format llm` for token-efficient output:
290
+
291
+ ```bash
292
+ slide-gen templates list --format llm
293
+ slide-gen templates info <name> --format llm
294
+ ```
295
+
296
+ ### AI Collaboration Workflows
297
+
298
+ This tool is designed for seamless collaboration with AI assistants.
299
+
300
+ #### Source Material Collection
301
+
302
+ AI supports three patterns for gathering information needed for slide creation:
303
+
304
+ | Pattern | Situation | AI Behavior |
305
+ |---------|-----------|-------------|
306
+ | A: Explore Mode | Materials organized in a directory | Explore and analyze directory |
307
+ | B: Supplement Mode | Only scenario or partial materials | Analyze content, interview for missing info |
308
+ | C: Interview Mode | No materials (starting from scratch) | Collect information via dialogue |
309
+
310
+ #### Image Preparation
311
+
312
+ Based on the presentation scenario, AI will:
313
+
314
+ 1. Identify required images for each slide
315
+ 2. Propose specific specifications (composition, resolution, notes)
316
+ 3. Review provided images
317
+ 4. Provide feedback and adjustment suggestions
318
+
319
+ For detailed specifications, see `spec/sources.md` and `spec/images.md`.
320
+
321
+ ### Skip AI Configuration
322
+
323
+ To skip AI configuration files, use:
324
+
325
+ ```bash
326
+ slide-gen init --no-ai-config
327
+ ```
328
+
224
329
  ## Development
225
330
 
226
331
  ```bash
package/README_ja.md CHANGED
@@ -151,6 +151,30 @@ slide-gen icons preview <name>
151
151
  slide-gen init [directory]
152
152
  ```
153
153
 
154
+ オプション:
155
+ - `--template <name>` - 初期テンプレート
156
+ - `--no-examples` - サンプルファイルを作成しない
157
+ - `--no-ai-config` - AIアシスタント設定ファイルを作成しない
158
+ - `--skip-marp-install` - Marp CLIインストール確認をスキップ
159
+
160
+ ### sources
161
+
162
+ ソース資料を管理します。
163
+
164
+ ```bash
165
+ # ソース管理を初期化(対話形式)
166
+ slide-gen sources init
167
+
168
+ # ディレクトリから素材を取り込み
169
+ slide-gen sources init --from-directory ~/Projects/materials/
170
+
171
+ # 素材ファイルを追加
172
+ slide-gen sources import ~/data.xlsx
173
+
174
+ # ソース状況を確認
175
+ slide-gen sources status
176
+ ```
177
+
154
178
  ### preview
155
179
 
156
180
  Marp CLIでプレビューを表示します(@marp-team/marp-cliが必要)。
@@ -221,6 +245,86 @@ output:
221
245
  3. `./slide-gen.yaml`
222
246
  4. `~/.slide-gen/config.yaml`
223
247
 
248
+ ## AIアシスタント連携
249
+
250
+ > **AIアシスタントへ:** このREADMEを読んでいるAIアシスタントは、AIワークフローに最適化されたクイックスタートガイド [AI-GUIDE.md](./AI-GUIDE.md) を参照してください。
251
+
252
+ `slide-gen init` を実行すると、AIアシスタント用の設定ファイルが自動生成されます。
253
+
254
+ ### 対応AIアシスタント
255
+
256
+ | アシスタント | 設定ファイル |
257
+ |-------------|-------------|
258
+ | Claude Code | `CLAUDE.md`, `.claude/commands/*.md` |
259
+ | OpenCode | `AGENTS.md`, `.opencode/agent/slide.md` |
260
+ | Cursor | `.cursorrules` |
261
+ | 共通 (AgentSkills) | `.skills/slide-assistant/` |
262
+
263
+ ### 生成されるファイル
264
+
265
+ ```
266
+ my-presentation/
267
+ ├── .skills/
268
+ │ └── slide-assistant/
269
+ │ ├── SKILL.md # AgentSkills形式(共通)
270
+ │ └── references/
271
+ │ ├── templates.md # テンプレート参照
272
+ │ └── workflows.md # ワークフロー参照
273
+ ├── .claude/
274
+ │ └── commands/ # Claude Code スラッシュコマンド
275
+ │ ├── slide-create.md
276
+ │ ├── slide-validate.md
277
+ │ └── ...
278
+ ├── .opencode/
279
+ │ └── agent/
280
+ │ └── slide.md # OpenCode サブエージェント
281
+ ├── AGENTS.md # OpenCode プロジェクトガイド
282
+ ├── CLAUDE.md # Claude Code プロジェクトガイド
283
+ └── .cursorrules # Cursor ルール
284
+ ```
285
+
286
+ ### AI向け最適化出力
287
+
288
+ トークン効率の良い出力には `--format llm` を使用します:
289
+
290
+ ```bash
291
+ slide-gen templates list --format llm
292
+ slide-gen templates info <name> --format llm
293
+ ```
294
+
295
+ ### AI協働ワークフロー
296
+
297
+ 本ツールはAIアシスタントとの協働を前提に設計されています。
298
+
299
+ #### ソース素材の収集
300
+
301
+ AIは以下の3つのパターンでスライド作成に必要な情報を収集します:
302
+
303
+ | パターン | 状況 | AIの動作 |
304
+ |---------|------|---------|
305
+ | A: 探索モード | 素材がディレクトリに整理済み | ディレクトリを探索・分析 |
306
+ | B: 補完モード | シナリオや一部素材のみ | 内容を分析し、不足情報をインタビュー |
307
+ | C: インタビューモード | 素材なし(ゼロから) | 対話で情報収集 |
308
+
309
+ #### 画像の準備
310
+
311
+ AIはプレゼンテーションのシナリオに基づいて:
312
+
313
+ 1. 必要な画像を特定
314
+ 2. 具体的な仕様を提案(構図、解像度、注意点)
315
+ 3. 提供された画像をレビュー
316
+ 4. フィードバックと調整を支援
317
+
318
+ 詳細は `spec/sources.md` および `spec/images.md` を参照してください。
319
+
320
+ ### AI設定ファイルをスキップ
321
+
322
+ AI設定ファイルを生成しない場合:
323
+
324
+ ```bash
325
+ slide-gen init --no-ai-config
326
+ ```
327
+
224
328
  ## 開発
225
329
 
226
330
  ```bash