aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorConrad Ludgate <conradludgate@gmail.com>2023-05-16 22:03:53 +0100
committerGitHub <noreply@github.com>2023-05-16 22:03:53 +0100
commit7d5a82df14160242cdd01a0f1651dab18b41a973 (patch)
tree85983f2f3efd289e413ab2be8338a4e17d52287f /docs
parentfeat: add delete account option (attempt 2) (#980) (diff)
downloadatuin-7d5a82df14160242cdd01a0f1651dab18b41a973.zip
validate usernames on registration (#982)
improve login password incorrect error message update docs for registration with passwords
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/commands/sync.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/docs/commands/sync.md b/docs/docs/commands/sync.md
index 8fbb0c47..8cd12c54 100644
--- a/docs/docs/commands/sync.md
+++ b/docs/docs/commands/sync.md
@@ -26,8 +26,11 @@ Register for a sync account with
atuin register -u <USERNAME> -e <EMAIL> -p <PASSWORD>
```
-Usernames must be unique, and emails shall only be used for important
-notifications (security breaches, changes to service, etc).
+If you don't want to have your password be included in shell history, you can omit
+the password flag and you will be prompted to provide it through stdin.
+
+Usernames must be unique and only contain alphanumerics or hyphens,
+and emails shall only be used for important notifications (security breaches, changes to service, etc).
Upon success, you are also logged in :) Syncing should happen automatically from
here!
@@ -62,6 +65,9 @@ If you want to log in to a new machine, you will require your encryption key
atuin login -u <USERNAME> -p <PASSWORD> -k <KEY>
```
+If you don't want to have your password be included in shell history, you can omit
+the password flag and you will be prompted to provide it through stdin.
+
## Logout
```