Skip to content

backlog edit

backlog edit

Edit an existing task

Synopsis

Edit an existing task by providing its ID and flags for the fields to update.

backlog edit <id> [flags]

Examples

# Edit tasks using the "backlog edit" command with its different flags.
# Let's assume you have a task with ID "42" that you want to modify.
# Here are some examples of how to use this command effectively:

# 1. Changing the Title
# Use the -t or --title flag to give the task a new title.
backlog edit 42 -t "Fix the main login button styling"

# 2. Updating the Description
# Use the -d or --description flag to replace the existing description with a new one.
backlog edit 42 -d "The login button on the homepage is misaligned on mobile devices. It should be centered."

# 3. Changing the Status
# Update the task's progress by changing its status with the -s or --status flag.
backlog edit 42 -s "in-progress"

# 4. Re-assigning a Task
# You can add or remove assigned names for a task using the -a (--assigned) and -A (--remove-assigned) flags.
# Add a single assignee:
backlog edit 42 -a "jordan"
# Add multiple assignees:
backlog edit 42 -a "jordan" -a "casey"
# Remove an assignee:
backlog edit 42 -A "casey"

# 5. Updating Labels
# Use the -l (--labels) and -L (--remove-labels) flags to add or remove labels.
# Add a single label:
backlog edit 42 -l "bug"
# Add multiple labels:
backlog edit 42 -l "frontend" -l "bug"
# Remove a label:
backlog edit 42 -L "bug"


# 6. Changing the Priority
# Adjust the task's priority with the --priority flag.
backlog edit 42 --priority "high"

# 7. Managing Acceptance Criteria
# You can add, check, uncheck, or remove acceptance criteria.
# Add a new AC:
backlog edit 42 --ac "The button is centered on screens smaller than 576px."
# Check the first AC (assuming it's at index 1):
backlog edit 42 --check-ac 1
# Uncheck the first AC:
backlog edit 42 --uncheck-ac 1
# Remove the second AC (at index 2):
backlog edit 42 --remove-ac 2

# 8. Changing the Parent Task
# Move a task to be a sub-task of a different parent using the -p or --parent flag.
backlog edit 42 -p "18"
# To remove a parent, pass an empty string:
backlog edit 42 -p ""

# 9. Adding Implementation Notes
# Use the --notes flag to add or update technical notes for implementation.
backlog edit 42 --notes "The issue is in the 'main.css' file, specifically in the '.login-container' class. Need to adjust the media query."

# 10. Complex Example (Combining Multiple Flags)
# You can combine several flags to make multiple changes at once.
backlog edit 42 \
  -s "in-review" \
  -a "alex" \
  --priority "critical" \
  --notes "The fix is ready for review. Please check on both iOS and Android." \
  --check-ac 1 \
  --check-ac 2

# 11. Updating the Implementation Plan
# Use the --plan flag to add or update the implementation plan for the task.
backlog edit 42 --plan "1. Refactor login button\n2. Test on mobile\n3. Review with team"

# 12. Setting Dependencies
# Use the --deps flag to set the dependencies for a task.
# This will replace all existing dependencies with the new ones.
backlog edit 42 --deps "T1,T2"

# 13. Setting a Single Dependency
# If you want to make a task depend on another specific task:
backlog edit 42 --deps "T15"
# This makes task 42 dependent on task T15, meaning T15 must be completed before T42 can be started.

# 14. Setting Multiple Dependencies
# You can make a task depend on multiple other tasks:
backlog edit 42 --deps "T15,T18,T20"
# This makes task 42 dependent on tasks T15, T18, and T20.

Options

Environment Variables

    (name)              (default)
    BACKLOG_AUTO_COMMIT false
    BACKLOG_FOLDER      .backlog
    BACKLOG_LOG_FILE    
    BACKLOG_LOG_FORMAT  text
    BACKLOG_LOG_LEVEL   info

Flags

      --ac strings                Add a new acceptance criterion (can be used multiple times)
  -a, --assigned strings          Add assigned names for the task (can be specified multiple times)
      --check-ac ints             Check an acceptance criterion by its index
      --deps strings              Set dependencies, replacing existing ones (can be used multiple times)
  -d, --description string        New description for the task
  -h, --help                      help for edit
  -l, --labels strings            Add labels for the task (can be specified multiple times)
      --notes string              New implementation notes for the task
  -p, --parent string             New parent for the task
      --plan string               New implementation plan for the task
      --priority string           New priority for the task
      --remove-ac ints            Remove an acceptance criterion by its index
  -A, --remove-assigned strings   Assigned names to remove from the task (can be specified multiple times)
  -L, --remove-labels strings     Labels to remove from the task (can be specified multiple times)
  -s, --status string             New status for the task
  -t, --title string              New title for the task
      --uncheck-ac ints           Uncheck an acceptance criterion by its index

Options inherited from parent commands

      --auto-commit         Auto-committing changes to git repository
      --folder string       Directory for backlog tasks (default ".backlog")
      --log-file string     Log file path (defaults to stderr)
      --log-format string   Log format (json, text) (default "text")
      --log-level string    Log level (debug, info, warn, error) (default "info")

SEE ALSO

  • backlog - Backlog is a git-native, markdown-based task manager