Skip to content

docs: document grant request subcommands in README#45

Merged
aaearon merged 1 commit intomainfrom
docs/request-commands-readme
Apr 21, 2026
Merged

docs: document grant request subcommands in README#45
aaearon merged 1 commit intomainfrom
docs/request-commands-readme

Conversation

@aaearon
Copy link
Copy Markdown
Owner

@aaearon aaearon commented Apr 21, 2026

Summary

  • Add grant request usage examples to the Usage section
  • Add request entry to the Commands table
  • Add grant request subcommands table (submit, list, get, cancel, approve, reject)
  • Add grant request submit flags reference

Test plan

  • Verify all subcommand descriptions match actual CLI help output
  • Verify flag list for grant request submit is complete

Add usage examples, commands table entry, subcommands table, and
flag reference for the grant request workflow commands.
Copilot AI review requested due to automatic review settings April 21, 2026 06:51
@aaearon aaearon merged commit 7bf5e71 into main Apr 21, 2026
3 checks passed
@aaearon aaearon deleted the docs/request-commands-readme branch April 21, 2026 06:51
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the project’s README to document the new grant request command group so users can discover and use the access-request approval workflow from the main CLI docs.

Changes:

  • Adds grant request usage examples to the Usage section.
  • Adds request to the Commands table and documents grant request subcommands (submit, list, get, cancel, approve, reject).
  • Adds a flags reference section for grant request submit.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md

# Access request workflow
grant request submit # interactive: pick workspace, role, fill details
grant request submit --provider azure --target "Prod" --role "Contributor" --reason "Incident"
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The grant request submit example looks like a fully flag-driven submission, but --role is display-only and the command still requires interactive role selection unless --role-id is provided. Also, in non-interactive mode submit requires --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.

Suggested change
grant request submit --provider azure --target "Prod" --role "Contributor" --reason "Incident"
grant request submit --provider azure --target "Prod" --role "Contributor" --reason "Incident" # still prompts in a TTY for role selection/scheduling
grant request submit --provider azure --target "Prod" --role-id "<role-id>" --reason "Incident" --date "2025-01-15" --timezone "America/New_York" --from "09:00" --to "17:00" --yes

Copilot uses AI. Check for mistakes.
Comment thread README.md
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 |
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The subcommand arg placeholder/name is inconsistent with the actual CLI help. The Cobra Use strings are get [requestId], cancel [requestId], approve [requestId], reject [requestId] (and the long help refers to <requestId>). Consider standardizing the README to match the CLI (e.g., use [requestId] everywhere, or consistently use <requestId>), rather than mixing [id] with <id>.

Suggested change
| `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 uses AI. Check for mistakes.
Comment thread README.md
`--provider, -p` | `--target, -t` | `--role, -r` | `--favorite, -f` | `--group, -g` | `--groups` | `--refresh`

**`grant request submit`:**
`--provider, -p` | `--target, -t` | `--role` | `--role-id` | `--reason` | `--priority` | `--date` | `--timezone` | `--from` | `--to` | `--yes` | `--refresh`
Copy link

Copilot AI Apr 21, 2026

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`

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants