CLI Actions

Here we will give you the information you need work with actions in the FRAPI CLI. Below are a list of valid arguments along with the options they accept and an example of each.

Add action

Add a new action to the system.

Example: $ ./frapi.php add action --name=Test1 --enabled --public --route="/test1/:var" --description="This is a test." --parameters="param1,param2" --required-parameters="param3"

Option Required Description
--name|-n Yes The name of the action to create.
--enabled|-e No Pass this option when the action being created is enabled.
--public|-p No Pass this option when the action being created is public (accessible without a username or password).
--route|-r Yes The route of the action to create
--description|-d No The description of the action being created.
--parameters|--pa No List of comma seperated optional parameters for the action being created.
--required-parameters|-rp No List of comma seperated required parameters for the action being created.

Delete action

Delete an action from the system.

Example: $ ./frapi.php delete action --name=Test1

Option Required Description
--name|-n Yes Name of the action to delete.

List actions

List all the actions in the system and their details.

Example: $ ./frapi.php list actions

Sync actions

Sync the defined actions with the code base. Creating new files for actions as necessary.

Example: $ ./frapi.php sync actions