Skip to content

Latest commit

 

History

History
134 lines (94 loc) · 2.36 KB

README.md

File metadata and controls

134 lines (94 loc) · 2.36 KB
Raw
Logo

scm-cli

scm-cli is a terminal client for downloading BRSTM files from Smash Custom Music Archive (smashcustommusic.net)
© RekuBuild 2024

Table of Contents

Features

  • Supports Linux and macOS only. For Windows, use scm-py.
  • Search for games by name.
  • List all available games and their corresponding IDs.
  • Search for songs by game ID.
  • Download BRSTM (or other) files by song ID.
  • Specify output path for downloads.

Screenshots

Screenshot

Requirements

  • jq is required for JSON parsing. (When ran, scm-cli will automatically check for jq and prompt to install if not found.)

Installation

Method 1 - nv (Recommended)

Note - This method only works on Debian-based systems (like Ubuntu). For any other Linux distro or macOS, use Method 2.


Install nv with it's installer command if not already:

curl -sSL https://raw.githubusercontent.com/RekuNote/nv/main/install.sh | sudo bash

Install scm-cli with nv:

sudo nv update && sudo nv install scm-cli

Running the program:

scm-cli

Method 2 - scm-cli installer script


Run the install command:

curl -sL https://raw.githubusercontent.com/RekuNote/scm-cli/main/install.sh | bash

Running the program:

scm-cli

Method 3 - Running scm-cli portably

If neither Method 1 or 2 work, you can run scm-cli portably by:


Downloading the scm-cli file Allowing execute permissions:

chmod +x scm-cli

Running the program:

./scm-cli

Usage

Run scm-cli:

scm-cli

Options

  • -u, --update Checks for updates

Examples

  • Run scm-cli normally:
scm-cli
  • Update to the latest version:
scm-cli --update

License

This project is licensed under a modified version of the MIT License.