atuinsh / atuin

✨ Magical shell history

Home Page:https://atuin.sh

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[Bug]: Config file not created by the installer script

jamesscottbrown opened this issue · comments

What did you expect to happen?

After running the installer script, I expect the config file .config/atuin/config.toml to have been created.

What happened?

The config file (and indeed the .config/atuin directory) isn't created until the atuin command is run.

This was initially confusing: I was installing clients to use with a self-hosted atuin server, so wanted to edit the sync_address setting before running atuin login.

There was also no indication that a config file would be created by running an atuin command,

Atuin doctor output

I don't think this is relevant, but for one VM I tested this in:

atuin:
  version: 18.2.0
  sync: null
shell:
  name: bash
  default: unknown
  plugins:
  - bash-preexec
system:
  os: Ubuntu
  arch: x86_64
  version: '24.04'
  disks:
  - name: /dev/sda1
    filesystem: ext4
  - name: /dev/sda16
    filesystem: ext4
  - name: /dev/sda15
    filesystem: vfat
  - name: :/home/jsb
    filesystem: fuse.sshfs

Code of Conduct

  • I agree to follow this project's Code of Conduct

This is even more confusing because the default version of config.toml changes some values from what their defaults would otherwise be (to enter_accepts = true and records = true).

When I was testing I installed on three machines minutes apart and one of them wouldn't sync its history with the others. It turned out that on that machine I had run an atuin command and edited the generated config file (whereas on the others I started with an empty file). This generated config file included records = true and changed the sync mechanism from v1 to v2.