diff options
| author | Ellie Huxtable <ellie@atuin.sh> | 2026-03-03 17:10:55 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-03-03 17:10:55 +0100 |
| commit | 10ea7c3a65c39b5a37d46a270b08b8da149f83dc (patch) | |
| tree | 42b4ed487e34c802b667c73eb5d617985e47779b /docs | |
| parent | chore: update changelog (diff) | |
| download | atuin-10ea7c3a65c39b5a37d46a270b08b8da149f83dc.zip | |
feat: update script for smoother setup (#3230)
Many users do not seem to read the docs. So, make the install script
handle most of the things that we include in the docs quickstart.
Ensures that the install script still functions as expected in
non-interactive environments - setup scripts, ci, etc. Offers a flag
just in case this check fails, to force non-interactive setup.
<!-- Thank you for making a PR! Bug fixes are always welcome, but if
you're adding a new feature or changing an existing one, we'd really
appreciate if you open an issue, post on the forum, or drop in on
Discord -->
## Checks
- [ ] I am happy for maintainers to push small adjustments to this PR,
to speed up the review cycle
- [ ] I have checked that there are no existing pull requests for the
same thing
---------
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Diffstat (limited to '')
| -rw-r--r-- | docs/docs/guide/installation.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/docs/guide/installation.md b/docs/docs/guide/installation.md index aeb33518..193b9ffa 100644 --- a/docs/docs/guide/installation.md +++ b/docs/docs/guide/installation.md @@ -16,6 +16,17 @@ then the manual steps below offer much more flexibility. curl --proto '=https' --tlsv1.2 -LsSf https://setup.atuin.sh | sh ``` +The install script will walk you through importing your shell history and setting +up a sync account. To skip these interactive prompts (e.g. in CI or +Dockerfiles), pass `--non-interactive`: + +```shell +curl --proto '=https' --tlsv1.2 -LsSf https://setup.atuin.sh | sh -s -- --non-interactive +``` + +The script also automatically detects non-interactive environments (piped input, +no TTY) and skips the prompts in those cases. + [**Set up sync** - Move on to the next step, or read on to manually install Atuin instead.](sync.md) ### On Windows |
