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-transcribe]"
~/.local/bin/shortform-ai doctor

If the app is already installed with pipx:

pipx upgrade shortform-ai
pipx inject --force shortform-ai "shortform-ai[local-transcribe]"

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[local-transcribe]" yt-dlp

Optional local transcription is available with faster-whisper:

pip install "shortform-ai[local-transcribe]"

shortform-ai analyze defaults to --transcribe auto. It uses OpenAI transcription when OPENAI_API_KEY is configured; otherwise it uses local faster-whisper when the optional extra is installed. 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.

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.7.tar.gz (35.3 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.7-py3-none-any.whl (33.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: shortform_ai-0.1.7.tar.gz
  • Upload date:
  • Size: 35.3 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.7.tar.gz
Algorithm Hash digest
SHA256 5a01a80dcec8b0062f92c1875d0f4acb18075b83d27524cd4c2b378c4070be72
MD5 11e9b594e5c97b0144db5ddae548bd02
BLAKE2b-256 4571bbab2311ed8ce40e9a1cacbaa54d2c44a52a31e90514446a59be8b07cefc

See more details on using hashes here.

Provenance

The following attestation bundles were made for shortform_ai-0.1.7.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.7-py3-none-any.whl.

File metadata

  • Download URL: shortform_ai-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 33.0 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 7d00447e33b016766ec7a2b750575e9393e5fb74bd86622acea6e2902dec14ed
MD5 0bbc62e7481e429e0fd1c2bba2e91114
BLAKE2b-256 22771221956f914390aafd4fcbd9cfbe42aded3c2e507d52a5192ff13267d8a7

See more details on using hashes here.

Provenance

The following attestation bundles were made for shortform_ai-0.1.7-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