Minosse Notes CLI

Table of Contents

• How to Use
  • Command "configure"
  • Command "new"
  • Command "get"
  • Command "update"
  • Command "delete"

How to Use

Command "configure"

The "configure" command allows you to set default settings for notes using the CLI interactively. The configured settings will be used as defaults when using the "new" command.

Usage example:

# Configure default settings interactively
notes configure
? Delete note after read:  No
? Encrypt note:  No
? Editable note:  Yes
? Expire after:  90d
? Email notification:  Yes
? Email:  [email protected]

Command "new"

The "new" command allows you to create a new note using the CLI. The following options are available:

• -t, --terminalText <note>: Use this option to directly enter the note content in the terminal without opening the default editor.
• -i, --interactive: Interactive note creation.
• -d, --deleteAfterRead [boolean]: Set the note to be deleted after reading (boolean value: true or false).
• -e, --encrypted [boolean]: Make the note encrypted (boolean value: true or false).
• -w, --editable [boolean]: Make the note editable (boolean value: true or false).
• -f, --file <value>: Send a file as a note (value must be the path of the file).
• -x, --expireAfter <value>: Set the note's expire timestamp (Expire timestamp must be an indication of time, e.g., "1 hour," "2 days," or a positive number).
• -n, --notificationEmail <value>: Notification email address for the read recipt message.

Usage example:

# Interactive note creation
notes new -i

# Create a text note directly in the terminal
notes new -t Note content

# Create an encrypted note with expiration
notes new -e true -x 1 hour

# Send a file as a note
notes new -f file_path.txt

# Set an email for notification
notes new -n [email protected]

Output example:

id:  123456789
link:  https://example.com/note/123456789
This note will burn on 2023-07-30 12:00:00

Command "get"

The "get" command allows you to view a note using the CLI. The following option is available:

• <id> (required): Note ID or link.
• -t, --terminal: View the note directly in the terminal without opening the default editor.

Usage example:

# View the note in the terminal
notes get <id> -t

# View the note in the terminal using a link
notes get https://note_link -t

Command "update"

The "update" command allows you to update an existing note using the CLI. The following option is available:

• <id> (required): Note ID or link.

Usage example:

# Update the note using the ID
notes update <id>

# Update the note using a link
notes update https://note_link

Command "delete"

The "delete" command allows you to delete a note using the CLI. The following option is available:

• <id> (required): Note ID or link.

Usage example:

# Delete the note using the ID
notes delete <id>

# Delete the note using a link
notes delete https://note_link