Skip to content

5. Command‐line

Aetherinox edited this page Oct 23, 2023 · 6 revisions

Outline




Options

A list of options available to use with the Proteus Command-line.


Main

This section explains the Proteus command-line in depth, along with a list of available options that can be used when calling the CLI.

Option Name Desc
-d, --dev Dev Mode
Specialized list of apps will appear instead of the installable list.
Also displays debugging prints.

-h, --help Help
Display command help

-i, --install Install
Installs one or multiple apps via command-line instead of launching the gui.

e.g.: ./proteus.sh -i curl -i "Github Desktop"

-n, --nullrun Dev: Null Run
Any of the installable applications selected will do a "fake" / null install. No actual install will take place.

Only works without -d

-q, --quiet Quiet
All logging will be disabled

-s, --setup Setup
Install all Proteus prerequisites / dependencies

-t, --theme [THEME] Theme
Switches the theme that the interface uses.

Adwaita, Adwaita-dark, HighContrast, HighContrastInverse, ZorinBlue-Light ^1, ZorinBlue-Dark ^1

-v, --version Version
Version information


Sub

Option Desc Choices
--njs-ver
Specifies the version of NodeJS to install.
Required when using -i NodeJS

16, 18, 20
--php-ver
Specifies the version of PHP to install.
Required when using -i PHP

php7.3, php7.3-fpm, php7.4, php7.4-fpm, php8.1, php8.1-fpm, php8.2, php8.2-fpm



Examples

A list of examples to demonstrate the functionality of the command-line.


Show CLI Help

Display all the command-line options available

proteus -h

Show Version

Display Proteus version information

proteus -v

Run Setup

Install all Proteus prerequisites / dependencies and then exists.

proteus -s

Launch Proteus (White Theme)

Launche Proteus with a white theme

proteus -t Adwaita

Install App

Install a single app

proteus -i appname1

Install Multiple Apps

Install multiple apps

proteus -i appname1 -i appname1 -i appname1

Install NodeJS (Specified Version)

Install NodeJS with the specified version v16

proteus -i nodejs --njs-ver 16

Install PHP (Specified Version)

Install PHP with the specified version v8.2

Available --php-ver options:

  • php7.3
  • php7.3-fpm
  • php7.4
  • php7.4-fpm
  • php8.1
  • php8.1-fpm
  • php8.2
  • php8.2-fpm)
proteus -i php --php-ver 8.2



Footnotes

^1: Only available if using ZorinOS