Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/azdo_boards_iteration_project.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Project-scoped iteration commands.
* [azdo boards iteration project delete](./azdo_boards_iteration_project_delete.md)
* [azdo boards iteration project list](./azdo_boards_iteration_project_list.md)
* [azdo boards iteration project show](./azdo_boards_iteration_project_show.md)
* [azdo boards iteration project update](./azdo_boards_iteration_project_update.md)

### ALIASES

Expand Down
24 changes: 8 additions & 16 deletions docs/azdo_boards_iteration_project_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Create an iteration (sprint) in a project.

```
azdo boards iteration project create [ORGANIZATION/]PROJECT [flags]
azdo boards iteration project create [ORGANIZATION/]PROJECT[/PATH]/NAME [flags]
```

### Options
Expand All @@ -25,14 +25,6 @@ azdo boards iteration project create [ORGANIZATION/]PROJECT [flags]

Output JSON with the specified fields. Prefix a field with '-' to exclude it.

* `--name` `string`

Name of the new iteration (required).

* `--path` `string`

Parent iteration path under /Iteration. Omit to create at the project root.

* `--start-date` `string`

Iteration start date (RFC 3339 or YYYY-MM-DD).
Expand All @@ -55,22 +47,22 @@ azdo boards iteration project create [ORGANIZATION/]PROJECT [flags]

```bash
# Create a top-level iteration
azdo boards iteration project create Fabrikam --name "Sprint 1"
azdo boards iteration project create Fabrikam/Sprint\ 1

# Schedule a sprint with start and finish dates
azdo boards iteration project create Fabrikam \
--name "Sprint 2" --start-date 2025-01-06 --finish-date 2025-01-19
azdo boards iteration project create Fabrikam/Sprint\ 2 \
--start-date 2025-01-06 --finish-date 2025-01-19

# Create a nested iteration under an existing release
azdo boards iteration project create myorg/Fabrikam --name "Sprint 2" --path "Release 2025"
azdo boards iteration project create myorg/Fabrikam/Release\ 2025/Sprint\ 2

# Set a custom attribute alongside the dates
azdo boards iteration project create Fabrikam \
--name "Sprint 1" --start-date 2025-01-06 --finish-date 2025-01-19 \
azdo boards iteration project create Fabrikam/Sprint\ 1 \
--start-date 2025-01-06 --finish-date 2025-01-19 \
--attributes goal="Ship login"

# Emit JSON
azdo boards iteration project create Fabrikam --name "Sprint 1" --json
azdo boards iteration project create Fabrikam/Sprint\ 1 --json
```

### See also
Expand Down
14 changes: 5 additions & 9 deletions docs/azdo_boards_iteration_project_delete.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Command `azdo boards iteration project delete`

```
azdo boards iteration project delete [ORGANIZATION/]PROJECT --path <path> [flags]
azdo boards iteration project delete [ORGANIZATION/]PROJECT[/PATH]/NAME [flags]
```

Delete an iteration (sprint) from a project. The command prompts for
Expand All @@ -22,10 +22,6 @@ reclassified first.

Output JSON with the specified fields. Prefix a field with &#39;-&#39; to exclude it.

* `--path` `string`

Path of the iteration to delete (under /Iteration, leading /Iteration stripped).

* `-r`, `--reclassify-id` `int`

ID of the target node to which work items should be moved before deletion.
Expand Down Expand Up @@ -53,17 +49,17 @@ reclassified first.

```bash
# Delete a top-level iteration
azdo boards iteration project delete Fabrikam --path "Sprint 1" --yes
azdo boards iteration project delete Fabrikam/Sprint\ 1 --yes

# Delete a nested iteration with a confirmation prompt
azdo boards iteration project delete Fabrikam --path "Release 2025/Sprint 1"
azdo boards iteration project delete Fabrikam/Release\ 2025/Sprint\ 1

# Reclassify work items to node 42 before deletion
azdo boards iteration project delete Fabrikam --path "Sprint 1" \
azdo boards iteration project delete Fabrikam/Sprint\ 1 \
--reclassify-id 42 --yes

# Emit JSON
azdo boards iteration project delete Fabrikam --path "Sprint 1" --reclassify-id 42 --json
azdo boards iteration project delete Fabrikam/Sprint\ 1 --reclassify-id 42 --json
```

### See also
Expand Down
8 changes: 2 additions & 6 deletions docs/azdo_boards_iteration_project_list.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Command `azdo boards iteration project list`

```
azdo boards iteration project list [ORGANIZATION/]PROJECT [flags]
azdo boards iteration project list [ORGANIZATION/]PROJECT[/PATH] [flags]
```

List the iteration (sprint) hierarchy for a project within an Azure DevOps organization.
Expand Down Expand Up @@ -30,10 +30,6 @@ List the iteration (sprint) hierarchy for a project within an Azure DevOps organ

Output JSON with the specified fields. Prefix a field with &#39;-&#39; to exclude it.

* `-p`, `--path` `string`

Iteration path relative to project root

* `--start-date` `string`

Apply a comparison filter to iteration start dates; supports operators like &gt;= and special value &#34;today&#34; (e.g., &#34;&gt;=today&#34;)
Expand All @@ -59,7 +55,7 @@ List the iteration (sprint) hierarchy for a project within an Azure DevOps organ
azdo boards iteration project list myorg/myproject

# List from a specific path
azdo boards iteration project list myproject --path "Release 2025/Sprint 1"
azdo boards iteration project list myproject/Release\ 2025/Sprint\ 1

# Include start and finish dates
azdo boards iteration project list myproject --include-dates
Expand Down
14 changes: 5 additions & 9 deletions docs/azdo_boards_iteration_project_show.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Command `azdo boards iteration project show`

```
azdo boards iteration project show [ORGANIZATION/]PROJECT [flags]
azdo boards iteration project show [ORGANIZATION/]PROJECT[/PATH]/NAME [flags]
```

Display the details of a single iteration (sprint) node in a project.
Expand All @@ -27,10 +27,6 @@ The iteration is identified by its fully-qualified path under /Iteration.

Output JSON with the specified fields. Prefix a field with &#39;-&#39; to exclude it.

* `--path` `string`

Iteration path under /Iteration (required).

* `-r`, `--raw`

Dump the raw SDK node to stderr.
Expand All @@ -53,16 +49,16 @@ The iteration is identified by its fully-qualified path under /Iteration.

```bash
# Show a top-level iteration
azdo boards iteration project show Fabrikam --path "Sprint 1"
azdo boards iteration project show Fabrikam/Sprint\ 1

# Show a nested iteration
azdo boards iteration project show myorg/Fabrikam --path "Release 2025/Sprint 1"
azdo boards iteration project show myorg/Fabrikam/Release\ 2025/Sprint\ 1

# Include child nodes in the template output
azdo boards iteration project show Fabrikam --path "Release 2025" --include-children
azdo boards iteration project show Fabrikam/Release\ 2025 --include-children

# Emit the raw SDK node as JSON
azdo boards iteration project show Fabrikam --path "Sprint 1" --json
azdo boards iteration project show Fabrikam/Sprint\ 1 --json
```

### See also
Expand Down
72 changes: 72 additions & 0 deletions docs/azdo_boards_iteration_project_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
## Command `azdo boards iteration project update`

```
azdo boards iteration project update [ORGANIZATION/]PROJECT[/PATH]/NAME [flags]
```

Update an iteration (sprint) in a project. The positional argument identifies
the iteration as [ORGANIZATION/]PROJECT[/PATH]/NAME.

Supports changing start/finish dates and setting arbitrary attributes.


### Options


* `--attributes` `strings`

Custom attribute in key=value form. Repeatable. Existing attributes not mentioned are preserved.

* `--finish-date` `string`

New finish date (RFC 3339 or YYYY-MM-DD). Wins on conflict with --attributes finishDate. Must be on or after start-date when both are set.

* `-q`, `--jq` `expression`

Filter JSON output using a jq expression

* `--json` `fields`

Output JSON with the specified fields. Prefix a field with &#39;-&#39; to exclude it.

* `--start-date` `string`

New start date (RFC 3339 or YYYY-MM-DD). Wins on conflict with --attributes startDate.

* `-t`, `--template` `string`

Format JSON output using a Go template; see &#34;azdo help formatting&#34;


### ALIASES

- `u`
- `up`

### JSON Fields

`_links`, `attributes`, `hasChildren`, `id`, `identifier`, `name`, `path`, `structureType`, `url`

### Examples

```bash
# Reschedule a sprint
azdo boards iteration project update Fabrikam/Sprint\ 1 \
--start-date 2025-01-06 --finish-date 2025-01-19

# Add or change a custom attribute, keeping the existing dates
azdo boards iteration project update Fabrikam/Release\ 2025/Sprint\ 1 \
--attributes goal="Ship login"

# Combine: reschedule + set a custom attribute
azdo boards iteration project update myorg/Fabrikam/Release\ 2025/Sprint\ 1 \
--start-date 2025-01-06 --finish-date 2025-01-19 \
--attributes goal="Ship login"

# Emit JSON
azdo boards iteration project update Fabrikam/Sprint\ 1 --json
```

### See also

* [azdo boards iteration project](./azdo_boards_iteration_project.md)
32 changes: 23 additions & 9 deletions docs/azdo_help_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Aliases
prj, p
```

##### `azdo boards iteration project create [ORGANIZATION/]PROJECT [flags]`
##### `azdo boards iteration project create [ORGANIZATION/]PROJECT[/PATH]/NAME [flags]`

Create an iteration (sprint) in a project.

Expand All @@ -136,8 +136,6 @@ Create an iteration (sprint) in a project.
--finish-date string Iteration finish date (RFC 3339 or YYYY-MM-DD).
-q, --jq expression Filter JSON output using a jq expression
--json fields[=*] Output JSON with the specified fields. Prefix a field with '-' to exclude it.
--name string Name of the new iteration (required).
--path string Parent iteration path under /Iteration. Omit to create at the project root.
--start-date string Iteration start date (RFC 3339 or YYYY-MM-DD).
-t, --template string Format JSON output using a Go template; see "azdo help formatting"
```
Expand All @@ -148,14 +146,13 @@ Aliases
c, cr
```

##### `azdo boards iteration project delete [ORGANIZATION/]PROJECT --path <path> [flags]`
##### `azdo boards iteration project delete [ORGANIZATION/]PROJECT[/PATH]/NAME [flags]`

Delete an iteration from a project.

```
-q, --jq expression Filter JSON output using a jq expression
--json fields[=*] Output JSON with the specified fields. Prefix a field with '-' to exclude it.
--path string Path of the iteration to delete (under /Iteration, leading /Iteration stripped).
-r, --reclassify-id int ID of the target node to which work items should be moved before deletion.
-t, --template string Format JSON output using a Go template; see "azdo help formatting"
-y, --yes Skip the confirmation prompt.
Expand All @@ -167,7 +164,7 @@ Aliases
d, del, rm
```

##### `azdo boards iteration project list [ORGANIZATION/]PROJECT [flags]`
##### `azdo boards iteration project list [ORGANIZATION/]PROJECT[/PATH] [flags]`

List iteration hierarchy for a project.

Expand All @@ -177,7 +174,6 @@ List iteration hierarchy for a project.
--include-dates Include iteration start and finish dates
-q, --jq expression Filter JSON output using a jq expression
--json fields[=*] Output JSON with the specified fields. Prefix a field with '-' to exclude it.
-p, --path string Iteration path relative to project root
--start-date string Apply a comparison filter to iteration start dates; supports operators like >= and special value "today" (e.g., ">=today")
-t, --template string Format JSON output using a Go template; see "azdo help formatting"
```
Expand All @@ -188,7 +184,7 @@ Aliases
ls, l
```

##### `azdo boards iteration project show [ORGANIZATION/]PROJECT [flags]`
##### `azdo boards iteration project show [ORGANIZATION/]PROJECT[/PATH]/NAME [flags]`

Show an iteration in a project.

Expand All @@ -197,7 +193,6 @@ Show an iteration in a project.
--include-children Include child nodes in the template output.
-q, --jq expression Filter JSON output using a jq expression
--json fields[=*] Output JSON with the specified fields. Prefix a field with '-' to exclude it.
--path string Iteration path under /Iteration (required).
-r, --raw Dump the raw SDK node to stderr.
-t, --template string Format JSON output using a Go template; see "azdo help formatting"
```
Expand All @@ -208,6 +203,25 @@ Aliases
view, status
```

##### `azdo boards iteration project update [ORGANIZATION/]PROJECT[/PATH]/NAME [flags]`

Update an iteration in a project.

```
--attributes strings Custom attribute in key=value form. Repeatable. Existing attributes not mentioned are preserved.
--finish-date string New finish date (RFC 3339 or YYYY-MM-DD). Wins on conflict with --attributes finishDate. Must be on or after start-date when both are set.
-q, --jq expression Filter JSON output using a jq expression
--json fields[=*] Output JSON with the specified fields. Prefix a field with '-' to exclude it.
--start-date string New start date (RFC 3339 or YYYY-MM-DD). Wins on conflict with --attributes startDate.
-t, --template string Format JSON output using a Go template; see "azdo help formatting"
```

Aliases

```
u, up
```

### `azdo boards work-item <command>`

Work with Azure Boards work items.
Expand Down
Loading
Loading