mirror of
https://github.com/deadc0de6/dotdrop.git
synced 2026-03-22 21:55:08 +00:00
adding a gencfg command
This commit is contained in:
1
docs/config/config-config.md
vendored
1
docs/config/config-config.md
vendored
@@ -38,7 +38,6 @@ Entry | Description | Default
|
||||
`workdir` | Path to the directory where templates are installed before being symlinked when using `link:absolute|relative|link_children` (absolute path or relative to the config file location) | `~/.config/dotdrop`
|
||||
<s>link_by_default</s> | When importing a dotfile, set `link` to this value by default | false
|
||||
|
||||
|
||||
## import_variables entry
|
||||
|
||||
It is possible to load variables/dynvariables from external files by providing their
|
||||
|
||||
4
docs/config/config-file.md
vendored
4
docs/config/config-file.md
vendored
@@ -2,8 +2,8 @@
|
||||
|
||||
## Location
|
||||
|
||||
The default config file used by dotdrop is
|
||||
[config.yaml](https://github.com/deadc0de6/dotdrop/blob/master/config.yaml).
|
||||
The default config file used by dotdrop is `config.yaml`.
|
||||
A clean base config can be generated using `dotdrop gencfg`.
|
||||
|
||||
Unless specified otherwise, dotdrop will look in the following places for its config file
|
||||
and use the first one found:
|
||||
|
||||
7
docs/getting-started.md
vendored
7
docs/getting-started.md
vendored
@@ -15,12 +15,11 @@ $ cd my-dotfiles
|
||||
$ mkdir dotfiles
|
||||
```
|
||||
|
||||
Then add a config file. You can get a
|
||||
[minimal config file](https://github.com/deadc0de6/dotdrop/blob/master/config.yaml)
|
||||
from dotdrop's repository with:
|
||||
Then generate a base config file:
|
||||
```bash
|
||||
$ wget https://raw.githubusercontent.com/deadc0de6/dotdrop/master/config.yaml
|
||||
$ dotdrop gencfg > config.yaml
|
||||
```
|
||||
|
||||
It is recommended to store your config file directly within your repository
|
||||
(*my-dotfiles* in the example above), but you could save it in different places if you wish;
|
||||
see [config location](config/config-file.md#location) for more.
|
||||
|
||||
7
docs/usage.md
vendored
7
docs/usage.md
vendored
@@ -250,6 +250,13 @@ the file will be restored.
|
||||
|
||||
For more options, see the usage with `dotdrop --help`.
|
||||
|
||||
## Generate a default config
|
||||
|
||||
The `gencfg` command will generate a default config in yaml
|
||||
```bash
|
||||
$ dotdrop gencfg > config.yaml
|
||||
```
|
||||
|
||||
## Concurrency
|
||||
|
||||
The command line switch `-w`/`--workers`, if set to a value greater than one, enables the use
|
||||
|
||||
Reference in New Issue
Block a user