Configuration

First Run Configuration

On first run, GoSuki will automatically generate a default configuration file at $XDG_CONFIG_DIR/gosuki/config.toml. This file serves as the central configuration for all modules and features.

You can view the default configuration template using the command:

gosuki config gen

output

[chrome]
[chrome.profile_options]
watch-all-profiles = false
profile = "Default"

[database]
db-path = "~/.local/share/gosuki/"
sync-interval = '5s'

[firefox]
[firefox.profile-options]
watch-all-profiles = true
profile = "default"

[github-stars]
github-token = "xxxxxxxxxxxxxxxxxxxx"
sync-interval = '6h'

[global]
watch-all = true

[html-autoimport]
paths = ["$HOME/shares/bookmarks"]

[reddit-saves]
client-id = "xxxxxxxxxxxxxxxxxxxx"
client-secret = "xxxxxxxxxxxxxxxxxxxx"
password = "xxxxxxxxxxxxxxxxxxxx"
sync-interval = '24h'
username = "xxxxxxxxxxxxxxxxxxxx"

This will output a TOML file with all available configuration options, pre-filled with default values. The generated file includes sections for:

Browser configurations (Chrome, Firefox)
Database settings
Module-specific options
Global settings

See More

config.toml