Skip to content

Fix cog templates to generate correct command name in docs and rewrite README#45

Merged
crossjam merged 4 commits intocorrect-cli-docs-titlefrom
copilot/fix-cog-text-in-docs
Jan 21, 2026
Merged

Fix cog templates to generate correct command name in docs and rewrite README#45
crossjam merged 4 commits intocorrect-cli-docs-titlefrom
copilot/fix-cog-text-in-docs

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 21, 2026

Generated documentation showed Usage: cli instead of Usage: scrobbledb in all command help text.

Changes

  • Updated 42 cog invocations across 15 doc files to pass prog_name='scrobbledb' to CliRunner.invoke()
  • Regenerated all docs via poe docs:cli
  • Completely rewrote README.md with comprehensive documentation

Technical Detail

Click's CliRunner.invoke() defaults to using the function name as the program name. The fix:

# Before
result = runner.invoke(cli, ["auth", "--help"])

# After  
result = runner.invoke(cli, ["auth", "--help"], prog_name='scrobbledb')

This changes the generated output from:

Usage: cli auth [OPTIONS]

To:

Usage: scrobbledb auth [OPTIONS]

README.md Rewrite

Expanded the minimal 17-line README into a comprehensive 240+ line document that includes:

  • About Last.fm and Scrobbling: Detailed explanation of Last.fm, scrobbling, and the Last.fm API
  • Why scrobbledb?: Clear value proposition (local backup, advanced queries, data portability, privacy)
  • Origin: Credits Jacob Kaplan-Moss for the original lastfm-to-sqlite project
  • Installation & Quick Start: Step-by-step setup and usage instructions
  • Command Overview: All 15 commands organized by category with links to detailed documentation
  • Example Workflows: Real-world usage examples for backup, analysis, and export
  • Database Schema: Overview of the SQLite structure
  • License: Notes Apache License 2.0 for both scrobbledb and the original project
  • Links: Resources for Last.fm API, Libre.fm, and related projects
Original prompt

All of the generated docs show 'cli' at the top. That should be 'scrobbledb'. Please fix the cog text in each doc, then rerun the doc generation Poe task.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits January 21, 2026 19:50
Co-authored-by: crossjam <208062+crossjam@users.noreply.github.com>
Co-authored-by: crossjam <208062+crossjam@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix 'cli' text to 'scrobbledb' in generated docs Fix cog templates to generate correct command name in docs Jan 21, 2026
Copilot AI requested a review from crossjam January 21, 2026 19:52
@crossjam
Copy link
Copy Markdown
Owner

@copilot rewrite README.md to reflect the current state of the application. Provide a summary overview of last.fm, scrobbling, and the last.fm api. Summarize the top level commands and point to documentation as needed.

If it makes sense revise and keep the current README.md text. Be sure to credit the original author and make sure there's a note reflecting the current open source license.

Co-authored-by: crossjam <208062+crossjam@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Jan 21, 2026

@copilot rewrite README.md to reflect the current state of the application. Provide a summary overview of last.fm, scrobbling, and the last.fm api. Summarize the top level commands and point to docume...

Rewrote README.md with comprehensive content (commit 1a4e13f):

  • Added detailed explanations of Last.fm, scrobbling, and the Last.fm API
  • Included "Why scrobbledb?" section highlighting key benefits
  • Credited Jacob Kaplan-Moss for the original lastfm-to-sqlite project
  • Added complete installation and quick start guide
  • Organized all commands by category with links to detailed documentation
  • Included example workflows for common use cases
  • Noted Apache License 2.0 for both this project and the original

The README is now comprehensive (240+ lines) while keeping the original's acknowledgment to Jacob Kaplan-Moss and maintaining clear links to the command documentation.

Copilot AI changed the title Fix cog templates to generate correct command name in docs Fix cog templates to generate correct command name in docs and rewrite README Jan 21, 2026
@crossjam crossjam marked this pull request as ready for review January 21, 2026 23:04
Copy link
Copy Markdown
Owner

@crossjam crossjam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Fire in the Disco!

@crossjam crossjam merged commit b60dc37 into correct-cli-docs-title Jan 21, 2026
6 checks passed
@crossjam crossjam deleted the copilot/fix-cog-text-in-docs branch January 21, 2026 23:08
crossjam added a commit that referenced this pull request Jan 21, 2026
* Fix cog templates to generate correct command name in docs and rewrite README (#45)

* Initial plan

* Update cog snippets in all doc files to use prog_name='scrobbledb'

Co-authored-by: crossjam <208062+crossjam@users.noreply.github.com>

* Regenerate docs with scrobbledb instead of cli

Co-authored-by: crossjam <208062+crossjam@users.noreply.github.com>

* Rewrite README.md with comprehensive overview and documentation

Co-authored-by: crossjam <208062+crossjam@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: crossjam <208062+crossjam@users.noreply.github.com>

Danger! Danger! High Voltage!

* Word wrapping, updating license information

---------

Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>

Danger! Danger! High Voltage!
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.

2 participants