Sign in

Search issue titles and bodies, change requests and comments. Private repositories you cannot read are not included.
vole
Clone

Read only, no credentials:

https://rodent.software/git/vole.git

Write over SSH with a registered key:

git clone ssh://git@0.0.0.0:2222/vole.git

A free and open-source forge that lives in your Git repo.

Align the CLI with Git's command conventions

ade6107e546a7f1859ca4fe23a327d44871dce6d · Keenan Nemetz · 15d ago · parent 04e00cfc

docs/cli.md +11−7

@@ -12,17 +12,18 @@ with code `129`, just like Git.
12 12 | Option | Used by | Meaning |
13 13 |---|---|---|
14 14 | `--config <path>` | Local server management | Use a different `vole.toml` (default: `./vole.toml`, then `~/.vole/vole.toml`; `VOLE_CONFIG` overrides both) |
15 | `--remote <name\|url>` | `admin`, issue, release, and pages commands | Git remote or instance SSH URL to talk to |
15 | `--remote <name\|url>` | `admin`, issue, change, release, and pages commands | Git remote or instance SSH URL to talk to |
16 16 | `--json` | `admin --remote` | Print the server's JSON response |
17 | `--no-push` | `issue`, `request` | Commit locally without pushing |
17 | `--no-push` | `issue`, `change` | Commit locally without pushing |
18 18 | `--dir <path>` | `init`, `workflow`, `runner` | Working or checkout directory |
19 19 | `--branch <name>` | `pages` | Site branch (default `pages`) |
20 | `--format <fmt>` | `issue list` | Output fields such as `%(id)` and `%(title)` |
20 | `--format <fmt>` | `issue list`, `change list` | Output fields such as `%(id)` and `%(title)`, or `json` |
21 21 | `-h`, `--help` | All | Print usage |
22 22
23 23 Options follow Git's conventions: `--long value`, `--long=value`, `-o value`,
24 `-ovalue`, repeated options, and `--` to end option parsing. Options may appear
25 before or after arguments.
24 `-ovalue`, bundled short options such as `-am`, repeated options, and `--` to
25 end option parsing. Options may appear before or after arguments. `vole help
26 <command>` and `vole <command> -h` print that command's usage.
26 27
27 28 ## Instance
28 29
@@ -47,6 +48,9 @@ vole admin --remote ssh://git@forge.example.com:2222 user list
47 48
48 49 See [Users and access](users-and-access.md#remote-administration).
49 50
51 The pre-admin spellings `vole user`, `vole repo`, `vole acl`, `vole index` and
52 `vole gc` remain as compatibility aliases; documentation and help use `vole admin`.
53
50 54 ### Users
51 55
52 56 ```sh
@@ -129,7 +133,7 @@ Ids and comment ids accept a unique prefix. See [Issues](issues.md).
129 133
130 134 ```sh
131 135 vole change new --title <title> --base <branch> [--head <rev>] [-m <text> | -F <file>]
132 vole change list [--state open|closed]
136 vole change list [--state open|closed|all] [--format <fmt>]
133 137 vole change show <id>
134 138 vole change comment <id> [-m <text> | -F <file>] [--path <file> --line <n> [--side new|old]]
135 139 vole change edit-comment <id> <comment-id> [-m <text> | -F <file>]
@@ -156,7 +160,7 @@ vole release attach <tag> <file>... [--remote <name>]
156 160 ## Pages
157 161
158 162 ```sh
159 vole pages deploy [<dir>] [--branch <name>] [-m <text>] [--dry-run] [--remote <name>]
163 vole pages deploy [<dir>] [--branch <name>] [-m <text> | -F <file>] [--dry-run] [--remote <name>]
160 164 vole pages status [--branch <name>] [--remote <name>]
161 165 vole pages unpublish [--branch <name>] [--remote <name>]
162 166 ```