Skip to content

cmd: fix config file paths #2040

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

Merged
shcheklein merged 1 commit into from
Dec 21, 2020
Merged

cmd: fix config file paths #2040

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 11 additions & 7 deletions content/docs/command-reference/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,18 +38,21 @@ instead, to set (or override) secrets:
The `--global` and `--system` flags are also available to set config options for
multiple projects and users, respectively:

| Flag | Priority | Mac location | Linux location | Windows location |
| ---------- | -------- | ---------------------------------------- | -------------------------- | --------------------------------------------------------- |
| `--global` | 3 | `$HOME/Library/Application\ Support/dvc` | `$HOME/.config/dvc/config` | `%LocalAppData%\iterative\dvc\config` |
| `--system` | 4 | `/Library/Application\ Support/dvc` | `/etc/dvc/config` | `%AllUsersProfile%\Application Data\iterative\dvc\config` |

<!-- Avoids new lines in the Flag column (above). -->
<!-- Avoids new lines in the Flag columns (below). -->
<style>
#markdown-root td:first-child code {
white-space: nowrap;
}
</style>

| Flag | Priority | Mac location | Linux location (typical\*) | Windows location |
| ---------- | -------- | -------------------------------------- | -------------------------- | --------------------------------------------------------- |
| `--global` | 3 | `$HOME/Library/Preferences/dvc/config` | `$HOME/.config/dvc/config` | `%LocalAppData%\iterative\dvc\config` |
| `--system` | 4 | `/Library/Preferences/dvc/config` | `/etc/xdg/dvc/config` | `%AllUsersProfile%\Application Data\iterative\dvc\config` |

> \* For Linux, the global `dvc/config` may be found in `$XDG_CONFIG_HOME`, and
> the system-wide one in `$XDG_CONFIG_DIRS[0]`, if those env vars are defined.

## Command options (flags)

- `-u`, `--unset` - remove a specified config option from a config file.
Expand All @@ -64,7 +67,8 @@ multiple projects and users, respectively:

- `--system` - modify a system config file (e.g. `/etc/dvc/config`) instead of
`.dvc/config`. Useful to apply config options to all the projects (all users)
in the machine.
in the machine. May require superuser access e.g.
`sudo dvc config --system ...` (Linux).
Comment on lines -67 to +71
Copy link
Copy Markdown
Contributor Author

@jorgeorpinel jorgeorpinel Dec 21, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added this note along the way. Needed?

Copy link
Copy Markdown
Contributor

@efiop efiop Dec 21, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call! Thank you!


- `-l`, `--list` - lists all defined config values.

Expand Down