Adding and removing keys via Command Line Interface (CLI)

When a new key is added via CLI, you first need to update the profile.


To update a profile:

atakama profile update-devices --profile <profile-name OR profile ID> [<device ids(including desktop) in descending priority>] --m <num required> [# of devices required to decrypt]


Example:

atakama profile update-devices --profile "angle-sure-chest-torch" "Desktop-FDE0TK9" "ios1" "ios2" "backup word set 1" --m 2



To get the list of the devices associated with a profile:

atakama device list


To get the list of profile IDs:

atakama profile list 

Adding keys

To add a key on paper during onboarding:

atakama device add-words [--local] [--alias <alias>]

Example:

atakama device add-words --local KeyOnPaper1


To add a key on paper at any point after onboarding:

atakama device add-words [--alias <alias>]


Example:

atakama device add-words --alias KeyOnPaper1


To add a mobile device as a key:
Via QR code 

atakama device add {device name} -m qr

Example:

atakama device add MyIOSPhone -m qr

Scan the QR code with Atakama mobile camera app.


Via URL 

atakama device add {device name} --m url

Copy the URL and open it on the mobile device

Example:

atakama device add MyIOSPhoneURL --m URL


Removing Keys

To remove a device:

atakama device remove {device name}

Example:

atakama device remove iPhone14


Re-linking Keys

To re-link a mobile device:

 atakama device link {device name} -m qr

Example:

atakama device link MyIOSPhone -m qr


Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.