diff --git a/README.md b/README.md index 1c7f80b89..b9497fcce 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/cmd/trade.go b/cmd/trade.go index cf04f4cdc..34d42fd0d 100644 --- a/cmd/trade.go +++ b/cmd/trade.go @@ -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", diff --git a/examples/walkthroughs/trader/balanced.md b/examples/walkthroughs/trader/balanced.md index 15cf3943f..0b85aea87 100644 --- a/examples/walkthroughs/trader/balanced.md +++ b/examples/walkthroughs/trader/balanced.md @@ -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 diff --git a/examples/walkthroughs/trader/buysell.md b/examples/walkthroughs/trader/buysell.md index 8234dd443..1c48a385e 100644 --- a/examples/walkthroughs/trader/buysell.md +++ b/examples/walkthroughs/trader/buysell.md @@ -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 diff --git a/examples/walkthroughs/trader/sell.md b/examples/walkthroughs/trader/sell.md index a052c3094..7244f959e 100644 --- a/examples/walkthroughs/trader/sell.md +++ b/examples/walkthroughs/trader/sell.md @@ -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