autoshorts README

The project's README from github.com/JayWebtech/autoshorts. As one markdown file: README.md.

⭐ Support AutoShorts

AutoShorts

AutoShorts is a local-first desktop application for turning long-form video or audio recordings into high-impact, vertical short-form clip candidates (9:16 portrait) with AI-powered viral moment ranking.

This repository implements the desktop app foundation using Tauri 2 + React + TSX + Rust + SQLite.

Screenshot 2026-06-22 at 4 10 13 PM

Key Features


Prerequisites

To run the application, FFmpeg & FFprobe must be installed and available on your system PATH to handle cropping, audio extraction, and dynamic captions:


Installation Guide (For Users)

Download the correct package matching your system from the latest GitHub Releases.

🖥️ macOS Installation

  1. Download:
    • Apple Silicon (M1/M2/M3): Select the aarch64.dmg package.
    • Intel Mac: Select the x64.dmg package.
  2. Install: Double-click the .dmg file and drag AutoShorts to your Applications folder.
  3. Bypass Gatekeeper (For unsigned local builds):
    • Right-click AutoShorts.app in Finder, select Open, and click Open in the warning dialog.
    • Alternatively, run this command in Terminal:
      xattr -cr /Applications/AutoShorts.app
      

🪟 Windows Installation

  1. Download: Select the .msi (installer) or .exe (portable executable) package.
  2. Install: Double-click the .msi file to run the setup wizard.
  3. SmartScreen Bypass: Since the package is self-signed, Windows SmartScreen may show a warning. Click "More Info" in the window and choose "Run anyway".

🐧 Linux Installation

  1. Download: Select the .deb (Debian/Ubuntu) or .AppImage (universal portable binary).
  2. Install .deb:
    sudo dpkg -i autoshorts_*.deb
    
  3. Run .AppImage: Make it executable and launch it:
    chmod +x autoshorts_*.AppImage
    ./autoshorts_*.AppImage
    

🚀 First-Launch Onboarding & AI Configuration

When you first launch the application, you will be greeted by an Onboarding Wizard that lets you choose your preferred workflow:

Option A: Fully Offline (Ollama + Whisper)

  1. Ollama Setup: Select a local model card (llama3.2 3B, qwen2.5 3B, or qwen2.5 7B). The application will check if Ollama is running and automatically pull the model weights, showing a downloader progress bar.
  2. Local Whisper: Follow the prompt instructions to verify Python is installed and run pip3 install openai-whisper to enable fully offline transcription.

Option B: Cloud API Keys

  1. Enter your API credentials for:
    • Deepgram: For fast, accurate cloud transcription.
    • DeepSeek: (Highly Recommended) For cheap, high-quality cloud moment detection.
    • Claude: For premium copywriting, hooks, and moment detection.
  2. Click Save & Start to immediately load the dashboard.

⚙️ Modifying Settings & Resetting Onboarding

[!TIP] LLM Provider Recommendation (Local vs. Cloud):

  • Local Models (Ollama): While AutoShorts supports fully offline moments analysis via local Ollama models (like LLaMA 3.2 3B or Qwen 2.5 3B/7B), local models are generally not recommended for viral moment detection. Smaller 3B/7B models lack the context reasoning and mathematical capabilities needed to evaluate long transcripts and calculate accurate segment timestamps (often outputting fragments that are too short).
  • DeepSeek (Highly Recommended): We strongly suggest using DeepSeek for moment detection. It offers top-tier reasoning capabilities (matching GPT-4/Claude 3.5 Sonnet) at a fraction of a cent per run (under $0.001 per transcript). You can get an API key instantly at platform.deepseek.com.
  • Claude (Premium Option): Claude 3.5 Sonnet provides the absolute best hooks copywriting and emotional resonance, but is slightly more expensive than DeepSeek (typically $0.01 – $0.05 per run).

Developer Guide

1. Setup Environment Configuration

Copy .env.example to .env in the root folder:

cp .env.example .env

Fill in your API Keys:

DEEPGRAM_API_KEY=your-deepgram-api-key
DEEPSEEK_API_KEY=your-deepseek-api-key
ANTHROPIC_API_KEY=your-anthropic-api-key

# Choose your default AI analysis provider ("deepseek" or "claude")
LLM_PROVIDER=deepseek

2. Run in Development Mode

To start the live-reloaded frontend and backend development shell:

npm install
npm run tauri:dev

3. Build the Application

To build and package the native macOS app bundle (.app and .dmg installer):

npm run tauri:build

The output installers will be built under src-tauri/target/release/bundle/.

❤️ Support AutoShorts

If AutoShorts helps you create content faster, consider supporting its development.

Your support helps fund new features, bug fixes, and ongoing improvements.

👉 https://buy.polar.sh/polar_cl_ZjNgejG1JnPQqVXyMmEmq7vpdwJUFBqx4qahw4BqBCP

autoshorts (JayWebtech/autoshorts)

Searching Database…

这是什么?AutoShorts 是一个本地优先的桌面应用,把长视频或音频录音转成竖屏(9:16)短视频片段候选,并用 AI 排序最容易爆火的高光时刻。
这是云服务,还是在我电脑上运行?它是用 Tauri 2、React 和 Rust 构建的原生桌面应用,不是网页服务;转写稿、候选片段和项目数据都保存在你电脑上的本地 SQLite 数据库中。
我需要自己安装 FFmpeg 吗?需要,运行应用之前,系统 PATH 中必须已安装 FFmpeg 和 FFprobe,因为应用会原生调用它们进行裁剪、音频提取和字幕渲染。
我能完全离线运行,且 AI 精度不打折扣吗?你可以用 Ollama 加本地 Whisper 完全离线运行,但 README 自己就警告:3B/7B 的小型本地模型不擅长高光时刻检测,因为它们缺乏对长转写稿打分并精确标记时间戳段落所需的推理能力。
我的录像会离开我的电脑吗?只有在你选择云端工作流时才会:音频发送到 Deepgram 转写,转写稿发送到 DeepSeek 或 Claude 做高光时刻分析;其余一切(包括转写稿和候选片段)都保存在本地 SQLite 中。
高光时刻检测可以用哪些 AI 提供商?AutoShorts 支持 DeepSeek(默认、推荐,每次转写不到 0.001 美元)和 Claude(高端,每次运行 0.01-0.05 美元,最擅长开头钩子/文案),云端转写用 Deepgram,离线则用本地 Whisper。
安装包有代码签名吗?没有。Windows 版是自签名的,SmartScreen 会发出警告,你需要点击「仍要运行」;macOS 版未签名,你必须右键点击应用并选择「打开」来绕过 Gatekeeper。
第一次启动应用会发生什么?会出现一个引导向导,让你选择完全离线的工作流(Ollama 本地模型加本地 Whisper)或云端工作流(Deepgram、DeepSeek 或 Claude 的 API 密钥);之后你可以随时在 API 设置面板中切换或重置。
Creator
JayWebtech
Size
1.5 MB
Stars
1.3K
Age
3mo
Commits · 90 Days