All uses of noted require a subcommand. If one is not supplied, the default create subcommand is assumed. The subcommands are as follows.
Lists the current configuration for noted. This is the combination of default values plus whatever is found in $HOME/.notedconfig, where values
in $HOME/.notedconfig take precedence.
noted config The config subcommand will:
- Generate a quick view of the resulting configuration after applying the values in
$HOME/.notedconfig
N/A
View configuration:
noted configCreate a new note.
noted create [Quoted text to use (optional)] [ALTERNATE_FILE_NAME (optional)] The create subcommand will:
- Look for a file named with today's date, and create it if it doesn't exist
- Append the note template to the file named with today's date, with the current timestamp
- Open the file named with today's date
- Position the cursor in the entry title field
Important:
We encourage users to omit
createand use the alternate shorthandnotedwithout the create keyword. The remainder of this documentation will use the shorthand.
Both arguments are optional. When quoted text is included the text will automatically be appended to the entry and editing of the entry will be skipped. When
the ALTERNATE_FILE_NAME argument is supplied with a filename, then instead of using the automatic file (named with today's date), the file supplied will be
used.
Start a new entry:
notedAdd a new note with the text "This is a quick note" as the title and an empty body:
noted "This is a quick note"Start a new entry in the file named process.md:
noted 'Some note' process.mdOpen a specific note file, or today's file if no file is specified, in the default editor.
noted edit [FILE (optional)] noted view [FILE (optional)] Edit and view are interchangeable.
The edit / view subcommand will:
- Look for the file passed as an argument
- If no file is passed, then it will assume today's file
- Open the given file in the default editor
NOTE: Edit is different than create. Create will also populate a new note entry into the given file using the template. Edit, on the other hand, will merely open the file.
The FILE argument is optional. You should not include the extension. The Markdown extension .md is assumed.
Open today's file in the default editor.
noted editOpen the file from 2021-10-01:
noted edit 2021-10-01Open a file named process.md:
noted view processShortcut for running a recursive grep in your configured notes directory.
noted grep [ARGUMENTS (optional)] [SEARCH_TERM (required)] Runs grep -r [NOTED_MARKDOWN_HOME] and also passes along any arguments you supply.
REMINDER:
$NOTED_MARKDOWN_HOMEis configured to$HOME/Documents/notesby default but can be overridden in the$HOME/.notedconfigfile. See the configuration guide for more.
Any arguments that grep accepts can be passed.
Perform a case-insensitive search for the term "Java."
noted grep -i javaPerform a search for "Jenkins" and show line numbers:
noted grep Jenkins -nLists any todos that you have previously saved in your notes.
noted todos Runs a recursive grep in your configured notes directory for the value configured in NOTED_TODO_MARKER, excluding
results that contain strikethrough text (markdown value of ~~) as a means of detecting "crossed-out" todo items.
REMINDER:
NOTED_TODO_MARKERis configured toTODOby default but can be overridden in the$HOME/.notedconfigfile. See the configuration guide for more.
N/A
View any TODO items that are not crossed-out:
noted todosView the current version of noted.
noted version The version subcommand will print out the current version of noted.
N/A
View the version:
noted version