codenotes-cli

module
v0.0.0-...-eef6dab Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 20, 2024 License: MIT

README

CodeNotes CLI

Command-Line Interface for CodeNotes VSCode Extension

Note Types

  1. Folder notes
  2. Line notes

Initializing a project

codenotes init
codenotes init --directory /path/to/your/project

Notes API

Adding a folder note
codenotes add note --message "This is a folder note" --directory /path/to/directory
Adding a file note
codenotes add note --message "This is a file note" --file /path/to/file
Adding a line note
codenotes add note --line --message "This is a line note" --line-no 10 --file /path/to/file

Adding a sticky line note

codenotes add note --message "This is a line note" --line-no 10 --sticky --directory /path/to/file
Deleting a note
codenotes delete note 01ARZ3NDEKTSV4RRFFQ69G5FAV
Updating a folder note
codenotes update note 01ARZ3NDEKTSV4RRFFQ69G5FAV --message "This is an updated note"
Getting a single note
codenotes get note 01ARZ3NDEKTSV4RRFFQ69G5FAV

Reminders API - TODO

Putting a reminder on a note

Directories

Path Synopsis
cmd
cli
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL