A Note Tool for Developers
GoSeq helps you manage daily and project-based notes, along with tracking TODOs in your code, similar to the fixme tag.
- Daily Notes Management
- Create and manage notes for any time period.
- Project-Based Notes
- Keep notes linked to specific projects or repositories.
- TODO Management
- Tracks TODOs in your codebase, automatically pushing issues to GitHub.
Install GoSeq using the following command:
go install github.com/DnFreddie/goseq@latestGoSeq retrieves your GitHub credentials from $HOME/.config/.GoSeq.yaml or $HOME/.GoSeq.
If no credentials are found, GoSeq will prompt you to provide them.
Example .GoSeq.yaml config file:
token: <personal-token>To generate a Personal Access Token, visit GitHub Settings.
Ensure the token has full access to private repositories.
To enable command autocompletion:
# create the user completion directory
mkdir ~/.bash_completion.d/
# Generate the completion
goseq completion bash > ~/.bash_completion.d/goseq_completion.sh
# Make it executable
chmod +x ~/.bash_completion.d/goseq_completion.shAdd the following lines to your .bashrc:
# Load custom bash completions
if [ -d ~/.bash_completion.d ]; then
for file in ~/.bash_completion.d/*; do
source "$file"
done
fiGoSeq creates a note for each day, which can be queried or combined as needed.
- Open a new daily note or access an existing one.
- Notes are stored in
$HOME/Documents/Agenda/.
goseq new- List all daily notes and choose the one you wish to edit:
goseq list- Combine multiple notes (from a specific period like a week or a year) into one.
- The default is one week.
- Any changes made to the combined note are applied to the original notes.
goseq join -r <week|day|year|all> -t 3Search for specific patterns within your notes:
goseq search test agendagoseq search -i test agenda goseq search -E ^test$agendagoseq search -i -E ^TEST$AGENDAOpen joined files in the editor and remove the one deleted in the document by the user.
goseq delete - Use the
-rflag to open the most recently accessed project note.- If no recent note is found, you’ll be prompted to choose a project manually:
goseq git -r - Or, provide a path to the directory containing the repository or project:
goseq git --path <Repo/dir containing repos>This adds the project to the $HOME/Documents/Agenda/projects/.PROJECTS_META.json file.
To list added projects:
goseq git listOpens the names of the joined files inside the editor, removing those deleted in the document by the user.
goseq git delete GoSeq finds and tracks TODOs in your project, compares them with existing TODOs, and pushes any new issues to GitHub.
The urgency system is adapted from the Fixmee Emacs extension.
The urgency of a TODO is indicated by repeating the final character of the keyword (e.g., TODOOOO for a critical issue). The scan command sorts TODOs based on their urgency.
Search for TODOs in the provided directory and generate a report:
goseq git scan -p <Repo/dir containing repos>- Add the project to the known project list after scanning:
goseq git scan -a -p <Repo/dir containing repos>Project: DnFreddie/Blog
------------------------------
Location: drive.svelte
TODO: Fix the animation on the banner
Line: 2
Urgency: 5
------------------------------Post new TODO issues to GitHub
This will check weather todos already exist on the github.
Then ask you do you want to push them.
And push the ones that do not exist.
goseq git post -p <path/to/the/repo>
For help with any commands, simply run goseq without arguments:
goseqGoSeq uses lock files stored in /tmp/. If the program stops with the message log not acquired, you may need to delete the lock manually or reboot the system.
Lock Files:
/tmp/.goseq_delete.lock/tmp/.goseq_project_delete.lock/tmp/.goseq_join.lock/tmp/.goseq_project_join.lock