-
Notifications
You must be signed in to change notification settings - Fork 1
docs: document grant request subcommands in README #45
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -49,6 +49,17 @@ grant status | |||||||||||||||||
| grant revoke # interactive multi-select | ||||||||||||||||||
| grant revoke <session-id> # direct by ID | ||||||||||||||||||
| grant revoke --all # revoke all | ||||||||||||||||||
|
|
||||||||||||||||||
| # Access request workflow | ||||||||||||||||||
| grant request submit # interactive: pick workspace, role, fill details | ||||||||||||||||||
| grant request submit --provider azure --target "Prod" --role "Contributor" --reason "Incident" | ||||||||||||||||||
| grant request list # list your requests | ||||||||||||||||||
| grant request list --state PENDING --role APPROVER | ||||||||||||||||||
| grant request get # fuzzy-pick a request (TTY) or pass <id> | ||||||||||||||||||
| grant request get <request-id> | ||||||||||||||||||
| grant request cancel <request-id> # cancel an open request | ||||||||||||||||||
| grant request approve <request-id> # approve a pending request (approvers only) | ||||||||||||||||||
| grant request reject <request-id> # reject a pending request (approvers only) | ||||||||||||||||||
| ``` | ||||||||||||||||||
|
|
||||||||||||||||||
|  | ||||||||||||||||||
|
|
@@ -102,16 +113,31 @@ Running `grant` with no subcommand elevates cloud permissions (the core behavior | |||||||||||||||||
| | `status` | Show auth state and active sessions | | ||||||||||||||||||
| | `favorites` | Manage saved role favorites (`add`/`list`/`remove`) | | ||||||||||||||||||
| | `revoke` | Revoke sessions (interactive, by ID, or `--all`) | | ||||||||||||||||||
| | `request` | Manage access requests through an approval workflow (see subcommands below) | | ||||||||||||||||||
| | `update` | Self-update to the latest release from GitHub | | ||||||||||||||||||
| | `version` | Print version information | | ||||||||||||||||||
|
|
||||||||||||||||||
| ### `grant request` subcommands | ||||||||||||||||||
|
|
||||||||||||||||||
| | Subcommand | Description | | ||||||||||||||||||
| |------------|-------------| | ||||||||||||||||||
| | `submit` | Submit an on-demand access request (interactive workspace + role picker, or direct with flags) | | ||||||||||||||||||
| | `list` | List access requests (`--state`, `--result`, `--priority`, `--role CREATOR\|APPROVER`, `--search`, `--sort`, `--desc`) | | ||||||||||||||||||
| | `get [id]` | Show full request details; omit `<id>` in a TTY to open a fuzzy picker | | ||||||||||||||||||
| | `cancel [id]` | Cancel an open request; omit `<id>` in a TTY to pick from your open requests | | ||||||||||||||||||
| | `approve [id]` | Approve a pending request (approvers only); omit `<id>` in a TTY to pick from pending requests | | ||||||||||||||||||
| | `reject [id]` | Reject a pending request (approvers only); omit `<id>` in a TTY to pick from pending requests | | ||||||||||||||||||
|
Comment on lines
+126
to
+129
|
||||||||||||||||||
| | `get [id]` | Show full request details; omit `<id>` in a TTY to open a fuzzy picker | | |
| | `cancel [id]` | Cancel an open request; omit `<id>` in a TTY to pick from your open requests | | |
| | `approve [id]` | Approve a pending request (approvers only); omit `<id>` in a TTY to pick from pending requests | | |
| | `reject [id]` | Reject a pending request (approvers only); omit `<id>` in a TTY to pick from pending requests | | |
| | `get [requestId]` | Show full request details; omit `[requestId]` in a TTY to open a fuzzy picker | | |
| | `cancel [requestId]` | Cancel an open request; omit `[requestId]` in a TTY to pick from your open requests | | |
| | `approve [requestId]` | Approve a pending request (approvers only); omit `[requestId]` in a TTY to pick from pending requests | | |
| | `reject [requestId]` | Reject a pending request (approvers only); omit `[requestId]` in a TTY to pick from pending requests | |
Copilot
AI
Apr 21, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The grant request submit flags list is missing the short forms that the CLI exposes (--role, -r and --yes, -y). Aligning this list with the actual submit command flags will make it easier to copy/paste from the README.
Suggested change
| `--provider, -p` | `--target, -t` | `--role` | `--role-id` | `--reason` | `--priority` | `--date` | `--timezone` | `--from` | `--to` | `--yes` | `--refresh` | |
| `--provider, -p` | `--target, -t` | `--role, -r` | `--role-id` | `--reason` | `--priority` | `--date` | `--timezone` | `--from` | `--to` | `--yes, -y` | `--refresh` |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
grant request submitexample looks like a fully flag-driven submission, but--roleis display-only and the command still requires interactive role selection unless--role-idis provided. Also, in non-interactive modesubmitrequires--reason, --date, --timezone, --from, --to(and--role-id). Consider either updating the example to include--role-id+ scheduling flags (and maybe--yes) or clarifying in the comment that it will prompt for missing fields in a TTY.