Auto-Editor

https://github.com/wyattblue/auto-editor
Admin
Auto-Editor is a command-line application for automatically editing video and audio by analyzing...
Tokens:18,902
Snippets:252
Trust Score:8.9
License:Unlicense
Update:2 months ago
Show doc for...
Tokens:
Raw
### Verify Auto-Editor Installation

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/installing.md

Run the help command to confirm the binary is executable and correctly installed.

```sh
./auto-editor --help
```

--------------------------------

### Transcription Execution Examples

Source: https://github.com/wyattblue/auto-editor/blob/master/skills/auto-editor-transcribe/SKILL.md

Examples of running transcription with different backends and output formats.

```bash
auto-editor whisper example.mp4 ggml-medium.en.bin                      # plain text → stdout
auto-editor whisper example.mp4 ggml-medium.en.bin --format srt -o out.srt
auto-editor whisper example.mp4 ggml-parakeet-tdt-0.6b-v3-q8_0.bin      # parakeet backend
auto-editor whisper example.mp4 apple --language en_US                  # macOS 26+
```

--------------------------------

### Run and Publish Commands

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/README.md

Commands for starting the local server and uploading the project.

```sh
# Run local
hunim server

# Publish
make upload
```

--------------------------------

### Install via Package Managers

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/installing.md

Use Homebrew on macOS or yay on Arch Linux to install the package.

```sh
brew install auto-editor
```

```sh
yay -S auto-editor
```

--------------------------------

### Common usage recipes

Source: https://github.com/wyattblue/auto-editor/blob/master/skills/auto-editor-effects/SKILL.md

Collection of practical command-line examples for various editing tasks.

```bash
auto-editor :mic -w:1 deesser:0.8:0.7:0.4         # record, then clean up speech
auto-editor podcast.mp3 -w:0 cut -w:1 speed:1.15      # cut silence, tighten speech
auto-editor video.mp4 -w:0 volume:0.3                 # duck (not cut) the silence
auto-editor video.mp4 -w:1 varispeed:1.25             # nightcore (speed + pitch up)
auto-editor video.mp4 -w:0 pitch:12                   # chipmunk the silence, same length
auto-editor video.mp4 -w:0 speed:6,volume:0.4         # fast, quiet silent sections
```

--------------------------------

### Add Action Examples

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Examples of using the add action to overlay images, videos, or generators like confetti onto the timeline.

```sh
auto-editor video.mp4 -w:1 add:./logo.png

auto-editor video.mp4 -w:1 add:./logo.png:600:300:1.0

auto-editor video.mp4 -w:1 add:./logo.png:0..1000:300:1..0.5

auto-editor video.mp4 -w:1 add:./pip.mp4:900:60:0.25

auto-editor video.mp4 --set-action add:./logo.png:600:300:1.0,1sec,2sec

auto-editor video.mp4 -w:1 add:confetti:300

auto-editor video.mp4 -w:1 add:confetti:300:white,invert

auto-editor song.mp3 -w:1 add:confetti:300:white
```

--------------------------------

### Full v3 project structure

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/v3.md

Complete example of a v3 project file, including global settings and track definitions.

```json
{
  "version": "3",
  "templateFile": "example.mp4",
  "timebase": "30/1",
  "background": "#000",
  "resolution": [1280, 720],
  "samplerate": 48000,
  "layout": "stereo",
  "langs": ["eng", "eng"],
  "v": [
    [
      {
        "src": "example.mp4",
        "start": 0,
        "dur": 26,
        "offset": 0,
        "stream": 0
      },
      {
        "src": "example.mp4",
        "start": 26,
        "dur": 362,
        "offset": 34,
        "stream": 0
      }
    ]
  ],
  "a": [
    [
      {
        "src": "example.mp4",
        "start": 0,
        "dur": 26,
        "offset": 0,
        "stream": 0
      },
      {
        "src": "example.mp4",
        "start": 26,
        "dur": 362,
        "offset": 34,
        "stream": 0
      }
    ]
  ]
}
```

--------------------------------

### Drawbox Action Examples

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Examples of using the drawbox action to overlay filled rectangles on video frames.

```sh
auto-editor video.mp4 -w:1 drawbox:100:100:400:200:red

auto-editor video.mp4 -w:1 drawbox:0:0:1920:200:#000000
```

--------------------------------

### Add skills to project

Source: https://github.com/wyattblue/auto-editor/blob/master/README.md

Install additional skills for the auto-editor project using npx.

```bash
npx skills add WyattBlue/auto-editor
```

--------------------------------

### Example v2 timeline file

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/v2.md

A sample JSON structure representing a v2 timeline with source, timebase, effects, and clips.

```json
{
  "version": "2",
  "source": "example.mp4",
  "tb": "30/1",
  "effects": [
    [],
    ["speed:2.0"]
  ],
  "clips": [
    [0, 26, 0],
    [34, 396, 1]
  ]
}
```

--------------------------------

### Bitrate Configuration Examples

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/file-size.md

Various configurations for video bitrate, including maximum quality, automatic selection, specific kilobit rates, and variable bitrate settings.

```sh
auto-editor my-huge-h264-video.mp4 -b:v 10M  # Maximum quality, big file size
auto-editor my-h264-video.mp4 -b:v auto  # Let ffmpeg chose, efficient and good looking quality
auto-editor i-want-this-tiny.mp4 -b:v 125k  # Set bitrate to 125 kilobits per second, quality may vary
auto-editor my-video.mp4 -c:v h264 -b:v 0  # Set a variable bitrate
```

--------------------------------

### Apply advanced effects and transformations

Source: https://github.com/wyattblue/auto-editor/blob/master/skills/auto-editor-effects/SKILL.md

Examples of using deesser, rotation, and drawing boxes on active video sections.

```bash
auto-editor video.mp4 -w:1 deesser:0.8:0.7:0.4
auto-editor video.mp4 -w:1 rotate:90 --resolution 1080,1920   # landscape → portrait
auto-editor video.mp4 -w:1 drawbox:0:0:1920:200:#000000       # redact a strip
```

--------------------------------

### Cut or Keep Video Segments

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/range-syntax.md

Examples of using start and end range syntax to cut or keep specific portions of a video.

```sh
auto-editor video.mp4 --cut start,30sec -30sec,end
```

```sh
auto-editor video.mp4 --keep start,30sec -30sec,end
```

--------------------------------

### Transcribe media to stdout

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/subcommands/whisper.md

Example of running whisper on a media file, outputting the transcript directly to the console.

```bash
% auto-editor whisper example.mp4 ggml-medium.en.bin

 And so my fellow Americans, ask not what your country can do for you,
 ask what you can do for your country.
```

--------------------------------

### Exporting to various targets

Source: https://github.com/wyattblue/auto-editor/blob/master/skills/auto-editor-export/SKILL.md

Examples of exporting projects to different video editor formats, clip sequences, or auto-editor timeline files.

```bash
auto-editor video.mp4 --export resolve
auto-editor video.mp4 --export final-cut-pro
auto-editor video.mp4 --export clip-sequence
auto-editor video.mp4 --export v3 -o timeline.v3
```

--------------------------------

### Use Start and End Variables

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/range-syntax.md

Utilizing start and end keywords to represent the beginning and total length of the timeline.

```sh
# This will cut out everything in the beginning
auto-editor example.mp4 --cut start,300

# This will keep everything besides the beginning, overriding other edits
auto-editor example.mp4 --keep 300,end

# This will cut out everything
auto-editor example.mp4 --cut start,end
```

--------------------------------

### Define active segments with edit methods

Source: https://github.com/wyattblue/auto-editor/blob/master/skills/auto-editor/SKILL.md

Examples of using different editing methods to determine which parts of a video are considered active.

```bash
auto-editor video.mp4 --edit audio:threshold=0.04
auto-editor video.mp4 --edit audio:-19dB            # dB form
auto-editor video.mp4 --edit motion:threshold=0.02
auto-editor video.mp4 --edit blackdetect            # cut to remove black: --edit "(not blackdetect:0.98)"
```

--------------------------------

### Example v1 timeline JSON structure

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/v1.md

A sample JSON file representing a v1 timeline, where chunks define segments of the source media.

```json
{
  "version": "1",
  "source": "example.mp4",
  "timebase": "30/1",
  "chunks": [
    [0, 26, 1],
    [26, 34, 0],
    [34, 396, 1],
    [396, 410, 0],
    ...
  ],
}
```

--------------------------------

### Export transcript to file

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/subcommands/whisper.md

Example of saving the transcription output to an SRT file using the --format and --output flags.

```bash
auto-editor whisper example.mp4 ggml-medium.en.bin --format srt -o out.srt
```

--------------------------------

### Define Frame Ranges

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/range-syntax.md

Demonstrates cutting specific frame ranges where the start is inclusive and the end is exclusive.

```sh
# This will cut out the first frame: frame 0
auto-editor example.mp4 --cut 0,1

# This will cut out five frames: frames 0, 1, 2, 3, 4
# frame 5 will still exist because the end point is exclusive
auto-editor example.mp4 --cut 0,5

# Cuts out 60 frames
auto-editor example.mp4 --cut 10,70
```

--------------------------------

### Define composited video layers

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/v3.md

Example of defining multiple video tracks where higher tracks are composited over the base layer using position effects.

```json
"v": [
  [ { "src": "example.mp4", "start": 0, "dur": 60, "offset": 0, "stream": 0 } ],
  [ { "src": "pip.mp4", "start": 0, "dur": 60, "offset": 0, "stream": 0, "effects": ["pos:900:60:0.25"] } ],
  [ { "src": "logo.png", "start": 0, "dur": 60, "offset": 0, "stream": 0, "effects": ["pos:40:40"] } ]
]
```

--------------------------------

### Display help information

Source: https://github.com/wyattblue/auto-editor/blob/master/README.md

List all available command line options.

```bash
auto-editor --help
```

--------------------------------

### Build from Source on Unix-Like Systems

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/installing.md

Requires Nim, Nimble, and build tools. Use makeff to fetch dependencies and make for static builds.

```sh
nimble makeff  # Downloads and builds all dependencies
nimble make  # Build statically
```

```sh
# Needs ffmpeg libs installed.
nimble brewmake
```

--------------------------------

### Build from Source on Windows

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/installing.md

Requires WSL and build tools. Use specific commands for standard or ARM architectures.

```sh
nimble makeffwin
nimble makewin
```

```sh
nimble makeffwinarm
nimble makewinarm
```

--------------------------------

### Apply basic actions to video sections

Source: https://github.com/wyattblue/auto-editor/blob/master/skills/auto-editor-effects/SKILL.md

Demonstrates using -w:0 to apply speed and volume adjustments to silent sections.

```bash
auto-editor video.mp4 -w:0 speed:8            # fast-forward through silence (pitch preserved)
auto-editor video.mp4 -w:0 speed:3,volume:0.5 # speed up AND halve volume of silent parts
```

--------------------------------

### Trim start and end segments

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/cookbook.md

Remove specific durations from the beginning and end of the file.

```sh
# Drop the first and last 30 seconds, on top of the automatic edit
auto-editor video.mp4 --cut-out start,30sec -30sec,end
```

--------------------------------

### Overlay images and videos

Source: https://github.com/wyattblue/auto-editor/blob/master/skills/auto-editor-effects/SKILL.md

Shows how to add overlays like logos or PiP (Picture-in-Picture) to video sections.

```bash
auto-editor video.mp4 -w:1 add:./logo.png             # centered, fit to canvas
auto-editor video.mp4 -w:1 add:./pip.mp4:900:60:0.25  # quarter-size PiP in the corner
auto-editor video.mp4 -w:1 add:./logo.png,spin:0/-30  # the logo spins, not the base video
auto-editor song.mp3 -bg white -w:1 add:./cover.png   # audio + image → video
```

--------------------------------

### Configure Pacing with Margin and Smooth

Source: https://github.com/wyattblue/auto-editor/blob/master/skills/auto-editor/SKILL.md

Adjust padding around kept sections and define minimum cut/clip durations to refine edit transitions.

```bash
auto-editor video.mp4 --margin 0.2sec        # default: pad each kept section by 0.2s both sides
auto-editor video.mp4 --margin 0.3s,1.5sec   # 0.3s before, 1.5s after (avoids clipped words)
auto-editor video.mp4 --smooth 0.2s,0.1s     # min-cut 0.2s, min-clip 0.1s (default); --smooth 0 = off
```

--------------------------------

### Apply custom actions with labels

Source: https://github.com/wyattblue/auto-editor/blob/master/skills/auto-editor/SKILL.md

Use --edit:N and --when:N to define custom classes and assign specific actions to them.

```bash
# Cut silence (0) and keep speech (1) as usual, but also zoom wherever there's motion (2)
auto-editor video.mp4 --edit:2 motion:0.02 --when:2 zoom:2
auto-editor video.mp4 -e:2 motion:0.1 -w:2 speed:2        # -e/-w short forms

# Three tiers: cut silence, keep quiet speech at 1x, speed up the loud parts
auto-editor talk.mp4 --edit audio:-30dB --edit:2 audio:-12dB --when:2 speed:1.5
```

--------------------------------

### Edit command syntax comparison

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/ref/edit.html

Demonstrates the shorthand syntax and its equivalent full expression for the --edit command.

```bash
auto-editor example.mp4 --edit audio:0.05,stream=0
```

```bash
auto-editor example.mp4 --edit "(audio 0.05 (= stream 0))"
```

--------------------------------

### Clip type definition

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/v2.md

TypeScript type definition for a clip, consisting of start time, end time, and effect index.

```ts
type Clip = [start: number, end: number, effect: number];
```

--------------------------------

### Apply custom labels and actions

Source: https://github.com/wyattblue/auto-editor/blob/master/README.md

Assign specific actions to custom labels to handle different audio levels.

```bash
# Cut silence, keep speech, and additionally speed up the loud parts
auto-editor example.mp4 --edit:2 audio:-12dB --when:2 speed:1.5
```

--------------------------------

### Importing and rendering timelines

Source: https://github.com/wyattblue/auto-editor/blob/master/skills/auto-editor-export/SKILL.md

Commands to read existing timeline or XML files and render them into a final media file.

```bash
auto-editor myFcp7File.xml -o render.mp4    # render an fcp7 xml (experimental)
auto-editor timeline.v3 -o render.mp4       # render an auto-editor timeline file
```

--------------------------------

### Exporting microphone recordings

Source: https://github.com/wyattblue/auto-editor/blob/master/skills/auto-editor-export/SKILL.md

Commands to capture microphone input directly into an editor-ready project format.

```bash
auto-editor :mic --export resolve -o interview.fcpxml
# writes interview.fcpxml and interview_RECORDING.mka
```

```bash
auto-editor :mic --export resolve -c:a opus -o interview.fcpxml
auto-editor :mic --sample-rate 44.1kHz --export v3 -o interview.v3
```

--------------------------------

### Display media information

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/subcommands/info.md

Use the info command to retrieve metadata for one or more media files in a human-readable format.

```bash
auto-editor info example.mp4 resources/only-video/man-on-green-screen.gif

example.mp4:
 - recommendedTimebase: 30/1
 - video:
   - track 0:
     - codec: h264
     - fps: 30
     - resolution: 1280x720
     - aspect ratio: 16:9
     - pixel aspect ratio: 1
     - duration: 42.4
     - pix fmt: yuv420p
     - color range: 1 (tv)
     - color space: 1 (bt709)
     - color primaries: 1 (bt709)
     - color transfer: 1 (bt709)
     - timebase: 1/30000
     - bitrate: 240958
     - lang: eng
 - audio:
   - track 0:
     - codec: aac
     - layout: stereo
     - samplerate: 48000
     - duration: 42.4
     - bitrate: 317375
     - lang: eng
 - container:
   - duration: 42.4
   - bitrate: 570335

resources/only-video/man-on-green-screen.gif:
 - recommendedTimebase: 3333/100
 - video:
   - track 0:
     - codec: gif
     - fps: 100/3
     - resolution: 1280x720
     - aspect ratio: 16:9
     - pixel aspect ratio: 64/64
     - duration: 24.41
     - pix fmt: bgra
     - timebase: 1/100
 - container:
   - duration: 24.41
   - bitrate: 1649917
```

--------------------------------

### Basic Action Syntax

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Standard usage for defining actions on inactive and active media segments.

```sh
# Cut inactive sections (default behavior)
auto-editor video.mp4 --when-inactive cut

# Keep active sections unchanged (default behavior)
auto-editor video.mp4 --when-active nil
```

--------------------------------

### Configure Rendering and File Size

Source: https://github.com/wyattblue/auto-editor/blob/master/skills/auto-editor/SKILL.md

Control output quality, bitrate, resolution, and audio normalization to manage file size and encoding standards.

```bash
auto-editor video.mp4 -c:v hevc -b:v 0       # variable bitrate
auto-editor video.mp4 -b:v 230k              # target a bitrate to shrink the file
auto-editor video.mp4 -crf 23 -preset medium # quality-based encoding
auto-editor video.mp4 --scale 0.5            # halve the resolution
auto-editor video.mp4 -anorm ebu             # EBU R128 loudness normalize (or peak:-3)
```

--------------------------------

### Display media information in JSON

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/subcommands/info.md

Use the --json flag to output media metadata in a machine-friendly JSON format.

```bash
auto-editor info example.mp4 --json

{
  "example.mp4": {
    "type": "media",
    "recommendedTimebase": "30/1",
    "video": [
      {
        "codec": "h264",
        "fps": "30",
        "resolution": [
          1280,
          720
        ],
        "aspect_ratio": [
          16,
          9
        ],
        "pixel_aspect_ratio": "1",
        "duration": 42.4,
        "pix_fmt": "yuv420p",
        "color_range": 1,
        "color_space": 1,
        "color_primaries": 1,
        "color_transfer": 1,
        "timebase": "1/30000",
        "bitrate": 240958,
        "lang": "eng"
      }
    ],
    "audio": [
      {
        "codec": "aac",
        "layout": "stereo",
        "samplerate": 48000,
        "duration": 42.4,
        "bitrate": 317375,
        "lang": "eng"
      }
    ],
    "subtitle": [],
    "image": [],
    "container": {
      "duration": 42.4,
      "bitrate": 570335
    }
  }
}
```

--------------------------------

### Display video description

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/subcommands/desc.md

Extracts and prints the description from a video file. Requires a video file as input.

```bash
% yt-dlp --add-metadata -f "bestvideo[ext=mp4]" "https://www.youtube.com/watch?v=jNQXAC9IVRw" -o out.mp4
% auto-editor desc out.mp4

Chapters:

00:00 Intro
00:05 The cool thing
00:17 End

Interesting.... https://www.youtube.com/watch?v=VaLXzI92t9M
```

```bash
% auto-editor desc example.mp4

No description.
```

--------------------------------

### Generate v3 timeline from media

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/v3.md

Use the --export v3 flag to create a v3 timeline file from a media source.

```sh
auto-editor example.mp4 --export v3 -o input.v3
```

--------------------------------

### Apply easing to animations

Source: https://github.com/wyattblue/auto-editor/blob/master/skills/auto-editor-effects/SKILL.md

Demonstrates applying easing curves to animated actions.

```bash
auto-editor video.mp4 -w:1 zoom:1..1.5:ease=inout
auto-editor video.mp4 -w:1 opacity:0..1:ease=in:2sec        # ease over 2s, then hold
auto-editor video.mp4 -w:1 ease:out,zoom:1..1.3,brightness:0..0.3
```

--------------------------------

### Exporting to Premiere Pro

Source: https://github.com/wyattblue/auto-editor/blob/master/skills/auto-editor-export/SKILL.md

Basic command to export a video project to an XML format compatible with Adobe Premiere Pro.

```bash
auto-editor video.mp4 --export premiere    # → video_ALTERED.xml for Premiere Pro
```

--------------------------------

### Basic media editing with auto-editor

Source: https://github.com/wyattblue/auto-editor/blob/master/skills/auto-editor/SKILL.md

Perform basic trimming on a video file, including specifying custom output filenames.

```bash
auto-editor path/to/video.mp4          # writes video_ALTERED.mp4
auto-editor video.mp4 -o out.mp4       # choose the output name
```

--------------------------------

### Use dB units for editing

Source: https://github.com/wyattblue/auto-editor/blob/master/README.md

Apply volume-based thresholds using decibel units.

```bash
auto-editor example.mp4 --edit audio:-19dB
auto-editor example.mp4 --edit audio:-7dB
auto-editor example.mp4 --edit motion:-19dB
```

--------------------------------

### Splitting clips without editing

Source: https://github.com/wyattblue/auto-editor/blob/master/skills/auto-editor-export/SKILL.md

Configuring the export to split media at cut points without applying additional edits by setting actions to nil.

```bash
auto-editor example.mp4 -w:0 nil -w:1 nil --export premiere
```

--------------------------------

### Render media from v3 timeline

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/v3.md

Process a v3 timeline file to output a rendered media file.

```sh
auto-editor input.v3 -o output.mkv
```

--------------------------------

### Perform a basic first pass edit

Source: https://github.com/wyattblue/auto-editor/blob/master/README.md

Automatically cut dead space or silence from a video file.

```bash
auto-editor path/to/your/video.mp4
```

--------------------------------

### Export to video editors

Source: https://github.com/wyattblue/auto-editor/blob/master/README.md

Generate project files compatible with external video editing software.

```bash
auto-editor example.mp4 --export premiere
```

--------------------------------

### Systemd Service Configuration

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/README.md

Configuration file for managing the Auto-Editor website as a systemd service.

```ini
[Unit]
Description=AutoEditor Website
After=network.target

[Service]
User=root
WorkingDirectory=/var/www/auto-editor
ExecStart=/root/.bun/bin/bun run server.js

[Install]
WantedBy=multi-user.target
```

--------------------------------

### Transcribe and Cut Workflow

Source: https://github.com/wyattblue/auto-editor/blob/master/skills/auto-editor-transcribe/SKILL.md

Workflow for generating a sidecar subtitle file and using it to edit the video.

```bash
auto-editor whisper talk.mp4 ggml-medium.en.bin --format srt -o talk.srt
auto-editor talk.mp4 --edit word:question        # picks up talk.srt automatically
```

--------------------------------

### add

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Overlays an image, video, or generator on top of matched sections.

```APIDOC
## add:path[:x:y:scale]

### Description
Overlays an image or video on top of the matched sections. This is a virtual action that adds a new layer to the timeline.

### Parameters
- **path** (string) - Required - A media file path or a generator name (e.g., confetti).
- **x** (int/ramp) - Optional - X-coordinate or animation ramp.
- **y** (int/ramp) - Optional - Y-coordinate or animation ramp.
- **scale** (float/ramp) - Optional - Size multiplier or animation ramp.
```

--------------------------------

### Basic whisper usage

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/subcommands/whisper.md

The standard syntax for invoking the whisper subcommand with a media file and a model path.

```bash
auto-editor whisper <file> <model> [options]
```

--------------------------------

### List cache files

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/subcommands/cache.md

Displays the current cache entries stored by auto-editor.

```sh
auto-editor cache
```

--------------------------------

### Display media levels

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/subcommands/levels.md

Executes the levels command on a media file to output raw analysis data.

```bash
auto-editor levels example.mp4

@start
0.00008813678829543451
0.00026441036488630354
0.00026441036488630354
0.00017627357659086903
0.00775603736999823726
0.04794641283271637577
0.14604265820553499755
0.44368059227921735621
0.52362065926317646891
0.46201304424466771437
0.47611493037193725053
0.51427815970386037137
0.86162524237616777700
0.76291203948528119039
0.70853164110699806688
(Continues for 1000 more lines)
0.18905341089370703012
0.02793936188965273973
0.01401374933897408734
0.01189846641988365900
0.00493566014454433280
0.00317292437863564251
0.00105764145954521417
0.00008813678829543451
0.00008813678829543451
0.00000000000000000000
0.00000000000000000000
(30 more lines)
0.00000000000000000000
0.00000000000000000000
0.00000000000000000000
0.00000000000000000000
```

--------------------------------

### Chaining Multiple Actions

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Combine multiple actions by separating them with commas. Actions are applied sequentially in the order provided.

```sh
# Speed up AND reduce volume
auto-editor video.mp4 -w:0 speed:3,volume:0.5

# Combine speed and varispeed
# Effective speed: 1.25 × 1.25 = 1.5625x
auto-editor video.mp4 -w:1 varispeed:1.25,speed:1.25

# Triple action: speed, varispeed, and volume
auto-editor video.mp4 -w:0 speed:2,varispeed:1.5,volume:0.8
```

--------------------------------

### Process v2 file with Auto-Editor

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/v2.md

Command to use a v2 file as input for processing media.

```sh
auto-editor input.v2 -o output.mkv
```

--------------------------------

### Apply dissolve transitions

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/cookbook.md

Smooth out cuts using dissolve transitions instead of hard cuts.

```sh
auto-editor video.mp4 --transition dissolve:0.5sec
```

```sh
auto-editor video.mp4 --transition dissolve:0.5sec:0
```

--------------------------------

### Animatable Effects with Ramps

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Use the from..to syntax to interpolate effects like zoom, opacity, and volume over a section. Position animations support multiple fields for complex movement.

```sh
# Slowly zoom in from 1x to 1.5x across the section (Ken Burns)
auto-editor video.mp4 -w:1 zoom:1..1.5

# Fade in (opacity 0 to 1)
auto-editor video.mp4 -w:1 opacity:0..1

# Fade the audio in alongside it
auto-editor video.mp4 -w:1 volume:0..1

# Slide a logo across the frame while shrinking it
auto-editor video.mp4 -w:1 add:./logo.png,pos:0..1200:40:1..0.5
```

--------------------------------

### Applying Transitions

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Use the transition option to apply effects between clips. The minimum cut duration can be adjusted to control which cuts are affected.

```sh
# Cross-dissolve cuts of at least 1 second; fade the timeline endpoints.
auto-editor video.mp4 --transition dissolve:0.5sec

# Override the minimum cut duration, or use :0 to include every eligible cut.
auto-editor video.mp4 --transition dissolve:0.5sec:2sec
auto-editor video.mp4 --transition dissolve:0.5sec:0
```

--------------------------------

### Nil Action

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Keep the section unchanged.

```sh
# Keep everything, even silent sections
auto-editor video.mp4 --when-inactive nil
```

--------------------------------

### Action: nil

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Does nothing to the specified section, keeping it unchanged.

```APIDOC
## nil

### Description
Do nothing. Keep the section unchanged.

### Usage Example
```sh
auto-editor video.mp4 --when-inactive nil
```
```

--------------------------------

### Convert timeline formats to v3

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/v3.md

Translate existing timeline formats like FCP7 XML into the v3 format.

```sh
auto-editor input-fcp7.xml --export v3 -o output.v3
```

--------------------------------

### Preview editing results

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/cookbook.md

Analyze the file to see what will be cut without generating an output file.

```sh
auto-editor video.mp4 --preview
```

--------------------------------

### Action: zoom

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Zooms in or out by a factor.

```APIDOC
## zoom

### Description
Zoom in or out by a factor.

### Parameters
- **Value range:** greater than 0.0, up to 100.0
- **1.0** = no zoom

### Usage Example
```sh
# Zoom in 2x on active sections
auto-editor video.mp4 -w:1 zoom:2
```
```

--------------------------------

### Speed Action

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Change the playback speed while preserving pitch using time-stretching.

```sh
# Speed up inactive sections to 8x (preserving pitch)
auto-editor video.mp4 -w:0 speed:8

# Slow down active sections to half speed
auto-editor video.mp4 -w:1 speed:0.5
```

--------------------------------

### Action: volume

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Adjusts the audio volume level.

```APIDOC
## volume

### Description
Adjust the audio volume level.

### Parameters
- **1.0** = normal volume
- **0.5** = half volume (-6dB)
- **2.0** = double volume (+6dB)

### Usage Example
```sh
# Reduce silent section volume to 20%
auto-editor video.mp4 -w:0 volume:0.2

# Boost loud sections
auto-editor video.mp4 -w:1 volume:1.5
```
```

--------------------------------

### Export to video editing software

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/cookbook.md

Generate project files for external editors or export clips as individual files.

```sh
auto-editor video.mp4 --export premiere
```

```sh
auto-editor video.mp4 --export clip-sequence
```

--------------------------------

### Configure automatic cut methods

Source: https://github.com/wyattblue/auto-editor/blob/master/README.md

Define criteria for automated cuts based on motion or audio thresholds.

```bash
# cut out sections where the total motion is less than 2%.
auto-editor example.mp4 --edit motion:threshold=0.02

# `--edit audio:threshold=0.04,stream=all` is used by defaut.
auto-editor example.mp4

# Different tracks can be set with different attribute.
auto-editor multi-track.mov --edit "(or audio:stream=0 audio:threshold=10%,stream=1)"
```

--------------------------------

### Recording and editing microphone input

Source: https://github.com/wyattblue/auto-editor/blob/master/skills/auto-editor/SKILL.md

Capture audio from a microphone using the :mic input and apply editing parameters like sample rate or silence thresholds.

```bash
auto-editor :mic                                      # → mic_ALTERED.wav
auto-editor :mic --sample-rate 44.1kHz -o trimmed.m4a
auto-editor :mic --edit audio:threshold=6%
```

--------------------------------

### Default HTML Template Structure

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/templates/default.html

The base template file used for rendering pages. It includes standard header components, navigation, and content placeholders.

```html
{{ init_head }} {{ .Title }}{{ .MetaTags }} {{ head_icon }} {{ core_style }} {{ nav }}

# {{ .Title }}

{{ .Content }}
```

--------------------------------

### Process a v1 timeline file

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/v1.md

Command to use a v1 timeline file as input for auto-editor to generate an output file.

```sh
auto-editor input.v1 -o output.mkv
```

--------------------------------

### Configure audio sensitivity thresholds

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/cookbook.md

Adjust the audio threshold to change how aggressively silence is detected.

```sh
# Keep only louder audio (cuts more)
auto-editor video.mp4 --edit audio:threshold=6%

# The same idea in decibels
auto-editor video.mp4 --edit audio:-18dB
```

```sh
auto-editor video.mp4 --edit audio:channel=left
```

--------------------------------

### Zoom Action

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Zoom in or out by a factor.

```sh
# Zoom in 2x on active sections
auto-editor video.mp4 -w:1 zoom:2

# Zoom out on silent sections
auto-editor video.mp4 -w:0 zoom:0.5
```

--------------------------------

### Animate properties with ramps

Source: https://github.com/wyattblue/auto-editor/blob/master/skills/auto-editor-effects/SKILL.md

Uses range syntax to interpolate values like zoom, opacity, and position over a section.

```bash
auto-editor video.mp4 -w:1 zoom:1..1.5          # Ken Burns
auto-editor video.mp4 -w:1 opacity:0..1         # fade in
auto-editor video.mp4 -w:1 volume:0..1          # audio fade in
auto-editor video.mp4 -w:1 zoom:1..1.5..1       # zoom in then out (keyframes)
auto-editor video.mp4 -w:1 add:./logo.png,pos:0..1200:40:1..0.5  # slide + shrink overlay
```

--------------------------------

### Display subtitle streams with subdump

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/subcommands/subdump.md

Executes the subdump command on a media file to output its textual subtitle content.

```bash
auto-editor subdump resources/subtitle.mp4

file: resources/subtitle.mp4 (0:und:srt)
1
00:00:00,523 --> 00:00:01,016
oop

2
00:00:01,523 --> 00:00:01,916
boop


------
```

--------------------------------

### Live Microphone Transcription

Source: https://github.com/wyattblue/auto-editor/blob/master/skills/auto-editor-transcribe/SKILL.md

Commands for streaming audio directly from a microphone for transcription.

```bash
auto-editor whisper :mic ggml-medium.en.bin
auto-editor whisper :mic apple --language en_US    # macOS 26+
auto-editor whisper :mic ggml-medium.en.bin -o transcript.srt
```

--------------------------------

### Custom Action Classes

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Defining additional classes with custom edit expressions and actions. Higher labels take precedence when classes overlap.

```sh
# Cut silence and keep speech as usual, but additionally speed up the loud parts
auto-editor video.mp4 --edit:2 audio:-12dB --when:2 speed:1.5

# -e/-w short forms; zoom wherever there is motion, on top of the audio edit
auto-editor video.mp4 -e:2 motion:0.02 -w:2 zoom:2
```

--------------------------------

### Apply dissolve with custom minimum cut threshold

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/transition.md

Applies a 1-second dissolve at every cut by setting the minimum cut threshold to 0.

```sh
auto-editor video.mp4 --transition dissolve:1sec:0
```

--------------------------------

### Action: speed

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Changes the playback speed while preserving pitch using time-stretching.

```APIDOC
## speed

### Description
Change the playback speed while preserving pitch using time-stretching.

### Usage Example
```sh
# Speed up inactive sections to 8x (preserving pitch)
auto-editor video.mp4 -w:0 speed:8

# Slow down active sections to half speed
auto-editor video.mp4 -w:1 speed:0.5
```
```

--------------------------------

### Volume Action

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Adjust the audio volume level.

```sh
# Reduce silent section volume to 20%
auto-editor video.mp4 -w:0 volume:0.2

# Boost loud sections
auto-editor video.mp4 -w:1 volume:1.5

# Fade the audio in across the section (see Animations below)
auto-editor video.mp4 -w:1 volume:0..1
```

--------------------------------

### Apply basic dissolve transition

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/transition.md

Applies a 1-second dissolve at eligible cuts and fades at the timeline ends.

```sh
auto-editor video.mp4 --transition dissolve:1sec
```

--------------------------------

### Set Video Bitrate in Auto-Editor

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/file-size.md

Adjust the video bitrate manually to control output file size. Setting a specific value like 230k limits the video stream bitrate.

```sh
auto-editor my-video.mp4 -b:v 230k
```

--------------------------------

### Edit directly from a URL

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/cookbook.md

Process a video directly from a URL using yt-dlp.

```sh
auto-editor "https://www.youtube.com/watch?v=kcs82HnguGc"
```

--------------------------------

### Action: deesser

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Reduces harsh sibilance in the audio section.

```APIDOC
## deesser

### Description
Reduce harsh "s" and "sh" sibilance in the audio section. Takes up to three positional args, `deesser:intensity[:max[:freq]]`, each in the range 0.0 to 1.0.

### Parameters
- **intensity** — how much to de-ess (0.0 = none, 1.0 = maximum)
- **max** — caps the maximum reduction (default 0.5)
- **freq** — split frequency (default 0.5)

### Usage Example
```sh
# De-ess active (spoken) sections
auto-editor video.mp4 -w:1 deesser:0.5
```
```

--------------------------------

### Combine editing methods

Source: https://github.com/wyattblue/auto-editor/blob/master/README.md

Use multiple editing criteria simultaneously within a single command.

```bash
# 'threshold' is always the first argument for edit-method objects
auto-editor example.mp4 --edit "(or audio:0.03 motion:0.06)"
```

--------------------------------

### Action: spin

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Spins the picture continuously.

```APIDOC
## spin

### Description
Spin the picture continuously, `spin:deg/rate`: start at `deg` and turn at `rate` degrees per second.

### Usage Example
```sh
# Spin at 120 degrees/second
auto-editor video.mp4 -w:1 spin:0/120
```
```

--------------------------------

### Set Actions for Time Range

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Apply specific actions to defined time ranges using the --set-action flag.

```sh
# Keep a section unchanged from 0 to 5 seconds
auto-editor video.mp4 --set-action nil,0,5sec

# Apply speed + varispeed from 30 seconds to the end
auto-editor video.mp4 --set-action speed:1.5,varispeed:1.5,30sec,end
```

--------------------------------

### Action: invert

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Inverts all pixels in the video section.

```APIDOC
## invert

### Description
Invert all pixels in the video section.

### Usage Example
```sh
auto-editor video.mp4 -w:0 invert
```
```

--------------------------------

### Naming exported timelines

Source: https://github.com/wyattblue/auto-editor/blob/master/skills/auto-editor-export/SKILL.md

Specifying a custom name attribute for exported project files, with syntax variations for different shell environments.

```bash
# POSIX shells
auto-editor example.mp4 --export 'premiere:name="Your name here"'
# PowerShell (double the inner quotes)
auto-editor example.mp4 --export 'premiere:name=""Your name here""'
```

--------------------------------

### Target specific time ranges

Source: https://github.com/wyattblue/auto-editor/blob/master/skills/auto-editor-effects/SKILL.md

Uses --set-action to override defaults for a specific time range.

```bash
auto-editor video.mp4 --set-action nil,0,5sec
auto-editor video.mp4 --set-action speed:1.5,varispeed:1.5,30sec,end
auto-editor video.mp4 --set-action add:./logo.png:600:300:1.0,1sec,2sec
```

--------------------------------

### Editing by Spoken Content

Source: https://github.com/wyattblue/auto-editor/blob/master/skills/auto-editor-transcribe/SKILL.md

Commands to edit video timelines based on subtitle patterns or specific words.

```bash
# Keep only sections that have any subtitle (cut the silent gaps between speech)
auto-editor talk.mkv --edit subtitle

# Keep only sections where "introduction" is spoken
auto-editor lecture.mp4 --edit word:introduction

# Regex match (case-insensitive); keep matched lines
auto-editor talk.mkv --edit "subtitle:pattern=(yes|no),ignore-case=#t"

# Cut filler words instead of keeping them: invert with `not`
auto-editor video.mp4 --edit "(not word:um)"
```

--------------------------------

### v1 Timeline Specification

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/v1.md

The v1 format is a JSON structure used to define how a media file should be processed, including cuts and speed adjustments.

```APIDOC
## v1 Timeline Format

### Description
The v1 format is a JSON-based specification for defining linear media timelines. It allows users to define segments of a source file to be played or cut.

### Structure
- **version** (string) - Required - Must be "1".
- **source** (string) - Required - Path to the media file (relative or absolute).
- **timebase** (string) - Optional - The timebase as a rational number (e.g., "30/1"). If absent, it is derived from the source.
- **chunks** (Array) - Required - A list of segments where each segment is an array of three values: [start, end, speed].

### Chunk Definition
Each chunk is an array [start, end, speed]:
- **start** (number) - Inclusive start time in timebase units.
- **end** (number) - Exclusive end time in timebase units.
- **speed** (number) - Playback speed. 1.0 is normal speed; 0.0 or 99999.0 indicates a cut.

### Example
{
  "version": "1",
  "source": "example.mp4",
  "timebase": "30/1",
  "chunks": [
    [0, 26, 1],
    [26, 34, 0],
    [34, 396, 1]
  ]
}
```

--------------------------------

### Specify Time in Seconds

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/range-syntax.md

Using the sec unit to define ranges in seconds instead of the default timebase.

```sh
# Cut out the first 10 seconds.
auto-editor example.mp4 --cut start,10secs
```

--------------------------------

### Action: cut

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Removes the specified section completely from the output.

```APIDOC
## cut

### Description
Remove the section completely from the output.

### Usage Example
```sh
# Remove inactive sections (default behavior)
auto-editor video.mp4 --when-inactive cut

# Remove active ("loud") sections (inverted editing)
auto-editor video.mp4 --when-active cut
```
```

--------------------------------

### Deesser Action

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Reduce harsh "s" and "sh" sibilance in the audio section.

```sh
# De-ess active (spoken) sections
auto-editor video.mp4 -w:1 deesser:0.5

# Stronger de-essing with a higher max reduction and tuned frequency
auto-editor video.mp4 -w:1 deesser:0.8:0.7:0.4
```

--------------------------------

### Spin Action

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Spin the picture continuously.

```sh
# Spin at 120 degrees/second (one full turn every 3 seconds)
auto-editor video.mp4 -w:1 spin:0/120

# Start at 90 degrees and spin counter-clockwise at 45 degrees/second
auto-editor video.mp4 -w:1 spin:90/-45
```

```sh
# Spin a logo overlay over the video
auto-editor video.mp4 -w:1 add:./logo.png,spin:0/-30
```

--------------------------------

### Invert Action

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Invert all pixels in the video section.

```sh
auto-editor video.mp4 -w:0 invert
```

--------------------------------

### Podcast Editing

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Combine cutting silence and speeding up speech segments.

```sh
# Cut silence, slightly speed up speech
auto-editor podcast.mp3 -w:0 cut -w:1 speed:1.15
```

--------------------------------

### Cut Action

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Remove the section completely from the output.

```sh
# Remove inactive sections (default behavior)
auto-editor video.mp4 --when-inactive cut

# Remove active ("loud") sections (inverted editing)
auto-editor video.mp4 --when-active cut
```

--------------------------------

### Varispeed Action

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Change the playback speed by varying pitch, like analog tape or vinyl.

```sh
# Speed up inactive sections with pitch variation
auto-editor video.mp4 -w:0 varispeed:2

# Create slow-motion effect with lower pitch
auto-editor video.mp4 -w:1 varispeed:0.5
```

--------------------------------

### Set Speed for Range

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/range-syntax.md

Applying a specific playback speed to a defined time range using three comma-separated values.

```sh
# Set the speed to 2x from frame 0 to frame 29
auto-editor example.mp4 --set-speed-for-range 2,0,30

# Set the speed to 0.5x
auto-editor example.mp4 --set-speed-for-range 0.5,start,end
```

--------------------------------

### Transcription Command Syntax

Source: https://github.com/wyattblue/auto-editor/blob/master/skills/auto-editor-transcribe/SKILL.md

General syntax for invoking the whisper transcription command.

```bash
auto-editor whisper <file|:mic> <model> [options]
```

--------------------------------

### Record and edit from a microphone

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/cookbook.md

Capture audio directly from a microphone and process it for silence removal or export.

```sh
auto-editor :mic
```

```sh
auto-editor :mic --edit audio:threshold=6% -o trimmed.m4a
```

```sh
auto-editor :mic --sample-rate 44.1kHz
```

```sh
auto-editor :mic --export resolve -c:a opus -o interview.fcpxml
```

--------------------------------

### Combine edit methods with boolean operators

Source: https://github.com/wyattblue/auto-editor/blob/master/skills/auto-editor/SKILL.md

Use boolean operators to combine multiple editing methods. Methods must use explicit argument call forms when inside operators.

```bash
auto-editor multi.mov --edit "(or audio:stream=0 audio:threshold=10%,stream=1)"
auto-editor video.mp4 --edit "(or audio:0.03 motion:0.06)"   # threshold is always positional arg 1
auto-editor video.mp4 --edit "(not audio:0.04)"              # invert: keep the quiet parts
```

--------------------------------

### pos

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/actions.md

Sets the position and scale of an overlay clip when composited over a lower video track.

```APIDOC
## pos:x:y[:scale]

### Description
Places a clip as an overlay when composited over a lower video track. Has no effect on the base track.

### Parameters
- **x** (int) - Required - The overlay's top-left corner x-coordinate in canvas pixels.
- **y** (int) - Required - The overlay's top-left corner y-coordinate in canvas pixels.
- **scale** (float) - Optional - Size multiplier of the source's native size (default 1.0).
```

--------------------------------

### Perform basic automatic editing

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/cookbook.md

Automatically remove silent segments from a video file.

```sh
auto-editor video.mp4
```

```sh
auto-editor video.mp4 -o trimmed.mp4
```

--------------------------------

### Adjust padding around cuts

Source: https://github.com/wyattblue/auto-editor/blob/master/docs/src/docs/cookbook.md

Control the amount of silence kept around kept sections to make the pacing feel more natural.

```sh
# 0.5 seconds of padding on both sides
auto-editor video.mp4 --margin 0.5sec

# 0.3s before, 1.5s after
auto-editor video.mp4 --margin 0.3sec,1.5sec
```
Tokens:
Raw