Skip to content
This repository has been archived by the owner on Feb 1, 2024. It is now read-only.

Commit

Permalink
doc clarify full path needed for configs (#16)
Browse files Browse the repository at this point in the history
  • Loading branch information
Reidmcc authored and nikhilsaraf committed Oct 2, 2018
1 parent 9c62c80 commit 92324c3
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,13 +108,13 @@ These are the following commands available from the `kelp` binary:

The `trade` command has three parameters which are:

- **botConf**: _.cfg_ file with the account details, [sample file here](examples/configs/trader/sample_trader.cfg).
- **botConf**: full path to the _.cfg_ file with the account details, [sample file here](examples/configs/trader/sample_trader.cfg).
- **strategy**: the strategy you want to run (_sell_, _buysell_, _balanced_, _mirror_, _delete_).
- **stratConf**: _.cfg_ file specific to your chosen strategy, [sample files here](examples/configs/trader/).
- **stratConf**: full path to the _.cfg_ file specific to your chosen strategy, [sample files here](examples/configs/trader/).

Here's an example of how to start the trading bot with the _buysell_ strategy:

`kelp trade --botConf trader.cfg --strategy buysell --stratConf buysell.cfg`
`kelp trade --botConf ./path/trader.cfg --strategy buysell --stratConf ./path/buysell.cfg`

If you are ever stuck, just invoke the `kelp` binary directly or type `kelp help [command]` for help with a specific command.

Expand Down
4 changes: 2 additions & 2 deletions cmd/trade.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ import (
"github.com/stellar/go/support/config"
)

const tradeExamples = ` kelp trade --botConf trader.cfg --strategy buysell --stratConf buysell.cfg
kelp trade --botConf trader.cfg --strategy buysell --stratConf buysell.cfg --sim`
const tradeExamples = ` kelp trade --botConf ./path/trader.cfg --strategy buysell --stratConf ./path/buysell.cfg
kelp trade --botConf ./path/trader.cfg --strategy buysell --stratConf ./path/buysell.cfg --sim`

var tradeCmd = &cobra.Command{
Use: "trade",
Expand Down
2 changes: 1 addition & 1 deletion examples/walkthroughs/trader/balanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ The virtual balance combined with the actual balance the bot has in its account
Assuming your botConfig is called `trader.cfg` and your strategy config is called `balanced.cfg`, you can run `kelp` with the following command:

```
kelp trade --botConf trader.cfg --strategy balanced --stratConf balanced.cfg
kelp trade --botConf ./path/trader.cfg --strategy balanced --stratConf ./path/balanced.cfg
```

# Above and Beyond
Expand Down
2 changes: 1 addition & 1 deletion examples/walkthroughs/trader/buysell.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ A level defines a [layer](https://en.wikipedia.org/wiki/Layering_(finance)) that

Assuming your botConfig is called `trader.cfg` and your strategy config is called `buysell.cfg`, you can run `kelp` with the following command:
```
kelp trade --botConf trader.cfg --strategy buysell --stratConf buysell.cfg
kelp trade --botConf ./path/trader.cfg --strategy buysell --stratConf ./path/buysell.cfg
```

# Above and Beyond
Expand Down
2 changes: 1 addition & 1 deletion examples/walkthroughs/trader/sell.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ A level defines a [layer](https://en.wikipedia.org/wiki/Layering_(finance)) that
Assuming your botConfig is called `trader.cfg` and your strategy config is called `sell.cfg`, you can run `kelp` with the following command:

```
kelp trade --botConf trader.cfg --strategy sell --stratConf sell.cfg
kelp trade --botConf ./path/trader.cfg --strategy sell --stratConf ./path/sell.cfg
```

# Above and Beyond
Expand Down

0 comments on commit 92324c3

Please sign in to comment.