Skip to main content
View as Markdown

Quickstart Guide

Get up and running with Decodx in minutes.

Installation​

Decodx works as a CLI tool and can be installed globally or used in a project.

# Install globally
bun install -g decodx

# Or run directly
bun run decodx --help

Create Your First Video​

Step 1: Create a Project Specification​

Create a project.yaml file:

title: My First Video
description: A test video created with Decodx
duration: 30
fps: 30

Step 2: Configure Sources​

Create a sources.yaml file:

sources:
  - id: video1
    type: file
    path: ./assets/input.mp4

Step 3: Define Scenes​

Create a scenes/ directory with scene definitions:

# scenes/main.yaml
scenes:
  - id: scene1
    duration: 10
    layers:
      - source: video1
        start: 0
        duration: 10

Step 4: Render​

decodx render project.yaml

The rendered video will be saved to output/final.mp4.

Next Steps​