summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAnish Athalye <me@anishathalye.com>2020-03-25 21:38:39 -0400
committerAnish Athalye <me@anishathalye.com>2020-03-26 11:23:07 -0400
commit7ffaa65482a59fa485e7a8f19fe07a33694fc157 (patch)
tree78e5990b5934b920b797fe7bace046b3b9bf51c6 /README.md
parent5d83f9e797b1950199e127a8196803f5e33e0916 (diff)
Add --only and --except command-line arguments
Internal to Dotbot, we use the name "skip" instead of "except", because the latter is a keyword, and using a name like "except_" didn't seem as nice.
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1aa5fa8..f5e43c6 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,7 @@ Dotbot makes installing your dotfiles as easy as `git clone $url && cd dotfiles
- [Configuration](#configuration)
- [Directives](#directives) ([Link](#link), [Create](#create), [Shell](#shell), [Clean](#clean), [Defaults](#defaults))
- [Plugins](#plugins)
+- [Command-line Arguments](#command-line-arguments)
- [Wiki][wiki]
---
@@ -359,6 +360,23 @@ Plugins are loaded using the `--plugin` and `--plugin-dir` options, using
either absolute paths or paths relative to the base directory. It is
recommended that these options are added directly to the `install` script.
+## Command-line Arguments
+
+Dotbot takes a number of command-line arguments; you can run Dotbot with
+`--help`, e.g. by running `./install --help`, to see the full list of options.
+Here, we highlight a couple that are particularly interesting.
+
+### `--only`
+
+You can call `./install --only [list of directives]`, such as `./install --only
+link`, and Dotbot will only run those sections of the config file.
+
+### `--except`
+
+You can call `./install --except [list of directives]`, such as `./install
+--except shell`, and Dotbot will run all the sections of the config file except
+the ones listed.
+
## Wiki
Check out the [Dotbot wiki][wiki] for more information, tips and tricks,