Skip to content

Say what podcli actually does, and report the real clips path#70

Merged
nmbrthirteen merged 1 commit into
mainfrom
docs/expand-feature-bullets
Jul 8, 2026
Merged

Say what podcli actually does, and report the real clips path#70
nmbrthirteen merged 1 commit into
mainfrom
docs/expand-feature-bullets

Conversation

@nmbrthirteen

@nmbrthirteen nmbrthirteen commented Jul 8, 2026

Copy link
Copy Markdown
Owner

Follow-up to #69, which squash-merged before this commit landed on it.

The feature list undersold the project

"What you get" named six things. The repo ships considerably more, none of it mentioned: an asset library with intros, outros, and background music; AssemblyAI as an alternative engine; yt-dlp URL import; laughter detection for highlight reels; transcript corrections; the ⌘K command palette; the thumbnail and content studios; YouTube analytics; DaVinci FCPXML export; multi-segment cuts; audio normalization; presets; duplicate detection.

Everything is enumerated from source (26 server.tool registrations, 12 studio routes) and grouped into clips, finding the moments, the studio, and shipping. The tool count is stated as 26, which check-docs-drift.mjs verifies against the call sites, so it cannot rot silently the way "22 tools" did.

doctor reported the wrong clips path

It printed cwd/podcli-clips unconditionally, even with PODCLI_OUTPUT set, so anyone using the override was told the wrong directory. The backend has always honored the variable (backend/config/paths.py:47); only the report was wrong.

PODCLI_OUTPUT=/tmp/fixed-clips  ->  clips: /tmp/fixed-clips  (PODCLI_OUTPUT)
unset                           ->  clips: /tmp/podcli-clips (working directory)

This touches cli/, so it reaches users on the next tag.

Clips are per-directory on purpose

Verified against the released 2.4.2 binary from two working directories: renders go to ./podcli-clips each time, while the managed home stays constant. Knowledge, presets, assets, history, and cache are unified and follow you between directories; only renders are per-show. engine.go:197 states the intent. The README now says it outright, since the split reads like an oversight otherwise.

Verification

check-docs-drift.mjs clean, go build / vet / test clean, both doctor branches exercised, zero em or en dashes.

Summary by CodeRabbit

  • Documentation

    • Expanded the quick start and overview to clarify where clips are saved and how persistent app state is managed.
    • Reworked the feature overview into clearer sections with more detailed descriptions of clipping, moment-finding, studio tools, and publishing workflows.
  • Bug Fixes

    • Updated the diagnostic output to correctly show the configured clip destination when a custom output path is set.

The "What you get" list named six things. The repo ships considerably more: an
asset library with intros, outros, and music; AssemblyAI as an alternative engine;
yt-dlp URL import; laughter detection for highlight reels; transcript corrections;
a command palette; thumbnail and content studios; YouTube analytics; DaVinci
FCPXML export. Grouped into clips, finding the moments, the studio, and shipping.

The tool count is stated as 26, which check-docs-drift.mjs verifies against
server.tool call sites, so this claim cannot rot silently the way "22 tools" did.

`doctor` printed cwd/podcli-clips unconditionally, even with PODCLI_OUTPUT set, so
it misreported where renders land for anyone using the override. The backend has
always honored the variable; only the report was wrong.

Clips are per-directory by design: each show keeps its own renders while knowledge,
presets, assets, history, and cache live in one managed folder. The README now says
that outright, since the split is easy to mistake for an oversight.
@nmbrthirteen nmbrthirteen merged commit ba3b825 into main Jul 8, 2026
5 of 6 checks passed
@nmbrthirteen nmbrthirteen deleted the docs/expand-feature-bullets branch July 8, 2026 11:07
@coderabbitai

coderabbitai Bot commented Jul 8, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 52ec1f37-5d10-4d91-ac8d-738789c4467c

📥 Commits

Reviewing files that changed from the base of the PR and between c8bc327 and d1e0901.

📒 Files selected for processing (2)
  • README.md
  • cli/main.go

📝 Walkthrough

Walkthrough

This PR documents a new PODCLI_OUTPUT environment variable in the README and updates the CLI's doctor() command to report the configured output path when set, falling back to the working directory's podcli-clips folder otherwise. The README's feature overview is also reorganized into categorized subsections.

Changes

PODCLI_OUTPUT Support

Layer / File(s) Summary
doctor() output path logic
cli/main.go
doctor() conditionally reports the clips path: uses PODCLI_OUTPUT value if set, otherwise falls back to cwd/podcli-clips.
README documentation updates
README.md
Overview text clarifies clip rendering location versus persistent managed state and introduces PODCLI_OUTPUT; "What you get" section is restructured into detailed subsections (Clips, Finding the moments, The studio, Shipping it).

Estimated code review effort: 1 (Trivial) | ~5 minutes

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/expand-feature-bullets

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 golangci-lint (2.12.2)

level=error msg="[linters_context] typechecking error: pattern ./...: directory prefix . does not contain main module or its selected dependencies"


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant