You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/features/tasks/wallet.md
+9-5Lines changed: 9 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ reset Remove all aliases.
30
30
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.
31
31
32
32
```bash
33
-
$ algokit wallet add [OPTIONS] ALIAS_NAME
33
+
algokit wallet add [OPTIONS] ALIAS_NAME
34
34
```
35
35
36
36
> 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.
This command retrieves an address or account stored against a named alias.
47
47
48
48
```bash
49
-
$ algokit wallet get ALIAS
49
+
algokit wallet get ALIAS
50
50
```
51
51
52
52
### List
53
53
54
54
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/)).
55
55
56
56
```bash
57
-
$ algokit wallet list
57
+
algokit wallet list
58
58
```
59
59
60
60
### Remove
@@ -63,15 +63,15 @@ This command removes an address or account stored against a named alias.
63
63
You must confirm the prompt interactively or pass `--force` | `-f` flag to ignore the prompt.
64
64
65
65
```bash
66
-
$ algokit wallet remove ALIAS [--force |-f]
66
+
algokit wallet remove ALIAS [--force |-f]
67
67
```
68
68
69
69
### Reset
70
70
71
71
This command removes all aliases. You must confirm the prompt interactively or pass `--force` | `-f` flag to ignore the prompt.
72
72
73
73
```bash
74
-
$ algokit wallet reset [--force |-f]
74
+
algokit wallet reset [--force |-f]
75
75
```
76
76
77
77
## Keyring
@@ -88,6 +88,10 @@ To retrieve the stored mnemonic, you will need to manually navigate to your oper
88
88
89
89
> 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.
90
90
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
+
91
95
## Further Reading
92
96
93
97
For in-depth details, visit the [wallet section](../../cli/index.md#wallet) in the AlgoKit CLI reference documentation.
0 commit comments