# BRANCH EDITCOMMENT

> Edit branch comments with the Unity Version Control CLI.

## Description

Modifies the comment of a branch.

### Usage

```bash
cm branch | br editcomment | edit <brspec> (<new_comment> | -commentsfile=<comments_file>)
```

### Options

| Option / Argument | Description                                                                                           |
| :---------------- | :---------------------------------------------------------------------------------------------------- |
| brspec            | The branch whose comment will be edited. (Use `cm help objectspec` to learn more about branch specs.) |
| new\_comment      | The new comment for the branch.                                                                       |
| `-commentsfile`   | Reads the new comment from the specified file.                                                        |

## Help

### Remarks

* To clear the comment, pass an empty comment (`""`).
* `edit` is an alias of `editcomment`. To create a branch named "edit", use `cm branch create edit`.

### Examples

The following example replaces the comment of branch `/main/task001`:

```bash
cm branch editcomment /main/task001 "Fix the login timeout"
```
