Skip to content

Commit

Permalink
add CLI to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
timkpaine committed Sep 12, 2020
1 parent ff92e90 commit da59612
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -534,7 +534,29 @@ strategies =
```

We can run this configuration by running:
`aat myconfig.cfg`
`aat --config myconfig.cfg`

We can also run via CLI:

```bash
usage: __main__.py [-h] [--config CONFIG] [--verbose]
[--trading_type {live,simulation,sandbox,backtest}]
[--strategies STRATEGIES [STRATEGIES ...]]
[--exchanges EXCHANGES [EXCHANGES ...]]

optional arguments:
-h, --help show this help message and exit
--config CONFIG Config file
--verbose Run in verbose mode
--trading_type {live,simulation,sandbox,backtest}
Trading Type in ("live", "sandbox", "simulation",
"backtest")
--strategies STRATEGIES [STRATEGIES ...]
Strategies to run in form
<path.to.module:Class,args,for,strat>
--exchanges EXCHANGES [EXCHANGES ...]
Exchanges to run on
```
### Trading Type
There are several values for the `TradingType` field:
Expand Down

0 comments on commit da59612

Please sign in to comment.