XIBLEDOCS

Control your XIBLE installation.

Parameters

All commands mentioned on this page have the following parameters available to them;

name description
--config The XIBLE configuration file to use. Defaults to ~./xible/config.json. The file is automatically created with defaults by XIBLE if it does not exist yet.

Changes

version availability
>= 0.0.2 General availability.

Synopsis

xible <context> <command>
[--config=<config>]

xible flow delete <name>

Removes the installed flow by the given name.

Prerequisites

  • The given flow name must exist as a flow in the XIBLE installation.
  • A XIBLE instance on the specified config must be running.

Parameters

name description
name The name of the flow in your XIBLE installation.
--force If not provided, a warning is thrown and the flow is not deleted.

Changes

version availability
>= 0.7.0 General availability. (#18)

Synopsis

xible flow delete
<name>
[--force]

xible flow start <name>

Creates and starts a new instance on the installed flow by the given name.

Prerequisites

  • The given flow name must exist as a flow in the XIBLE installation.
  • A XIBLE instance on the specified config must be running.

Parameters

name description
name The name of the flow in your XIBLE installation.
--params A JSON object of which the key-value pairs will be available for use in the flow.

Changes

version availability
>= 0.7.0 General availability. (#18)
>= 0.10.0
  • Added --params parameter. (#45)
  • Creates a new instance when called, instead of (re)-starting a single flow. (#46)

Synopsis

xible flow start
<name>
[--params=<params>]

xible flow stop <name>

Stops all running instances on the installed flow by the given name. If the flow is not running, nothing happens.

Prerequisites

  • The given flow name must exist as a flow in the XIBLE installation.
  • A XIBLE instance on the specified config must be running.

Parameters

name description
name The name of the flow in your XIBLE installation.

Changes

version availability
>= 0.7.0 General availability. (#18)

Synopsis

xible flow stop
<name>

xible server start

Starts the XIBLE server directly on the command line in the foreground.

Any running services will not be stopped. If a XIBLE service is already running in the background with the same configuration, running this command will result in an error because it cannot bind on the same port.

Changes

version availability
>= 0.0.2 General availability.

Synopsis

xible server start

xible server stop

Stops a running XIBLE server.

Prerequisites

  • A XIBLE instance on the specified config must be running.

Changes

version availability
>= 0.13.0 General availability.

Synopsis

xible server stop

xible service disable

Disables the systemd service if it was installed and enabled. XIBLE will no longer automatically start at boot after running this command.

Prerequisites

  • XIBLE must be installed on Linux.
  • A XIBLE service must be installed.
  • Must be run through sudo.

Changes

version availability
>= 0.4.0 General availability.

Synopsis

xible service disable

xible service enable

Performs the same actions as xible server install, and in addition enables the service to automatically start at boot.

Prerequisites

  • XIBLE must be installed on Linux.
  • Must be run through sudo.

Parameters

See xible service install

Changes

version availability
>= 0.4.0 General availability.

Synopsis

xible service enable
[--user=<user>]
[--group=<group>]

xible service install

Installs the server in the systemd system and service manager. As a result, this functionality is not available on Windows yet.

Prerequisites

  • XIBLE must be installed on Linux.
  • Must be run through sudo.

Parameters

option description
--user The user on which this service runs. Defaults to the SUDO_USER environment variable, or 'root' if that variable is not available.
--group The group on which this service runs. Defaults to the SUDO_USER environment variable, or 'root' if that variable is not available.

Changes

version availability
>= 0.4.0 General availability.

Synopsis

xible service install
[--user=<user>]
[--group=<group>]

xible service remove

Removes the systemd service. You will need to run either xible service enable or xible service install if you want to make the service commands available again after this.

Prerequisites

  • XIBLE must be installed on Linux.
  • A XIBLE service must be installed.
  • Must be run through sudo.

Changes

version availability
>= 0.4.0 General availability.

Synopsis

xible service remove

xible service start

Starts the XIBLE service if it was installed.

Prerequisites

  • XIBLE must be installed on Linux.
  • A XIBLE service must be installed.
  • Must be run through sudo.

Changes

version availability
>= 0.4.0 General availability.

Synopsis

xible service start

xible service status

Retrieves the status of the XIBLE service, if any. Returns either 'active', 'inactive' or 'unknown'.

Prerequisites

  • XIBLE must be installed on Linux.

Changes

version availability
>= 0.4.0 General availability.

Synopsis

xible service status

xible service stop

Stops the XIBLE service if it was installed.

Prerequisites

  • XIBLE must be installed on Linux.
  • A XIBLE service must be installed.
  • Must be run through sudo.

Changes

version availability
>= 0.4.0 General availability.

Synopsis

xible service stop