To list all available FProxy CLI commands, open your terminal, and run fproxy help.
FProxy CLI commands
Table: FProxy CLI commands
| Command | Description | Syntax |
|---|---|---|
download | Download modification content (including associated templates and template defaults, if defined) from the Frosmo back end to your local file system. | fproxy download <site_directory> <modification_id|all> [--ws=<workspace_id>] [–debug] [--force] |
help | Display usage information for the FProxy CLI. If you want to display usage information for a specific FProxy CLI command, include the command as a parameter (for example, fproxy help init). | fproxy help [<command>] [--debug] |
init | Initialize a sites directory for a site. | fproxy init [--debug] |
prune | Clean up the FProxy configuration by removing the settings for deleted sites and site directories. | fproxy prune [--debug] |
server restart | Restart the FProxy server. Use this command if the server becomes slow, for example, after running continuously for days or weeks. | fproxy server restart [--polling=<refresh_ms>] [--debug] |
server start | Start the FProxy server. | fproxy server start [--polling=<refresh_ms>] [--debug] |
server status | Check whether the FProxy server is running or stopped. | fproxy server status [--polling=<refresh_ms>] [--debug] |
server stop | Stop the FProxy server. | fproxy server stop [--polling=<refresh_ms>] [--debug] |
upload | Upload modification content (including associated templates and template defaults, if defined) from your local file system to the Frosmo back end. | fproxy upload <site_directory> <modification_id> [--ws=<workspace_id>] [--debug] |
version | Display your FProxy version. | fproxy version [--debug] |
watch | Monitor for changes in your downloaded modification content, and automatically upload changed files to the Frosmo back end. | fproxy watch <site_directory> [--debug] |
FProxy CLI command parameters
Table: Optional parameters for the FProxy CLI commands
| Parameter | Description | Commands |
|---|---|---|
--debug | Display verbose debugging information. | All |
--force | Overwrite local content files without prompting. | fproxy download |
--polling=<refresh_ms> | Defines how often (in milliseconds) the FProxy server checks the Frosmo back end and the local file system for modification content changes when hot reloading is enabled. The default value is |
|
--ws=<workspace_id> | Download or upload modification content (including associated templates and template defaults, if defined) from or to a workspace. |
|
