cardinal-server-cli v0.1.0

cardinal-server-cli

Cardinal Server, in the command line.

This is the official CLI app for Cardinal Server. It offers all of the same core functionality that comes with the desktop release of Cardinal Server, but it does it in the command line.

Both the desktop and the CLI version of Cardinal Server work on macOS, Windows, and Linux. The CLI app can also run in any environment that can run Node.js, like your NAS or Raspberry Pi.

The CLI app is faster, more frequently updated, and far more lightweight than the desktop app, so if you're feeling a little adventerous, you should definitely try it out. It's actually super easy to use.

Installation

1. Install Node.js

You'll need Node.js to use the Cardinal Server CLI app. The easiest way to install Node.js is to download their installer and follow their instructions.

To verify it was installed correctly, you can check your Node.js version by opening a terminal and running:

node -v

2. Install the Cardinal Server CLI app

Node.js comes with a handy tool called npm. You can verify that it was installed by running:

npm -v

npm is used to install stuff that runs in Node.js. Use this command to install the Cardinal Server CLI app, using npm:

npm i -g https://github.com/CardinalApps/cardinal-server-cli.git

Tada! All done. You can verify that the Cardinal Server CLI installation was successful by running:

cardinal-server -V

Using the CLI app

Once installed, the first thing you should do is run the app like this:

cardinal-server

You'll be presented with the main help page. It explains in detail how to use the CLI app.

Uninstall

If you also want to remove all of your Cardinal media (database, cache, logs, etc), you should run this before uninstalling:

cardinal-server cleanup

To uninstall the CLI app, run:

npm uninstall -g cardinal-server-cli

License

Uses the GPLv3 software license.