Skip to content
No description, website, or topics provided.
Branch: dev
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
docs
src
.gitignore
Cargo.lock
Cargo.toml
LICENSE
README.org
todo.org

README.org

README

Funkwhale-Cli

Funkwhale-cli is a command line utility designed to interface with any funkwhale instance from the command line.

Installing

Linux

Debian / Ubuntu

  1. Grab the `.deb` package at https://github.com/RodrigoLeiteF/funkwhale-cli/releases/latest
  2. Install it with `dpkg -i funkwhale-cli-debian-x86_64.deb`

Arch

  1. Run `yay funkwhale-cli-git`

Other distributions

  1. Download the latest release at https://github.com/RodrigoLeiteF/funkwhale-cli/releases
  2. Run `chmod +x funkwhale-cli-linux-x86_64` to make it executable
  3. (Optional) Rename the binary with `mv funkwhale-cli-linux-x86_64 funkwhale-cli`
  4. (Optional) Move the binary to a directory in your PATH, so you can use it anywhere. `mv funkwhale-cli /usr/bin/funkwhale-cli`

Usage

  1. Download the latest release here
  2. Run the program :)

Examples

Uploading a file

funkwhale-cli upload -t ~/tokenfile -u https://music.leite.dev -l Default -f focus.mp3

Uploads the file `focus.mp3` to the library `Default` on `https://music.leite.dev` with the token file `~/tokenfile`

Authentication

For security reasons, funkwhale-cli uses a token file for authentication instead of command line options. To use any authenticated command, you will need to supply the path to one with the `-t` flag.

How to set up a token file

  1. Open your browser and press Ctrl + Shift + I to open the developer console
  2. Go to your instance and log in
  3. Paste the following in the console: JSON.parse(localStorage.getItem("auth")).auth.token
  4. Press enter
  5. Copy the output without the quotation marks, paste it on a file and save it
  6. Done! Now, whenever you need to be authenticated for a command, just use the option `-t /path/to/your/file`
You can’t perform that action at this time.