beetbox / beetbox/beets

Rename the update command

Open
#703 1 comment 3 reactions 0 assignees View on GitHub
discussion update-command
Dominant language
Python
Stars
15.7k
Forks
2.1k
Avg merge
4d 21h
Merged PRs (30d)
31

Description

The `beet update` command name often (very often!) fools users into thinking that it performs a re-import or does what the mbsync plugin does. This is understandable: it sounds like it _updates_ the information from MusicBrainz.

I think it's time to rename the command. My current favorite name is `read`, since it's the opposite of the `write` command. Other suggestions have included `resync` and `refresh`.

We would of course keep `update` as an alias but leave that out of the documentation.

Contributor guide

Open the contributing guide

Research direction

Start by tracing the `beet update` command and its user-facing documentation. Decide on the replacement name from the suggestions, preserve `update` as an alias, and remove the old name from documentation once the behavior and naming are agreed.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.