Skip to content

Commit

Permalink
chore: Tidy up readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jaysonsantos authored May 20, 2021
1 parent 744fdbb commit 9ea6b5c
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,12 @@ SUBCOMMANDS:
register-device
```

The basic flow is calling `register-device` so mambembe can record your access token and save it to your keyring service (Keychain on macOS, secrets-manager on linux which is baked by KWallet or gnome-keyring, or Windows Vault).
The basic flow is calling `register-device` so mambembe can record your access token and save it to your keyring service (Keychain on macOS, secrets-manager on linux which is backed by KWallet or gnome-keyring, or Windows Vault).

To register your device call `mambembe-cli register-device --device-name <device-name> --phone <phone>` where **IMPORTANT** phone has to be in a specific format (as there is no cleaning in place) e.g.: `49-123456`, where `49` is the country code and `123456` is your phone.

To refresh your tokens you can call `list-services` and it will always hit authy's API to get the list of your current devices.

To get a token you can call `mambembe-cli get-token --service-name <service-name>` where `<service-name>` can be a partial as it will make a fuzzy search, e.g.:

```
Expand Down

0 comments on commit 9ea6b5c

Please sign in to comment.