Command Line Interface (CLI)

Fenix 3 ships with a native command line interface. The very first time Fenix is opened, it may prompt for permissions to create a global link to this utility. This allows users to type fenix in the terminal to manage the environment.

The following screenshot depicts what happens when executing the fenix command (or fenix help).

Feedback from users of the fenix-cli npm utility (available in the older Fenix 2 release) indicated most people prefer to use the command line utility for rapid experimentation. The Fenix 3 command line utility supports this effort by utilizing default functionality only. For example, it is possible to share/unshare from the command line, but it is not possible to manage the details of a server configuration. While most users prefer to manage configuration details through the graphical user interface, the Fenix API provides a way to control the fine details of Fenix programmatically.

Command Reference

fenix list

This command can also be invoked as fenix ls.

This command lists all of the servers currently registered in Fenix.

Example Output:

fenix create

The command line utility is designed as a "rapid fire" tool, allowing developers to quickly fire up new servers.

fenix start

It is possible to start a server by name, port, or web root (directory). If no option is specified, Fenix attempts to start a server whose webroot matches the current working directory.

Fenix attempts to start the server whose webroot is /tmp/demo_site.

The command above is the equivalent of fenix start /tmp/demo_site. If more than one server is using the specified directory as a web root, the tool will ask which servers should be started.

Start by Port

To start a server on a given port, use the syntax fenix start <port>, such as fenix start 8003.

Start by Name

To start a server by its name, use the syntax fenix start <name>, such as fenix start my_site. If the name has spaces or special characters, use double quotes to encapsulate the name, such as fenix start "My Site".

fenix stop

The stop command mirrors the start, meaning it is possible to stop by name, port, or web root (directory).

Stop by Port

To stop a server on a given port, use the syntax fenix stop <port>, such as fenix stop 8003.

Stop by Name

To stop a server by its name, use the syntax fenix stop <name>, such as fenix stop my_site. If the name has spaces or special characters, use double quotes to encapsulate the name, such as fenix stop "My Site".

fenix status

The status command mirrors the start/stop commands, meaning it is possible to stop by name, port, or web root (directory). If no name/port/web root is specified, all server statuses are displayed.

fenix share

Fenix can share one or more servers directly, at the same time. Similar to start/stop/status, it is possible to specify a name/port/web root (directory). If the command line can't determine which server to share, it provides a list.

If a request is made to share an "offline" server, it is first started then shared.

fenix unshare

This command accepts the same arguments and works the same way share does except it stops sharing the specified site(s).

fenix remove

This command removes the specified server. The remove command arguments mirror those of the start/stop commands, meaning it is possible to open by name, port, or web root (directory). If the command line utility cannot determine which server to remove, it will prompt with a selectable list of servers that could be removed.

fenix open

This command opens the default web browser and loads the URL of the specified server. The open command arguments mirror those of the start/stop commands, meaning it is possible to open by name, port, or web root (directory).

fenix quit

This command will close the Fenix application.

results matching ""

    No results matching ""