Skip to main content

Local-first CLI for short-form video and creator analysis

Project description

shortform-ai

Local-first CLI for short-form video and creator analysis.

Recommended persistent install for repeated Codex use:

pipx install shortform-ai
~/.local/bin/shortform-ai doctor

If the app is already installed with pipx:

pipx upgrade shortform-ai

Homebrew remains a good system install path once the formula is wired:

brew install shortform-ai

For one-off venv tests, use Python 3.12+ explicitly:

python3.12 -m venv .venv-shortform-ai
.venv-shortform-ai/bin/python -m pip install --upgrade pip
.venv-shortform-ai/bin/python -m pip install shortform-ai yt-dlp

Local transcription is installed on first use when no OpenAI key is configured:

shortform-ai setup transcription --local

shortform-ai analyze defaults to --transcribe auto. It uses OpenAI transcription when OPENAI_API_KEY is configured; otherwise bootstrap analyze installs local faster-whisper on first use. The default local model is base, which downloads a model cache on first use. Use --transcribe-model small for better local accuracy.

Analysis requires a real transcript. If neither OpenAI transcription nor local faster-whisper is available, analyze stops with setup instructions instead of producing a transcript-free strategy pass.

For one-prompt Codex workflows, use the bootstrap command after installing the package:

shortform-ai bootstrap analyze <instagram-url-or-file> --instagram-from-chrome

It installs/updates the Codex skill, optionally imports the user's own Chrome Instagram session, runs analysis, fetches Instagram comments when possible, and writes bootstrap.json beside the analysis artifacts. The analyzer emits progress lines during long-running steps so Codex does not appear stuck. When comment fetch succeeds, bootstrap merges the audience summary back into the root report.md, audience.md, and comments.json.

For Instagram reel URLs with local Instagram auth configured, analysis also writes safe creator, aggregate metrics, and audio attribution metadata to media.json, reel.json, and report.md, including likes, comments, plays/views, creator profile fields, and named background music/original-audio title when Instagram exposes them.

Video analysis also tries to write contact_sheet.jpg and always writes report.md, a rich Markdown overview that points at the contact sheet when available. Caption-heavy reels also get onscreen_text.md; transcript.md is the audio transcript, so it may contain music lyrics instead of the visible story text.

Development usage from this monorepo:

PYTHONPATH=packages/content-ai-runtime python3 -m content_ai_runtime.cli doctor

The CLI reads a user's own local Instagram Chrome session only after an explicit shortform-ai auth instagram --from-chrome command. Session values are redacted from output and are stored in local secure storage when available.

content-ai remains available as a backwards-compatible command alias.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shortform_ai-0.1.9.tar.gz (37.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

shortform_ai-0.1.9-py3-none-any.whl (34.5 kB view details)

Uploaded Python 3

File details

Details for the file shortform_ai-0.1.9.tar.gz.

File metadata

  • Download URL: shortform_ai-0.1.9.tar.gz
  • Upload date:
  • Size: 37.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for shortform_ai-0.1.9.tar.gz
Algorithm Hash digest
SHA256 4855d1723d0467cbfe8071eb02733c548a9acaccb0841d733eb9777bed5aa133
MD5 29d54b38b6d20d83c48ea6411da04f39
BLAKE2b-256 1cc57dfbec033289e96c27c27aaaa1a045cd96d819f02a8aec2397e9abeb8a45

See more details on using hashes here.

Provenance

The following attestation bundles were made for shortform_ai-0.1.9.tar.gz:

Publisher: release-shortform-ai.yml on intelc/content-ai-pipeline

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file shortform_ai-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: shortform_ai-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 34.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for shortform_ai-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 3f885366247394c7b46b43f50b79e924528e2dc8c6cd9210552102c5227813ae
MD5 6ceed15f08936114f7343c4b70091303
BLAKE2b-256 cd920829c9b5a93e07b3850794f5e6c3dc90fc3009452261a2e3b2b70f5d2b5a

See more details on using hashes here.

Provenance

The following attestation bundles were made for shortform_ai-0.1.9-py3-none-any.whl:

Publisher: release-shortform-ai.yml on intelc/content-ai-pipeline

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page