mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-06 18:10:36 +00:00
feat: generate the gt command reference from gitea/cli
update_cli_docs.sh runs gt's own generator and lays the pages out for the site: one directory per command group, front matter, titles, sidebar order, fenced help text and rewritten links. --released succeeds while no series is documented. A weekly workflow proposes updates like the runner's. Signed-off-by: bircni <[email protected]>
This commit is contained in:
261 files changed
+15116
-2
No files matched your search
@@ -0,0 +1,79 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
description: "Edit repository settings"
|
||||
---
|
||||
|
||||
# gt repo edit
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Edit repository settings
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Edit the settings of a repository. Only the flags you pass change; on/off settings such as
|
||||
--enable-wiki take =false to turn them off.
|
||||
```
|
||||
|
||||
```
|
||||
gt repo edit [<repository>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# Change the description and the website
|
||||
$ gt repo edit --description "Command line tool" --website https://example.com
|
||||
|
||||
# Make a repository private and disable its wiki
|
||||
$ gt repo edit alice/project --visibility private --enable-wiki=false
|
||||
|
||||
# Squash pull requests by default and tag the repository
|
||||
$ gt repo edit --default-merge-style squash --add-topic cli --add-topic go
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--actions Enable Actions
|
||||
--add-topic strings Add topics (repeatable or comma-separated)
|
||||
--allow-merge-commit Allow merging pull requests with a merge commit
|
||||
--allow-rebase Allow rebase merging pull requests
|
||||
--allow-squash Allow squash merging pull requests
|
||||
--as-template Make the repository a template
|
||||
--default-branch string Default branch; it must exist
|
||||
--default-merge-style string Default merge style for pull requests {merge|rebase|rebase-merge|squash|fast-forward-only}
|
||||
--delete-branch-on-merge Delete head branches after merging pull requests
|
||||
-d, --description string Repository description
|
||||
--enable-issues Enable issues
|
||||
--enable-projects Enable projects
|
||||
--enable-pull-requests Enable pull requests
|
||||
--enable-wiki Enable the wiki
|
||||
-h, --help help for edit
|
||||
--private Make the repository private (=false makes it public)
|
||||
--remove-topic strings Remove topics (repeatable or comma-separated)
|
||||
--visibility string Repository visibility {public|private}
|
||||
--website string Repository website (empty clears it)
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt repo](../repo/index.md): Work with Gitea repositories
|
||||
Reference in new issue
Block a user