-
Notifications
You must be signed in to change notification settings - Fork 3.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: key management guide #216
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, just a few minor changes.
docs/guide/key-management.md
Outdated
|
||
## Create keys | ||
|
||
To get an app started quickly, or for dev/test scripting, the `basecli keys new alice --unsafe` command can be used. However, this tutorial is instead concerned with the advanced features of the tooling that don't compromise safety considerations. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
where did the --unsafe flag come from?
# basecli keys new alice --unsafe
ERROR: unknown flag: --unsafe
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just remove this mention unless you know something I don't...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#213 ... only an idea. I'm not opiniated on this since piping things around does the trick, if you don't want that flag, close the issue. I'll remove from docs.
docs/guide/key-management.md
Outdated
|
||
will, for example, return the info for only the "charlie" key returned from the previous `basecoin keys list` command. | ||
|
||
Before moving on, let's set some configurations to make `--output json` the default. We can use either the `$BC_HOME` (?) env var or use a `config.toml` that is located in (?) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
BCHOME needs to be mentioned, but it's different.
-
You can set BCHOME to any dir, it looks for a config.toml file in there, and uses
output = "json"
if it is there... It also stores all keys in a subdir of BCHOME (or BC_HOME they are the same) -
You can
export BC_OUTPUT=json
(orBCOUTPUT=json
) to make it all json output.
BC_ prefix is standard with viper and seems cleaner to me. Bucky really liked the eg. TMHOME for tendermint without _ and I made that work here as well with a little setup magic. Pick the one you think is better and use it throughout. (eg. BCHOME, BCOUTPUT, ... or BC_HOME, BC_OUTPUT...)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay, we should stick with one format (with the _
is my preference) and (ideally) use a longer variable name (BASECLI_HOME
) to make things clearer. For this guide, I will mention only second env var (BC_OUTPUT
) and if we really want, we'll have a seperate guide for config option.
Very nice. Thank you for this. There are two points which I think need to be fixed up, then I will merge. Also, can you mention the Finally, there is the If you add those points, I will merge. It is actually something useful now. Thank you, |
Looks good. Thank you. |
basecli keys
sub-command.