-
-
Notifications
You must be signed in to change notification settings - Fork 26
Is there a CLI?
Alexander Kopachov edited this page Jan 8, 2024
·
16 revisions
When Flipper Authenticator is running totp
CLI is available for you to list, add or remove tokens as well as do some other manipulations. Run totp help
to get list of available commands and arguments.
Here is the list of available commands, their arguments, options and usage:
Command usage | Description |
---|---|
totp (help | h | ?) |
Show command usage help |
totp version |
Get application version |
totp (list | ls) |
List all available tokens |
totp (lsattr | cat) <index> |
Displays token details |
totp (add | mk | new) <name> [-a <algo>] [-e <encoding>] [-d <digits>] [-l <duration>] [-u] [-b <feature>]... |
Add new token |
totp (update) <index> [-a <algo>] [-e <encoding>] [-n <name>] [-d <digits>] [-l <duration>] [-u] [-s] [-b <feature>]... |
Update existing token |
totp (delete | rm) <index> [-f] |
Delete existing token |
totp (timezone | tz) [<timezone>] |
Get or set current timezone |
totp (move | mv) <index> <new_index> |
Move token |
totp pin (set | remove) [-c <slot>] |
Set\change\remove PIN |
totp notify [<notification>...] |
Get or set notification method |
totp reset |
Reset application to default settings |
totp automation [-k <layout>] [<automation>...] |
Get or set automation settings |
totp export |
Exports and prints all the tokens into URI-list format |
Argument | Description |
---|---|
name |
Token name |
index |
Token index in the list |
new_index |
New token index in the list |
timezone |
Timezone offset in hours to be set |
notification |
Notification method to be set. Must be one of: none , sound , vibro
|
automation |
Automation method to be set. Must be one of: none , usb , bt
|
Option | Description |
---|---|
-a <algo> |
Token hashing algorithm. Must be one of: sha1 , sha256 , sha512 , steam [default: sha1 ] |
-d <digits> |
Number of digits to generate, one of: 5 , 6 , 8 [default: 6 ] |
-e <encoding> |
Token secret encoding, one of base32 , base64 [default: base32 ] |
-l <duration> |
Token lifetime duration in seconds, between: 15 and 255 [default: 30 ] |
-u |
Show console user input as-is without masking |
-b <feature> |
Token automation features to be enabled. Must be one of: none , enter , tab [default: none ]none - No featuresenter - Type key at the end of token input automationtab - Type key at the end of token input automationslower - Type slower
|
-n <name> |
Token name |
-s |
Update token secret |
-f |
Force command to do not ask user for interactive confirmation |
-c <slot> |
New crypto key slot. Must be between 12 and 100
|
-k <layout> |
Automation keyboard layout. Must be one of: QWERTY , AZERTY , QWERTZ
|
- Home
- First steps
-
FAQ
- How does it work?
- Is it secure?
- How to get it?
- How to build it?
- Where is config file?
- What is token secret and where to get it?
- Is there a CLI?
- Is there a token input automation?
- How to add new token?
- Does it support Steam-style tokens?
- How to change\recover PIN?
- How to backup?
- How to reset application?
- Flipper Authenticator generates invalid codes, why so?
- How to migrate from another authenticator app?
- TOTP codes became invalid after daylight saving time switch, why?
- Is it possible to connect "Flipper Authenticator" and "Bluetooth Remote" apps to the same device via Bluetooth?
- What does "API version mismatch" error mean?
- Does it support AZERTY\QWERTZ keyboard layout?
- Is there a companion app for desktop?
- Is it possible to migrate to another authenticator app?
- How PIN is stored?