1
0
mirror of https://github.com/RSS-Bridge/rss-bridge.git synced 2025-08-01 14:20:16 +02:00

[CLI] Add new page

LogMANOriginal
2018-03-11 13:07:20 +01:00
parent b81804f5ee
commit d68cc9e018

@@ -0,0 +1,33 @@
RSS-Bridge supports the CLI of php. You can use the same parameters as you would normally use via the URI:
Example:
`php index.php action=display bridge=DansTonChat format=Json`
## Required parameters
RSS-Bridge requires a few parameters that must be specified on every call. Omitting these parameters will result in error messages:
### action
The `action` parameter specifies the action RSS-Bridge should take. Currently this parameter only supports the value `display` which causes RSS-Bridge to return the feed contents.
### bridge
This parameter specifies the name of the bridge RSS-Bridge should return feeds from. The name of the bridge equals the class name of the bridges in the ./bridges/ folder without the 'Bridge' prefix. For example: DansTonChatBridge => DansTonChat.
### format
This parameter specifies the format in which RSS-Bridge returns the contents. RSS-Bridge currently supports five formats: `Atom`, `Html`, `Json`, `Mrss`and `Plaintext`.
## Optional parameters
RSS-Bridge supports optional parameters. These parameters are only valid if the options have been enabled in the index.php script.
### _noproxy
This parameter is only available if a proxy server has been specified via `PROXY_URL` and 'PROXY_BYBRIDGE' has been enabled. This is a Boolean parameter that can be set to '1' (true) or '0' (false).
## Bridge parameters
Each bridge can specify its own set of parameters. As in the example above, some bridges don't specify any parameters or only optional parameters that can be neglected. For more details read the `PARAMETERS` definition for your bridge.