Skip to content

Commit ed1d450

Browse files
committed
Update documentation for create-userdir util
1 parent 41494f2 commit ed1d450

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

.coveragerc

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
[run]
22
omit =
33
scripts/*
4+
freqtrade/templates/*
45
freqtrade/vendor/*
56
freqtrade/__main__.py
67
tests/*

docs/utils.md

+35
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,41 @@
22

33
Besides the Live-Trade and Dry-Run run modes, the `backtesting`, `edge` and `hyperopt` optimization subcommands, and the `download-data` subcommand which prepares historical data, the bot contains a number of utility subcommands. They are described in this section.
44

5+
## Create userdir
6+
7+
Creates the directory structure to hold your files for freqtrade.
8+
Will also create strategy and hyperopt examples for you to get started.
9+
Can be used multiple times - using `--reset` will reset the sample strategy and hyperopt files to their default state.
10+
11+
```
12+
usage: freqtrade create-userdir [-h] [--userdir PATH] [--reset]
13+
14+
optional arguments:
15+
-h, --help show this help message and exit
16+
--userdir PATH, --user-data-dir PATH
17+
Path to userdata directory.
18+
--reset Reset sample files to their original state.
19+
```
20+
21+
!!! Warning
22+
Using `--reset` may result in loss of data, since this will overwrite all sample files without asking again.
23+
24+
```
25+
├── backtest_results
26+
├── data
27+
├── hyperopt_results
28+
├── hyperopts
29+
│   ├── sample_hyperopt_advanced.py
30+
│   ├── sample_hyperopt_loss.py
31+
│   └── sample_hyperopt.py
32+
├── notebooks
33+
│   └── strategy_analysis_example.ipynb
34+
├── plot
35+
└── strategies
36+
└── sample_strategy.py
37+
```
38+
39+
540
## List Exchanges
641

742
Use the `list-exchanges` subcommand to see the exchanges available for the bot.

0 commit comments

Comments
 (0)