This is a simple command-line program for managing notes. It allows you to create and query different notes.
- Go programming language (version 1.16 or later)
-
Clone the repository or download the source code files.
-
Open a terminal or command prompt and navigate to the root directory of the project.
To run the program using the go run
command, follow these steps:
-
In the terminal, navigate to the root directory of the project.
-
Run the following command:
go run main.go
This command tells Go to run the
main.go
file located in the root directory. -
The program will start running, and you will see the interactive command-line interface prompt:
>
You can now enter commands to interact with the program.
gt
- Get all open todosgt <query>
- Search open todos containing the specified query (multiple queries can be separated by commas)gto
- Get all overdue todosgtnd
- Get all todos with no due dategts
- Get todos due soon (within the next week)ct <title>
- Create a new todo with the specified title
cm <title>
- Create a new meeting note with the specified title
cp <title>
- Create a new planning note with the specified title and seven questions template
cs
- Create a new standup note with predefined team member sections
gta <tags>
- Search notes by tagsgq <query>
- Search all notes containing the specified query (multiple queries can be separated by commas)gqa <query>
- Search within the previously queried resultsgat
- Get all uncompleted tasks from previously queried fileso <filename>
- Open a specific note in the editor
↑
(Up Arrow) - Navigate to previous file in search results and display its tasks↓
(Down Arrow) - Navigate to next file in search results and display its tasksESC
- Clear the current command line
exit
,quit
, orq
- Exit the program
Notes are stored as Markdown files with YAML frontmatter containing metadata such as:
- title
- date-created
- tags
- date-due (for todos)
- done status (for todos)
When navigating through files using the arrow keys, any uncompleted tasks (lines containing "- [ ]") will be automatically displayed below the filename. Tasks are shown in the format:
filename : task content: line_number