Skip to content

Commit b8cf5d4

Browse files
committed
refactor: clean up README
1 parent 3d961e7 commit b8cf5d4

File tree

1 file changed

+10
-60
lines changed

1 file changed

+10
-60
lines changed

gh-cli/README.md

Lines changed: 10 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -240,53 +240,6 @@ Usage:
240240
./check-enterprise-owner.sh <ENTERPRISE_SLUG> <USERNAME>
241241
```
242242

243-
Example:
244-
245-
```shell
246-
./check-enterprise-owner.sh my-enterprise johndoe
247-
```
248-
249-
> [!NOTE]
250-
> Requires GitHub CLI (`gh`) to be installed and authenticated. The script uses the GraphQL API and requires permission to view enterprise admins. Your token must have appropriate enterprise-level scopes. `jq` is required for JSON parsing.
251-
252-
### check-organization-admin.sh
253-
254-
Checks if a user is an admin in a given organization.
255-
256-
Usage:
257-
258-
```shell
259-
./check-organization-admin.sh <ORG_NAME> <USERNAME>
260-
```
261-
262-
Example:
263-
264-
```shell
265-
./check-organization-admin.sh octo-org johndoe
266-
```
267-
268-
> [!NOTE]
269-
> Requires GitHub CLI (`gh`) to be installed and authenticated. The script uses the GitHub API and requires appropriate permissions to view organization members and their roles.
270-
271-
### check-repository-admin.sh
272-
273-
Checks if a user is a collaborator in a given repository and determines if they have admin access.
274-
275-
Usage:
276-
277-
```shell
278-
./check-repository-admin.sh <OWNER> <REPOSITORY> <USERNAME>
279-
```
280-
281-
Example:
282-
283-
```shell
284-
./check-repository-admin.sh octocat Hello-World johndoe
285-
```
286-
287-
> [!NOTE]
288-
> Requires GitHub CLI (`gh`) to be installed and authenticated. The script uses the GitHub API and requires appropriate permissions to view collaborators and permissions for the repository. For private repositories, your token must have the `repo` scope.
289-
290243
### check-enterprise-team-membership.sh
291244

292245
Checks if a user is a member of an enterprise team using the GitHub API (private preview feature).
@@ -297,15 +250,8 @@ Usage:
297250
./check-enterprise-team-membership.sh <enterprise> <team-slug> <username>
298251
```
299252

300-
Example:
301-
302-
```shell
303-
./check-enterprise-team-membership.sh my-enterprise dev-team octocat
304-
```
305-
306253
> [!NOTE]
307-
> This script uses a private preview API for enterprise teams, which may change without notice. Requires GitHub CLI (`gh`) to be installed and authenticated. You may need special permissions or token scopes to access enterprise team membership information.
308-
254+
> This script uses a private preview API for enterprise teams, which may change without notice.
309255
310256
### check-organization-team-membership.sh
311257

@@ -317,15 +263,19 @@ Usage:
317263
./check-organization-team-membership.sh <organization> <team-slug> <username>
318264
```
319265

320-
Example:
266+
> [!NOTE]
267+
> Your token must have the `read:org` scope to view team membership.
268+
269+
### check-repository-admin.sh
270+
271+
Checks if a user is a collaborator in a given repository and determines if they have admin access.
272+
273+
Usage:
321274

322275
```shell
323-
./check-organization-team-membership.sh my-organization security johndoe
276+
./check-repository-admin.sh <OWNER> <REPOSITORY> <USERNAME>
324277
```
325278

326-
> [!NOTE]
327-
> Requires GitHub CLI (`gh`) to be installed and authenticated. Your token must have the `read:org` scope to view team membership.
328-
329279
### copy-organization-members.sh
330280

331281
Copy organization members from one organization to the other, the member will **retain** the source role (owner or member), member cannot be demoted, if they already exist at the target with an owner role they cannot be demoted to member.

0 commit comments

Comments
 (0)