quark-cli

Quark CLI

A work-in-progress command line interface app for Quark.

• Overview
• Installation
  • Windows (using Chocolatey, recommended)
  • Linux (using install script, recommended)
  • Pre-built binaries
  • Using Go
• Contributing
• License

Overview

A lovely command-line interface made for Quark. Quark command-line allows you to quickly create short links, share your code and share files without leaving your terminal.

• Free. Quark is not only free to use on the official instance but is also free to download and run for yourself.
• Open Source. All of Quark's source code is available here for the community to take a look under the hood. We also accept community contributions, just open a pull request!
• Multi-purpose. Unlike other mainstream URL shorteners, Quark also provides file sharing and a pastebin also with short links.

Installation

There are many different ways that Quark is distributed, Chocolatey is the preferred ways of installation as it provides easy updating, whereas if you use one of the binaries you will need to update manually.

Windows (using Chocolatey, recommended)

The best way for insalling Quark CLI on Windows is by using Chocolatey.

Please note Chocolatey packages are only published on minor versions, not patches.

Firstly, install Chocolatey, if you haven't already, by reading the guide here. Now, you can install the CLI by running:

choco install quark-cli

And upgrade using:

choco upgrade quark-cli

Linux (using install script, recommended)

Install script coming soon...

Pre-built binaries

If you'd rather not use Chocolatey, pre-built binaries are available on GitHub Releases. These are portable and can be run through your command line without installation or administrator privileges. They are built for most popular operating systems and architectures.

Using Go

If you have Go installed, you can clone this repository and run the following to install Quark CLI on to your system.

go install

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please run tests and style checking before committing.

License

This project is licensed under the MIT License - see the license file for details.