ping: @rdswift, since you were interested.

One other thing... Would you mind adding yourself to the about_picard/acknowledgements.rst file? Thanks.

@skelly37: I submitted PR https://github.com/skelly37/picard-docs/pull/1 against your branch to add a new page that generally explains the way that Picard starts up. That way all the related changes will appear together on the same PR when merging into the master documentation branch.

Excellent, thanks!

Should we include a warning about the pipe error we’re leaving unsolved for now? i.e. unexitable Picard after removing the pipe file manually on Unix.

I think we need an additional appendix documenting the new mbid://.

Basically it's:

mbid://<entity-type>/<mbid>

I think we need an additional appendix documenting the new mbid://.

Depending on what other actions will be able to be initiated from the command line, it likely requires a separate section on "Using Picard from the Command Line" or "Batch Processing with Picard". I'm not sure an appendix is the right place for this. I'm thinking more as a new page under the "Using Picard" section.

I'll leave a TODO list later to sum up what still has to be done

TODO:

• allowed URIs (positional arguments)
• list of commands
• re-read the diff to see if it is still up to date

@rdswift I can write most (if not all) of it but I'm bad at .rst. My idea is that I will send you my notes in markdown, e.g. via e-mail, and you will (kindly please :) ) help me with proper formatting

@rdswift I can write most (if not all) of it but I'm bad at .rst. My idea is that I will send you my notes in markdown, e.g. via e-mail, and you will (kindly please :) ) help me with proper formatting

That's fine with me. I appreciate whatever you can provide in terms of description of the new functionality. Thanks.

Positional arguments documentation:

In Picard one can pass 3 types of positional arguments:

• file:
  • relative path: will be auto-converted to an absolute path, where the current working directory is this path's parent
  • absolute path
  • file:// URI
• supported URL (the same ones that work for drag'n'drop in GUI mode)
  • http:// URI
  • https:// URI
• MBID URI
  • mbid://<entity-type>/<mbid>
  • Examples:
    • mbid://release/dbd0ce67-cae6-33eb-8f5a-1143a30c2353
    • mbid://artist/83d91898-7763-47d7-b03b-b92132375c47

Remote commands

General

• Picard remote process handling consists of 2 steps:
  1. It tries to pass commands to execute to an existing instance,
  2. If the commands were not received, it starts a new app that will process the command pipeline.
• Commands are case-insensitive.
• Commands are processed in the order they were provided.

Usage

picard -e <command> <arg(s)>

List of available commands

• CLEAR_LOGS
  Clear the Picard logs.

• CLUSTER
  Cluster all files in the cluster pane.

• FINGERPRINT
  Calculate acoustic fingerprints for all (matched) files in the album pane.

• FROM_FILE <absolute path>
  Load command pipeline from the provided absolute path.

  • #-prefixed comments are accepted.
  • 1 line per 1 command, a single line should contain as much as single picard -e <command> <argstring> call.

• LOAD <MBID/URL/absolute path(s)>
  Load one or more provided arguments to Picard.

  • Basically an equivalent of the positional arguments but it can be placed:
    • anywhere in the picard call,
    • in the command pipeline files.
  • NOTE: LOAD does not support passing remote commands.

• LOOKUP
  Lookup all clusters in the cluster pane.

• LOOKUP_CD <device/log file>
  Read CD from the selected drive and lookup on MusicBrainz.
  Without argument, it defaults to the first (alphabetically) available disc drive.

• QUIT
  Exit the running instance of Picard.

• REMOVE <absolute path to 1 or more files>
  Remove the file from Picard. Do nothing if no arguments provided.

• REMOVE_ALL
  Remove all files form Picard.

• REMOVE_EMPTY
  Remove all empty clusters and albums.

• REMOVE_SAVED
  Remove all saved releases from the album pane.

• REMOVE_UNCLUSTERED
  Remove all unclustered files from the cluster pane.

• SAVE_MATCHHED
  Save all matched releases from the album pane.

• SAVE_MODIFIED
  Save all modified files from the album pane.

• SCAN
  Scan all files in the cluster pane.

• SHOW
  Make the running Picard instance the currently active window.

• SUBMIT_FINGERPRINTS
  Submit outstanding acoustic fingerprints for all (matched) files in the album pane.

• WRITE_LOGS <path>
  Save logs with the current verbosity level to the file passed as an argument.

• LOOKUP
  Lookup all clusters in the cluster pane.

Note that this has been changed in metabrainz/picard#2167

@rdswift Apologies for the response delay. I’d suggest to go with the second option, as you’d have full control over the branch. Let me know when to close this PR, thanks in advance.

This PR has been combined into #178