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.
Unify terminology across the web UI and docs
ab326d3ac1fd947a9df45f31f6dc10ab38627882 · Keenan Nemetz · 14d ago · parent 5b814e99
Unify terminology across the web UI and docs Use account, repository, change request, enrollment link, instance admin, and sign in/out consistently. Rename the access guide to accounts-and-access.md, update its links, and record the canonical terms and retained command/URL spellings in the documentation index.
docs/cli.md +16−13
| @@ -35,7 +35,8 @@ vole version | |||
| 35 | 35 | ||
| 36 | 36 | ## Server management | |
| 37 | 37 | ||
| 38 | `vole admin` is the single namespace for user, repository, and access management. | ||
| 38 | `vole admin` is the single namespace for account (`user`), repository (`repo`), and | ||
| 39 | access (`acl`) management. | ||
| 39 | 40 | Without `--remote`, it changes the instance named by the local `vole.toml`. With | |
| 40 | 41 | `--remote`, it sends the same command over SSH and must be run by an instance | |
| 41 | 42 | admin. | |
| @@ -46,12 +47,14 @@ vole admin --remote origin user create bob --key bob.pub | |||
| 46 | 47 | vole admin --remote ssh://git@forge.example.com:2222 user list | |
| 47 | 48 | ``` | |
| 48 | 49 | ||
| 49 | See [Users and access](users-and-access.md#remote-administration). | ||
| 50 | See [Accounts and access](accounts-and-access.md#remote-administration). | ||
| 50 | 51 | ||
| 51 | 52 | The pre-admin spellings `vole user`, `vole repo`, `vole acl`, `vole index` and | |
| 52 | 53 | `vole gc` remain as compatibility aliases; documentation and help use `vole admin`. | |
| 53 | 54 | ||
| 54 | ### Users | ||
| 55 | ### Accounts | ||
| 56 | |||
| 57 | The `user` commands manage accounts. | ||
| 55 | 58 | ||
| 56 | 59 | ```sh | |
| 57 | 60 | vole admin user create [--key <file|->] [--role <role>] <name> | |
| @@ -85,7 +88,7 @@ never reissued. | |||
| 85 | 88 | ### Repositories | |
| 86 | 89 | ||
| 87 | 90 | ```sh | |
| 88 | vole admin repo create --owner <user> <name> [--description <text>] | ||
| 91 | vole admin repo create --owner <account> <name> [--description <text>] | ||
| 89 | 92 | vole admin repo list | |
| 90 | 93 | vole admin repo show <name> | |
| 91 | 94 | vole admin repo rename <old> <new> | |
| @@ -101,15 +104,15 @@ Instance-wide roles are account standing; repository rules are set with `acl`: | |||
| 101 | 104 | ```sh | |
| 102 | 105 | vole admin user role <name> <none|read|contribute|maintain|admin> | |
| 103 | 106 | vole admin acl show <repo> | |
| 104 | vole admin acl set <repo> <user> <none|read|contribute|maintain|admin> | ||
| 107 | vole admin acl set <repo> <account> <none|read|contribute|maintain|admin> | ||
| 105 | 108 | vole admin acl default <repo> <none|read|contribute|maintain|admin> | |
| 106 | 109 | vole admin acl protect <repo> <ref-pattern>... | |
| 107 | 110 | vole admin acl approvals <repo> <n> | |
| 108 | 111 | vole admin acl checks <repo> <on|off> | |
| 109 | vole admin acl runners <repo> [<user>...] [--add <user> | --remove <user> | --clear] | ||
| 112 | vole admin acl runners <repo> [<account>...] [--add <account> | --remove <account> | --clear] | ||
| 110 | 113 | ``` | |
| 111 | 114 | ||
| 112 | See [Users and access](users-and-access.md) and | ||
| 115 | See [Accounts and access](accounts-and-access.md) and | ||
| 113 | 116 | [Runners](runner.md#who-can-run-jobs-and-report-results). | |
| 114 | 117 | ||
| 115 | 118 | ### Maintenance | |
| @@ -124,16 +127,16 @@ These are local-only. See [Operations](operations.md). | |||
| 124 | 127 | ## Issues | |
| 125 | 128 | ||
| 126 | 129 | ```sh | |
| 127 | vole issue new --title <title> [-m <text> | -F <file>] [-l <label>]... [-a <user>]... | ||
| 130 | vole issue new --title <title> [-m <text> | -F <file>] [-l <label>]... [-a <account>]... | ||
| 128 | 131 | vole issue comment <id> [-m <text> | -F <file>] [--reply-to <comment-id>] | |
| 129 | 132 | vole issue edit-comment <id> <comment-id> [-m <text> | -F <file>] | |
| 130 | 133 | vole issue rm-comment <id> <comment-id> | |
| 131 | vole issue edit <id> [--title <title>] [-m <text> | -F <file>] [-l <label>]... [-a <user>]... [--unassign <user>]... | ||
| 132 | vole issue assign <id> <user>... | ||
| 133 | vole issue unassign <id> <user>... | ||
| 134 | vole issue edit <id> [--title <title>] [-m <text> | -F <file>] [-l <label>]... [-a <account>]... [--unassign <account>]... | ||
| 135 | vole issue assign <id> <account>... | ||
| 136 | vole issue unassign <id> <account>... | ||
| 134 | 137 | vole issue close <id> | |
| 135 | 138 | vole issue reopen <id> | |
| 136 | vole issue list [--state open|closed|all] [-l <label>]... [--assignee <user>]... [--format <fmt>] | ||
| 139 | vole issue list [--state open|closed|all] [-l <label>]... [--assignee <account>]... [--format <fmt>] | ||
| 137 | 140 | vole issue show <id> | |
| 138 | 141 | ``` | |
| 139 | 142 | ||
| @@ -149,7 +152,7 @@ vole change comment <id> [-m <text> | -F <file>] [--path <file> --line <n> [--si | |||
| 149 | 152 | vole change edit-comment <id> <comment-id> [-m <text> | -F <file>] | |
| 150 | 153 | vole change rm-comment <id> <comment-id> | |
| 151 | 154 | vole change update <id> --head <rev> | |
| 152 | vole change approve <id> [--as <user>] | ||
| 155 | vole change approve <id> [--as <account>] | ||
| 153 | 156 | vole change close <id> | |
| 154 | 157 | vole change reopen <id> | |
| 155 | 158 | ``` | |