Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
orf authored Sep 7, 2020
1 parent cd70995 commit eb13c9d
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,37 @@ Don't do this, it's pretty slow: `cargo install git-workspace`

Git is really annoying and hijacks the `--help` flag for subcommands. **So to get help use `git-workspace --help`, not `git workspace --help`**.

```
$ git-workspace --help
git-workspace 0.7.0
Tom Forbes <[email protected]>
Manage and update personal and work git repos from multiple providers
USAGE:
git-workspace --workspace <workspace> <SUBCOMMAND>
FLAGS:
-h, --help
Prints help information
-V, --version
Prints version information
OPTIONS:
-w, --workspace <workspace>
[env: GIT_WORKSPACE=...]
SUBCOMMANDS:
add Add a provider to the configuration
fetch Fetch new commits for all repositories in the workspace
help Prints this message or the help of the given subcommand(s)
list List all repositories in the workspace
run Run a git command in all repositories
update Update the workspace, removing and adding any repositories as needed
```

## Define your workspace

A workspace is the directory that `git-workspace` will manage for you, filling it with projects cloned from your providers. To configure this just set a `GIT_WORKSPACE` environment variable that points to an empty directory. For example:
Expand Down

0 comments on commit eb13c9d

Please sign in to comment.