Skip to content

Update a Note

To update an existing note, use the --update flag or its shorthand -u.

Usage

bash
notely-cli --update
notely-cli -u

Interactive Process

Updating a note is a guided process:

1. Provide Note ID

First, you'll be asked to enter the unique ID of the note you wish to modify.

bash
╭──────────────────────────────────────────────────────────╮
 UPDATE NOTE Step 1/3
╰──────────────────────────────────────────────────────────╯

Enter the ID of the note to update

 5e7b62637

2. Update Title

The CLI will show the current title; you can change it or press enter to keep it as is.

bash
╭──────────────────────────────────────────────────────────╮
 UPDATE NOTE Step 2/3
╰──────────────────────────────────────────────────────────╯

Update title (press Enter to keep current)            12/50

 my awesome note updated

3. Update Description

Next, you can update the note's description or content.

bash
╭──────────────────────────────────────────────────────────╮
 UPDATE NOTE Step 3/3
╰──────────────────────────────────────────────────────────╯

Update content (press Enter to keep current)         20/300

 this is my awesome cli note app updated

4. Success Confirmation

Once confirmed, the note is updated locally.

bash
╭──────────────────────────────────────────────────────────╮
 UPDATE NOTE
╰──────────────────────────────────────────────────────────╯

╭──────────────────────────────────────────────────────────╮
 Note updated successfully!
╰──────────────────────────────────────────────────────────╯

Details

  • You must know the Note ID before starting the update. You can find IDs using the Read command.
  • Changes are saved immediately to db.json.