Open Editing CLI

The Sarvam & Google AI Powered Video Editing CLI is an easy tool designed to assist users in creating video content efficiently. It leverages AI capabilities to generate scripts, images, audio, and videos, and combines them into a final rendered video. Below is the detailed documentation of the CLI commands and their usage.

Installation

1. Install & Run CLI

npx open-editor-demo

2. Open your project

cd <project_name>

3. Run CLI again

npx open-editor-demo

4. Set up environment variables while running the CLI:
   • GOOGLE_GENERATIVE_AI_API_KEY: API key for Google Generative AI.
   • SARVAM_API_KEY: API key for Sarvam AI.

Commands

exit

• Description: Exits the CLI software.

---

modifyScript

• Description: Edits an existing video script using AI.
• Parameters:
  • userRequirement: A string describing the modifications required.

---

generateScript

• Description: Generates a new video script using AI.
• Parameters:
  • topic: The topic of the video.
  • tone (optional): The tone of the script (e.g., formal, casual).
  • size: The size of the video (e.g., 16:9, 1:1).
  • aditionalData (optional): Additional data to include in the script.

---

generateImages

• Description: Generates image files based on the script (only after confirming the script).

---

generateAudios

• Description: Generates audio files based on the script (only after confirming the script).
• Parameters:
  • voice: The voice type (male or female).
  • language (optional): The language of the audio.

---

renderShotVideos

• Description: Combines each image with its corresponding audio to create individual video shots.

---

renderFinalVideo

• Description: Merges all individual shots into one final video render.

---

Workflow

1. Generate a Script: Use the generateScript command to create a video script.
2. Generate Images: Confirm the script and run generateImages to create images for each scene.
3. Generate Audios: Use generateAudios to create audio files for each scene.
4. Render Shots: Combine images and audio into individual shots using renderShotVideos.
5. Render Final Video: Merge all shots into a final video using renderFinalVideo.

---

Notes

• Ensure the environment variables are correctly set before running the CLI.
• The CLI is designed to guide users step-by-step through the video creation process.
• For any issues, refer to the source code or contact the development team.

---

Happy video editing!