Skip to content

Latest commit

 

History

History
64 lines (41 loc) · 1.37 KB

README.md

File metadata and controls

64 lines (41 loc) · 1.37 KB
Raw

SavedFile Utility

The savedfile utility is a CLI tool for managing files in a database.

Usage example

Installation

This project requires Rust to be installed. After ensuring that Rust is installed, you can install the project by running the appropriate script for your system:

On Unix-like systems:

./install.sh

On Windows:

install.bat

Usage

The savedfile utility is primarily used through three subcommands: from, use, and remove.

From

The from subcommand is used to save a file to the database.

savedfile from <file> --named <name> [--version <version>]
  • --named: What to name the provided file in the database. This argument is required.
  • --version: The version of a file to use.

Use

The use subcommand retrieves a file from the database.

savedfile use <name> [--save <local_name>] [--output] [--version <version>]
  • --save: What to save the file as locally.
  • --output: Copy the file instead of creating a link to it.
  • --version: The version of a file to use.

Remove

The remove subcommand removes a file from the database.

savedfile remove <name> [--version <version>]
  • --version: The version of a file to use.

List

The list subcommand lists all files or specific file if a name is provided in the database.

savedfile list <name>