Skip to main content

Generate Guide Command

The generate-guide command creates a detailed step-by-step guide from previously processed video data. It uses AI to analyze the extracted frames and generate a structured guide.

Usage

Arguments

Options

Examples

Generate a guide from processed video data

Generate a guide with a custom directive

Generate a guide in markdown format

Generate a guide with a specific model

Output

The command generates a guide file in the specified format (default: JSON) in the output directory:

Guide Format

The generated guide has the following structure:

Customizing Guide Generation

You can customize the guide generation process using the --user-directive option. This allows you to specify what aspects of the video to focus on or what style to use for the guide. Examples of user directives:
  • “Focus on technical details and tools used”
  • “Emphasize beginner-friendly explanations”
  • “Highlight safety considerations”
  • “Include more detailed steps for complex parts”

Next Steps

After generating a guide, you can:
  1. Use the guide in your application or documentation
  2. Convert the guide to different formats using the --format option
  3. Customize the guide further with manual edits