diff --git a/README.md b/README.md index ff6fb206aeb0a626b9a1216aa516a4e5de499e3b..70353d0ebf609fab599bc2b1018df0330f983eb3 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,47 @@ curl -L "https://dev.funkwhale.audio/funkwhale/cli/-/jobs/artifacts/master/raw/f # Usage -``funkwhale --help`` +```bash +# get help +funkwhale --help + +# get help on a specific command +funkwhale tracks ls --help + +# get login +funkwhale -H https://demo.funkwhale.audio login # credentials are demo and demo on this server + +# Store the server URL to avoid specifying it on the CLI +echo "FUNKWHALE_SERVER_URL=https://demo.funkwhale.audio" >> .env + +# Create a library +funkwhale libraries create --visibility=me + +# Upload some content to the server +funkwhale uploads create <library_id> ~/Music/**/*.mp3 + +# Search some tracks +funkwhale tracks ls jekk + +# Download a track to the ~/Music directory +funkwhale tracks download -d ~/Music <track_id> + + +# Download a track and customize the target directory +funkwhale tracks download -d ~/Music -t "{artist}/{album} ({year})/{title}.{extension}" <track_id> + +# Download all tracks matching a search, in ogg format +funkwhale tracks ls jekk --ids --limit 0 | xargs funkwhale tracks download -f ogg -d ~/Music + +# Download a track and pipe the output directly to VLC +funkwhale tracks download <track_id> | vlc + +# Delete your library +funkwhale libraries rm <library_id> + +# Logout +funkwhale logout +``` # Installation (from source)