Documentation

About Installation File Format

Installation

Star should be installed via source. To do that, you need to install the crystal compiler.

There are 2 ways to install star via source:

1. Easy-install script

$ curl https://git.io/star-install | sudo bash

2. Git clone

$ git clone https://github.com/cbrnrd/star && cd star
$ make install

CLI

Star CLI is written in Crystal, so it's compiled. Star CLI is the only officially supported way to use starfiles, but others can create libraries and CLI programs in other languages.

Star CLI supports the following starfile features:

• Multithreaded file extraction
• File combining
• Hash verification

$ ./star -h
  star - The Stupid Archive format

  star v0.2.2

  Usage:
    star [command] [flags] [arguments]

  Commands:
    combine <star file> [file1 file2 ...]   Combines the files into a .star file.
    extract [opts] <star file> [outfile]    Extracts all files
    help [command]                          Help about any command.
    verify                                  Verify the archive.
    version                                 Show the star program version

  Flags:
    -h, --help      Help for this command. default: 'false'.
        --verbose   Run with verbose output. default: 'false'.