docs(README): adds default config

This commit is contained in:
Lewis Wynne 2025-12-23 10:45:30 +00:00
parent 0c7767dc41
commit 2d86b3ad21
2 changed files with 30 additions and 3 deletions

View file

@ -632,6 +632,24 @@ Config is stored in your user config directory in `pda/config.toml`.
Usually: `~/.config/pda/config.toml`
```
# ~/.config/pda/config.toml
display_ascii_art = true
[key]
always_prompt_delete = false
always_prompt_overwrite = false
[store]
default_store_name = "default"
always_prompt_delete = true
[git]
auto_fetch = false
auto_commit = true
auto_push = false
```
`PDA_CONFIG` overrides the default config location. pda! will look for a config.toml file in that directory.
```bash
PDA_CONFIG=/tmp/config/ pda set key value

View file

@ -34,9 +34,18 @@ var gitCmd = &cobra.Command{
Short: "Run any arbitrary command. Use with caution.",
Long: `Run any arbitrary command. Use with caution.
Be wary of how pda! version control operates before using this. Regular data is stored in "PDA_DATA/pda/stores" as a store; the Git repository is in "PDA_DATA/pda/vcs" and contains a plaintext replica of the store data.
Be wary of how pda! version control operates before using this.
Regular data is stored in "PDA_DATA/pda/stores" as a store; the
Git repository is in "PDA_DATA/pda/vcs" and contains a plaintext
replica of the store data.
The regular sync command (or auto-syncing) exports pda! data into plaintext in the Git repository. If you manually modify the repository without using the built-in commands, or exporting your data to the folder in the correct format first, you may desynchronize your repository.`,
The regular sync command (or auto-syncing) exports pda! data into
plaintext in the Git repository. If you manually modify the
repository without using the built-in commands, or exporting your
data to the Git folder in the correct format first, you may desync
your repository.
Generally prefer "pda sync".`,
Args: cobra.ArbitraryArgs,
DisableFlagParsing: true,
SilenceUsage: true,