Skip to content

Commit

Permalink
Update readme help message to dotter 0.8.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Amit Gold committed Oct 1, 2020
1 parent 175c957 commit 55ed8e3
Showing 1 changed file with 17 additions and 11 deletions.
28 changes: 17 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,21 +31,19 @@ All the files will be deployed to their target locations.
Check out `dotter -h` for the command-line flags that Dotter supports:

```
Dotter 0.7.2
A small dotfile manager.
Dotter 0.8.0
A small dotfile manager. Note that flags and options have to come BEFORE subcommands
USAGE:
dotter [FLAGS] [OPTIONS]
dotter [FLAGS] [OPTIONS] [SUBCOMMAND]
FLAGS:
--dry-run Dry run - don't do anything, only print information. Implies RUST_LOG=info unless specificed
otherwise
--force Force - instead of skipping, overwrite target files if their content is unexpected. Overrides
--dry-run and implies RUST_LOG=warn unless specified otherwise
-h, --help Prints help information
--undeploy Un-deploy - delete all deployed files in their target locations. Note that this operates on all
files that are currently in cache
-V, --version Prints version information
--dry-run Dry run - don't do anything, only print information. Implies RUST_LOG=info unless specificed
otherwise
--force Force - instead of skipping, overwrite target files if their content is unexpected. Overrides
--dry-run and implies RUST_LOG=warn unless specified otherwise
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
--cache-directory <cache-directory> Directory to cache into [default: dotter_settings/cache]
Expand All @@ -54,6 +52,14 @@ OPTIONS:
-g, --global-config <global-config> Location of the global configuration [default:
dotter_settings/global.toml]
-l, --local-config <local-config> Location of the local configuration [default: dotter_settings/local.toml]
SUBCOMMANDS:
deploy Deploy the files to their respective targets. This is the default subcommand
help Prints this message or the help of the given subcommand(s)
init Initialize global.toml with a single package containing all the files in the current directory
pointing to a dummy value and a local.toml that selects that package
undeploy Delete all deployed files from their target locations. Note that this operates on all files that are
currently in cache
```

Dotter uses the `env_logger` rust library for displaying errors and warnings. To configure logging level, use the `RUST_LOG` environment variable. The options are, in order of least verbose to most verbose: `error`, `warn`, `info`, `debug`, `trace`. The default is `error`.
Expand Down

0 comments on commit 55ed8e3

Please sign in to comment.