From 5a8af4d7f57d33874f7a5d9b92be84781574ca70 Mon Sep 17 00:00:00 2001 From: Neil Campbell Date: Mon, 6 Jan 2025 10:35:11 +0800 Subject: [PATCH] docs: add info about keyring in wsl2 --- docs/features/tasks/wallet.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/features/tasks/wallet.md b/docs/features/tasks/wallet.md index 6efb2dcc1..e77fa8c05 100644 --- a/docs/features/tasks/wallet.md +++ b/docs/features/tasks/wallet.md @@ -30,7 +30,7 @@ reset Remove all aliases. This command adds an address or account to be stored against a named alias. If the `--mnemonic` flag is used, it will prompt the user for a mnemonic phrase interactively using masked input. If the `--force` flag is used, it will allow overwriting an existing alias. Maximum number of aliases that can be stored at a time is 50. ```bash -$ algokit wallet add [OPTIONS] ALIAS_NAME +algokit wallet add [OPTIONS] ALIAS_NAME ``` > Please note, the command is not designed to be used in CI scope, there is no option to skip interactive masked input of the mnemonic, if you want to alias an `Account` (both private and public key) entity. @@ -46,7 +46,7 @@ $ algokit wallet add [OPTIONS] ALIAS_NAME This command retrieves an address or account stored against a named alias. ```bash -$ algokit wallet get ALIAS +algokit wallet get ALIAS ``` ### List @@ -54,7 +54,7 @@ $ algokit wallet get ALIAS This command lists all addresses and accounts stored against a named alias. If a record contains a `private_key` it will show a boolean flag indicating whether it exists, actual private key values are never exposed. As a user you can obtain the content of the stored aliases by navigating to your dedicated password manager (see [keyring details](https://pypi.org/project/keyring/)). ```bash -$ algokit wallet list +algokit wallet list ``` ### Remove @@ -63,7 +63,7 @@ This command removes an address or account stored against a named alias. You must confirm the prompt interactively or pass `--force` | `-f` flag to ignore the prompt. ```bash -$ algokit wallet remove ALIAS [--force | -f] +algokit wallet remove ALIAS [--force | -f] ``` ### Reset @@ -71,7 +71,7 @@ $ algokit wallet remove ALIAS [--force | -f] This command removes all aliases. You must confirm the prompt interactively or pass `--force` | `-f` flag to ignore the prompt. ```bash -$ algokit wallet reset [--force | -f] +algokit wallet reset [--force | -f] ``` ## Keyring @@ -88,6 +88,10 @@ To retrieve the stored mnemonic, you will need to manually navigate to your oper > Remember, AlgoKit is designed to keep your sensitive information secure however your storage is only as secure as the device on which it is stored. Always ensure to maintain good security practices on your device, especially when dealing with mnemonics that are to be used on MainNet. +### Keyring on WSL2 + +WSL2 environments don't have a keyring backend installed by default. If you want to leverage this feature, you'll need to install one yourself. See [this GitHub issue for info](https://github.com/jaraco/keyring/issues/566#issuecomment-1792544475). + ## Further Reading For in-depth details, visit the [wallet section](../../cli/index.md#wallet) in the AlgoKit CLI reference documentation.