chore: fixing outdated request-toolbox README

[KolevDarko]

Renamed 'yarn request-toolbox' to the new 'yarn cli' in the README examples.

Update:

• Added the troubleshooting trick from @yomarion.
• Replaced all examples to be with: yarn request-toolbox for consistency
• Explained that yarn cli also works

[benjlevesque]

request-toolbox is valid, but requires the package to be built

[coveralls]

Coverage: 87.342%. Remained the same when pulling 0a0c856 on chore/update-toolbox-docs into acce3ce on master.

[KolevDarko]

I had all sorts of trouble with it. I couldn't get it to run even after building

[yomarion]

I had all sorts of trouble with it. I couldn't get it to run even after building

I also had issues in the past but it is now working well. Not sure of this but: have you built the whole repo?

[KolevDarko]

I had all sorts of trouble with it. I couldn't get it to run even after building

I also had issues in the past but it is now working well. Not sure of this but: have you built the whole repo?

Yes, I built the whole repo. I actually cloned the full repo from scratch and it still didn't work, perhaps you guys have an older build cache or something and that's why it works for you?
I'm suspecting it's been removed recently, @MantisClone have you tried this recently?

[MantisClone]

• ✔️ I cloned and built a fresh repo. And successfully ran the toolbox with yarn cli.
• ❌ yarn request-toolbox and request-toolbox did not work after building the package. I believe it needs to be installed too.
• 🤔 I tried a few things (yarn & npm from a few different directories) but couldn't figure out how to install the locally built toolbox package.

mantisclone@mantisclone-Inspiron-7620:~/projects/requestNetwork-cli/packages/toolbox$ yarn request-toolbox
yarn run v1.22.19
error Command "request-toolbox" not found.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
mantisclone@mantisclone-Inspiron-7620:~/projects/requestNetwork-cli/packages/toolbox$ request-toolbox
request-toolbox: command not found
mantisclone@mantisclone-Inspiron-7620:~/projects/requestNetwork-cli/packages/toolbox$ yarn cli
yarn run v1.22.19
$ cross-env NODE_ENV=development ts-node src/cli.ts
request-toolbox <command>

Commands:
  request-toolbox addAggregator <network>   adds a single aggregator
  request-toolbox addAggregators <network>  loads all known aggregators and adds
                                            missing
  request-toolbox currencyHash              Shows the currency hash of a
  <currencyCode>                            currency code
  request-toolbox deleteAggregator          remove a single aggregator
  <network>
  request-toolbox getConversionPath <from>  Shows the conversion path between 2
  <to>                                      currencies
  request-toolbox listAggregators           Helper for on-chain conversion
  [network]                                 administration
  request-toolbox listMissingAggregators    list missing aggregators for a given
  <list>                                    currency list
  request-toolbox hash submit <ipfsHash>    Forces the submission of an IPFS
                                            hash to the Request HashStorage
                                            contract
  request-toolbox calculateReference        Calculates the payment reference
  <requestId> <salt> <address>              from requestId, salt and address
  request-toolbox request create [amount]   Create a test request
  request-toolbox nonce                     Gets a wallet nonce
  request-toolbox transaction retry         Retries sending a pending
  <txHash>                                  transaction stuck in the mempool

Options:
  --help  Show help                                                    [boolean]

Not enough non-option arguments: got 0, need at least 1
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
mantisclone@mantisclone-Inspiron-7620:~/projects/requestNetwork-cli/packages/toolbox$ yarn cli request create
yarn run v1.22.19
$ cross-env NODE_ENV=development ts-node src/cli.ts request create
Create request with amount 1000
connect ECONNREFUSED 127.0.0.1:3000
Done in 3.36s.

[yomarion]

@KolevDarko and @MantisClone

Try running yarn --check-files from the package root (maybe elsewhere works as well).

Need to document properly if this is correct, but:

$ yarn request-toolbox
# works
$ rm node_modules/.bin/request-toolbox
$ yarn request-toolbox
# error Command "request-toolbox" not found.
$ yarn --check-files
$ yarn request-toolbox
# works again

FYI, while playing around, I managed once to fix the issue with a simple yarn at the project root, but could not replicate.

Source: yarnpkg/yarn#3421
This seems to wrap it up:

Overall issue; Yarn should run the preinstall (and maybe other?) script(s) for each dependency before it tries to create the bin links for the dependency.

[yomarion]

Instead we should document how to fix the build / preinstall.

[KolevDarko]

yarn --check-files did the trick, I'll add a section in readme