Skip to content

Add different OS config file locations to conection examples #538

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add different OS config file locations to conection examples #538

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3fda3ef
Add different OS config file locations to conenction examples
anuarkaliyev23 Sep 9, 2025
d1cd925
Removing paragraph from unrelated section
anuarkaliyev23 Sep 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -604,7 +604,11 @@ $ usql file:/path/to/dbname.sqlite3
$ usql adodb://Microsoft.Jet.OLEDB.4.0/myfile.mdb
$ usql "adodb://Microsoft.ACE.OLEDB.12.0/?Extended+Properties=\"Text;HDR=NO;FMT=Delimited\""

# connect to a named connection in $HOME/.config/usql/config.yaml
# connect to a named connection from config file
# For linux and other UNIX default config file is typically located in $HOME/.config/usql/config.yaml or $XDG_CONFIG_HOME/usql/config.yaml
# For macOS it is $HOME/Library/Application Support/usql/config.yaml
# For Windows it is %AppData%/usql/config.yaml
# You can also provide path to config file with connections explicitly with usql --config
$ cat $HOME/.config/usql/config.yaml
connections:
my_named_connection: sqlserver://user:pass@localhost/
Expand Down Expand Up @@ -846,7 +850,10 @@ always appreciated][contributing]!
During its initialization phase, `usql` reads a standard [YAML configuration][yaml]
file [`config.yaml`](contrib/config.yaml). On Windows this is `%AppData%/usql/config.yaml`,
on macOS this is `$HOME/Library/Application Support/usql/config.yaml`, and on
Linux and other Unix systems this is normally `$HOME/.config/usql/config.yaml`.
Linux and other Unix systems this is normally `$HOME/.config/usql/config.yaml`
or `$XDG_CONFIG_HOME/usql/config.yaml` if `$XDG_CONFIG_HOME` is set.

You can provide config file explicitly with `usql --config $PATH_TO_CONFIG_FILE`.

##### `connections:`

Expand Down