Skip to content
Atuin

account

Manage your sync account. This page is the command reference. For a walkthrough of registering and logging in, see Setting up Sync.

To sign this machine in to Atuin Cloud, run atuin setup --sync cloud. Setup opens your browser to sign in, and asks for your encryption key only when your account has data that this machine’s key can’t read. Use the commands on this page to sign in to a server of your own, and for unattended logins.

atuin register, atuin login, and atuin logout are shorthand for the corresponding atuin account subcommands.

Create an account on the configured sync server.

Terminal window
atuin account register -u <USERNAME> -e <EMAIL> -p <PASSWORD>
Flag Description
--username/-u Your desired username. Must be unique, alphanumerics and hyphens only
--email/-e Used only for important notifications, such as security issues
--password/-p Omit this and Atuin asks for it instead, keeping it out of your shell history. Pass - to read it from stdin

Registering logs you in and generates your encryption key. Save the key — see atuin key.

Log in on another machine.

Terminal window
atuin account login -u <USERNAME>
Flag Description
--username/-u Your username
--password/-p Omit and Atuin asks for it. Pass - to read it from stdin
--key/-k Your encryption key. Omit and Atuin asks for it
--totp-code/-t Your two-factor authentication code, if your account has 2FA

Omitting --password and --key is recommended: Atuin asks for both, so neither ends up in your shell history.

For unattended logins, set ATUIN_PASSWORD and ATUIN_ENCRYPTION_KEY, or pipe the password in with --password -. Unlike flag values, neither shows up in the process list:

Terminal window
ATUIN_ENCRYPTION_KEY="$KEY" atuin login -u <USERNAME> --password - < password.txt

atuin register also reads ATUIN_PASSWORD.

Terminal window
atuin account logout

Ends the local session. Your history and encryption key stay on the machine.

Terminal window
atuin account change-password
Flag Description
--current-password/-c Omit and Atuin asks for it
--new-password/-n Omit and Atuin asks for it
--totp-code/-t Your two-factor authentication code, if your account has 2FA

This changes your account password only. Your encryption key is unaffected, and other machines stay logged in.

Terminal window
atuin account delete

Deletes your account and all synchronized history from the server.

Flag Description
--password/-p Your password. Omit and Atuin asks for it
--totp-code/-t Your two-factor authentication code, if your account has 2FA

Link your CLI sync account to your Atuin Hub account.

Terminal window
atuin account link

Opens a browser to authenticate with Hub, then associates the two accounts. If you’re already signed in to Hub, the accounts are linked immediately.