Skip to content
Atuin

atuin-server

Atuin sync server

Terminal window
atuin-server <COMMAND>

Start the server

Terminal window
atuin-server start [OPTIONS]
  • --host <HOST>: The host address to bind
  • -p <PORT>, --port <PORT>: The port to bind

Print server example configuration

Terminal window
atuin-server default-config

Manage the server by hand

Terminal window
atuin-server admin <COMMAND>

Manage user accounts

Terminal window
atuin-server admin user <COMMAND>

Create a user, with the password read from a prompt or from stdin

Works even when open_registration is false.

Terminal window
atuin-server admin user create --email <EMAIL> <USERNAME>
  • <USERNAME>: The new user’s name, of letters, digits and hyphens (-)
  • --email <EMAIL>: The new user’s email. Required.

Set a user’s password, read from a prompt or from stdin

The user’s machines stay logged in.

Terminal window
atuin-server admin user set-password <USERNAME>
  • <USERNAME>: The user to change

Delete a user with their history and synced records

Terminal window
atuin-server admin user delete [OPTIONS] <USERNAME>
  • <USERNAME>: The user to delete
  • --yes: Delete without asking for confirmation