From 50dc2d5f5f096820f3928be0f70d3d12c3b1cc9c Mon Sep 17 00:00:00 2001
From: techknowlogick <techknowlogick@gitea.io>
Date: Mon, 26 Jun 2023 01:13:20 -0400
Subject: [PATCH] Document creating an API key from the CLI (#25504) (#25510)
Frontport of #25504
Credit to @lonix1
Co-authored-by: lonix1 <40320097+lonix1@users.noreply.github.com>
Co-authored-by: delvh <dev.lh@web.de>
---
docs/content/doc/administration/command-line.en-us.md | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/docs/content/doc/administration/command-line.en-us.md b/docs/content/doc/administration/command-line.en-us.md
index 37ba0c04da..d7e74ee24d 100644
--- a/docs/content/doc/administration/command-line.en-us.md
+++ b/docs/content/doc/administration/command-line.en-us.md
@@ -108,6 +108,14 @@ Admin operations:
- `--all`, `-A`: Force a password change for all users
- `--exclude username`, `-e username`: Exclude the given user. Can be set multiple times.
- `--unset`: Revoke forced password change for the given users
+ - `generate-access-token`:
+ - Options:
+ - `--username value`, `-u value`: Username. Required.
+ - `--token-name value`, `-t value`: Token name. Required.
+ - `--scopes value`: Comma-separated list of scopes. Scopes follow the format `[read|write]:<block>` or `all` where `<block>` is one of the available visual groups you can see when opening the API page showing the available routes (for example `repo`).
+ - Examples:
+ - `gitea admin user generate-access-token --username myname --token-name mytoken`
+ - `gitea admin user generate-access-token --help`
- `regenerate`
- Options:
- `hooks`: Regenerate Git Hooks for all repositories