Skip to content

docs: correct PAT scopes and clarify the -p alias #12

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.

Sign up for GitHub

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
jonas1307 merged 1 commit into from
Jul 23, 2026
Merged

docs: correct PAT scopes and clarify the -p alias #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,8 @@ When you sign in (`--login`) or provide a `--pat`, the CLI automatically fetches

## Work Item Commands

> **Note on `-p`:** most commands use `-p` as the short alias for `--project`. On `list`, `mine` and `normalize`, `-p` is `--parent` instead (project uses `-P` there), so the more common parent filter gets the short flag. When in doubt, use the long form (`--project` / `--parent`).

### `get` — Get work item details

```powershell
Expand Down Expand Up @@ -453,6 +455,7 @@ Go to **User Settings → Personal Access Tokens → New Token** and grant the f
| Scope | Permission | Used by |
|---|---|---|
| Work Items | Read & Write | All work item commands |
| Build | Read | `pipelines` |
| Code | Read & Write | Pull request commands. `Read` covers `pr-list`/`pr-get`/`pr-open`; `pr-create` needs `Read & Write` |
| Build | Read & Execute | `pipelines` and `runs` need `Read`; queueing with `run` needs `Execute` |

The PAT is stored encrypted (DPAPI) on Windows and in an owner-only file (`600`) on Linux/macOS.
Loading