hannes/git-repo-manager
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: Fix repos command

Browse Source
This commit is contained in:
Hannes Körber
2021-11-24 19:42:33 +01:00
parent 7541a74fa4
commit 6bec0eda69
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/src/repos.md
View File

@@ -17,7 +17,7 @@ Then, you're ready to run the first sync. This will clone all configured reposit
and set up the remotes. and set up the remotes.
```bash ```bash
$ grm repo sync --config example.config.toml $ grm repos sync --config example.config.toml
[⚙] Cloning into "/home/me/projects/git-repo-manager" from "https://code.hkoerber.de/hannes/git-repo-manager.git" [⚙] Cloning into "/home/me/projects/git-repo-manager" from "https://code.hkoerber.de/hannes/git-repo-manager.git"
[✔] git-repo-manager: Repository successfully cloned [✔] git-repo-manager: Repository successfully cloned
[⚙] git-repo-manager: Setting up new remote "github" to "https://github.com/hakoerber/git-repo-manager.git" [⚙] git-repo-manager: Setting up new remote "github" to "https://github.com/hakoerber/git-repo-manager.git"
@@ -30,7 +30,7 @@ $ grm repo sync --config example.config.toml
If you run it again, it will report no changes: If you run it again, it will report no changes:
``` ```
$ grm repo sync --config example.config.toml $ grm repos sync --config example.config.toml
[✔] git-repo-manager: OK [✔] git-repo-manager: OK
[✔] dotfiles: OK [✔] dotfiles: OK
``` ```
@@ -42,7 +42,7 @@ a configuration from scratch. Luckily, GRM has a way to generate a configuration
from an existing file tree: from an existing file tree:
```bash ```bash
$ grm repo find ~/your/project/root > config.toml $ grm repos find ~/your/project/root > config.toml
``` ```
This will detect all repositories and remotes and write them to `config.toml`. This will detect all repositories and remotes and write them to `config.toml`.
@@ -50,7 +50,7 @@ This will detect all repositories and remotes and write them to `config.toml`.
### Show the state of your projects ### Show the state of your projects
```bash ```bash
$ grm repo status --config example.config.toml $ grm repos status --config example.config.toml
╭──────────────────┬──────────┬────────┬───────────────────┬────────┬─────────╮ ╭──────────────────┬──────────┬────────┬───────────────────┬────────┬─────────╮
│ Repo ┆ Worktree ┆ Status ┆ Branches ┆ HEAD ┆ Remotes │ │ Repo ┆ Worktree ┆ Status ┆ Branches ┆ HEAD ┆ Remotes │
╞══════════════════╪══════════╪════════╪═══════════════════╪════════╪═════════╡ ╞══════════════════╪══════════╪════════╪═══════════════════╪════════╪═════════╡
@@ -66,7 +66,7 @@ in:
``` ```
$ cd ~/example-projects/dotfiles $ cd ~/example-projects/dotfiles
$ grm repo status $ grm repos status
╭──────────┬──────────┬────────┬──────────┬───────┬─────────╮ ╭──────────┬──────────┬────────┬──────────┬───────┬─────────╮
│ Repo ┆ Worktree ┆ Status ┆ Branches ┆ HEAD ┆ Remotes │ │ Repo ┆ Worktree ┆ Status ┆ Branches ┆ HEAD ┆ Remotes │
╞══════════╪══════════╪════════╪══════════╪═══════╪═════════╡ ╞══════════╪══════════╪════════╪══════════╪═══════╪═════════╡