Skip to content
This repository has been archived by the owner on Jul 27, 2022. It is now read-only.

Problem: (CRO-300) No easy way to find client's environment variables #700

Merged
merged 1 commit into from
Dec 18, 2019
Merged

Problem: (CRO-300) No easy way to find client's environment variables #700

merged 1 commit into from
Dec 18, 2019

Conversation

devashishdxt
Copy link
Collaborator

@devashishdxt devashishdxt commented Dec 18, 2019

Solution: Added documentation for all environment variables in help command

New help message:

client-cli 0.1.1
Basic CLI tool for interacting with Crypto.com Chain

ENVIRONMENT VARIABLES:
    CRYPTO_CLIENT_DEBUG             Set to `true` for detailed error messages (Default: `false`)
    CRYPTO_CHAIN_ID                 Chain ID of Crypto.com Chain
    CRYPTO_CLIENT_STORAGE           Storage directory (Default: `.storage`)
    CRYPTO_CLIENT_TENDERMINT        Websocket endpoint for tendermint (Default: `ws://localhost:26657/websocket`)

USAGE:
    client-cli <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    address        Address operations
    balance        Get balance of a wallet
    help           Prints this message or the help of the given subcommand(s)
    history        Get transaction history of a wallet
    state          Get staked state of an address
    sync           Synchronize client with Crypto.com Chain
    transaction    Transaction operations
    view-key       Shows the view key of a wallet
    wallet         Wallet operations

Solution: Added documentation for all environment variables in help command
Copy link
Contributor

@tomtau tomtau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🍾🎆

@tomtau
Copy link
Contributor

tomtau commented Dec 18, 2019

bors r+

bors bot added a commit that referenced this pull request Dec 18, 2019
700: Problem: (CRO-300) No easy way to find client's environment variables r=tomtau a=devashishdxt

Solution: Added documentation for all environment variables in help command

New help message:
```
client-cli 0.1.1
Basic CLI tool for interacting with Crypto.com Chain

ENVIRONMENT VARIABLES:
    CRYPTO_CLIENT_DEBUG             Set to `true` for detailed error messages (Default: `false`)
    CRYPTO_CHAIN_ID                 Chain ID of Crypto.com Chain
    CRYPTO_CLIENT_STORAGE           Storage directory (Default: `.storage`)
    CRYPTO_CLIENT_TENDERMINT        Websocket endpoint for tendermint (Default: `ws://localhost:26657/websocket`)

USAGE:
    client-cli <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    address        Address operations
    balance        Get balance of a wallet
    help           Prints this message or the help of the given subcommand(s)
    history        Get transaction history of a wallet
    state          Get staked state of an address
    sync           Synchronize client with Crypto.com Chain
    transaction    Transaction operations
    view-key       Shows the view key of a wallet
    wallet         Wallet operations
```

Co-authored-by: Devashish Dixit <devashish@crypto.com>
@codecov
Copy link

codecov bot commented Dec 18, 2019

Codecov Report

Merging #700 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #700   +/-   ##
=======================================
  Coverage   70.09%   70.09%           
=======================================
  Files         131      131           
  Lines       16597    16597           
=======================================
  Hits        11633    11633           
  Misses       4964     4964
Impacted Files Coverage Δ
client-cli/src/command.rs 0% <ø> (ø) ⬆️

@bors
Copy link
Contributor

bors bot commented Dec 18, 2019

@bors bors bot merged commit 4e86c8c into crypto-com:master Dec 18, 2019
@devashishdxt devashishdxt deleted the client-env-variable branch December 18, 2019 07:56
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants