adelorenzo/stable
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

adapt docs/bot-usage to reflect changes

Browse Source
This commit is contained in:
gcarq 2018-03-25 16:39:31 +02:00
parent 6b47c39103
commit 7fe0ec5407
1 changed files with 10 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/bot-usage.md
View File

@ -26,9 +26,8 @@ optional arguments:
--version show program's version number and exit --version show program's version number and exit
-c PATH, --config PATH -c PATH, --config PATH
specify configuration file (default: config.json) specify configuration file (default: config.json)
-s PATH, --strategy PATH -s NAME, --strategy NAME
specify strategy file (default: specify strategy class name (default: DefaultStrategy)
freqtrade/strategy/default_strategy.py)
--dry-run-db Force dry run to use a local DB --dry-run-db Force dry run to use a local DB
"tradesv3.dry_run.sqlite" instead of memory DB. Work "tradesv3.dry_run.sqlite" instead of memory DB. Work
only if dry_run is enabled. only if dry_run is enabled.
@ -48,21 +47,19 @@ python3 ./freqtrade/main.py -c path/far/far/away/config.json
``` ```
### How to use --strategy? ### How to use --strategy?
This parameter will allow you to load your custom strategy file. Per This parameter will allow you to load your custom strategy class.
default without `--strategy` or `-s` the bot will load the Per default without `--strategy` or `-s` the bot will load the
`default_strategy` included with the bot (`freqtrade/strategy/default_strategy.py`). `DefaultStrategy` included with the bot (`freqtrade/strategy/default_strategy.py`).
The bot will search your strategy file into `user_data/strategies` and The bot will search your strategy file within `user_data/strategies` and `freqtrade/strategy`.
`freqtrade/strategy`.
To load a strategy, simply pass the file name (without .py) in this To load a strategy, simply pass the class name (e.g.: `CustomStrategy`) in this parameter.
parameters.
**Example:** **Example:**
In `user_data/strategies` you have a file `my_awesome_strategy.py` to In `user_data/strategies` you have a file `my_awesome_strategy.py` which has
load it: a strategy class called `AwesomeStrategy` to load it:
```bash ```bash
python3 ./freqtrade/main.py --strategy my_awesome_strategy python3 ./freqtrade/main.py --strategy AwesomeStrategy
``` ```
If the bot does not find your strategy file, it will display in an error If the bot does not find your strategy file, it will display in an error