Skip to content

Commit 27fa003

Browse files
committed
docs: add info about keyring in wsl2
1 parent 1e0e39c commit 27fa003

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

docs/features/tasks/wallet.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ reset Remove all aliases.
3030
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.
3131

3232
```bash
33-
$ algokit wallet add [OPTIONS] ALIAS_NAME
33+
algokit wallet add [OPTIONS] ALIAS_NAME
3434
```
3535

3636
> 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,15 +46,15 @@ $ algokit wallet add [OPTIONS] ALIAS_NAME
4646
This command retrieves an address or account stored against a named alias.
4747

4848
```bash
49-
$ algokit wallet get ALIAS
49+
algokit wallet get ALIAS
5050
```
5151

5252
### List
5353

5454
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/)).
5555

5656
```bash
57-
$ algokit wallet list
57+
algokit wallet list
5858
```
5959

6060
### Remove
@@ -63,15 +63,15 @@ This command removes an address or account stored against a named alias.
6363
You must confirm the prompt interactively or pass `--force` | `-f` flag to ignore the prompt.
6464

6565
```bash
66-
$ algokit wallet remove ALIAS [--force | -f]
66+
algokit wallet remove ALIAS [--force | -f]
6767
```
6868

6969
### Reset
7070

7171
This command removes all aliases. You must confirm the prompt interactively or pass `--force` | `-f` flag to ignore the prompt.
7272

7373
```bash
74-
$ algokit wallet reset [--force | -f]
74+
algokit wallet reset [--force | -f]
7575
```
7676

7777
## Keyring
@@ -88,6 +88,10 @@ To retrieve the stored mnemonic, you will need to manually navigate to your oper
8888

8989
> 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.
9090
91+
### Keyring on WSL2
92+
93+
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).
94+
9195
## Further Reading
9296

9397
For in-depth details, visit the [wallet section](../../cli/index.md#wallet) in the AlgoKit CLI reference documentation.

0 commit comments

Comments
 (0)