{"id":36454940,"url":"https://github.com/mcbattirola/gitnotes","last_synced_at":"2026-01-11T23:02:11.521Z","repository":{"id":50620515,"uuid":"496382745","full_name":"mcbattirola/gitnotes","owner":"mcbattirola","description":"Git-aware note taking","archived":false,"fork":false,"pushed_at":"2024-12-12T12:19:00.000Z","size":112,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-12T13:25:11.953Z","etag":null,"topics":["git","notes"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mcbattirola.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-25T20:37:48.000Z","updated_at":"2024-12-12T12:18:58.000Z","dependencies_parsed_at":"2023-11-07T20:40:46.799Z","dependency_job_id":"f9a9acba-5bac-4e98-82de-172eb7463a75","html_url":"https://github.com/mcbattirola/gitnotes","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mcbattirola/gitnotes","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcbattirola%2Fgitnotes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcbattirola%2Fgitnotes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcbattirola%2Fgitnotes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcbattirola%2Fgitnotes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mcbattirola","download_url":"https://codeload.github.com/mcbattirola/gitnotes/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcbattirola%2Fgitnotes/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28326166,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-11T22:11:01.104Z","status":"ssl_error","status_checked_at":"2026-01-11T22:10:58.990Z","response_time":60,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["git","notes"],"created_at":"2026-01-11T23:02:11.378Z","updated_at":"2026-01-11T23:02:11.511Z","avatar_url":"https://github.com/mcbattirola.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gitnotes :notebook:\n\ngitnotes is a simple git-aware notes manager. It makes taking notes easy while working on multiple projects/branchs by opening the correct note when you run `gn edit`.\n\ngitnotes will use your own text editor, and save notes as regular files in the default directory `$HOME/gitnotes`.\n\n```bash\n# example usage\n$ cd my-project # on branch main of my-project-\n\n$ gn edit # opens my-project/main note on editor\n\n$ git checkout -b another-branch\n\n$ gn edit # opens my-project/another-branch note\n\n$ git checkout main\n\n$ gn edit # back to notes of my-project/main\n\n$ vim $(gn path) # opens directory of all notes\n```\n\n## Usage\n\nThe most common use is to just `gn edit`, take notes and save. Later, you may checkout another branch or work on another project, then you just `gn edit` again and take notes. Once you go back to the original project/branch, your notes are stored and you can pick up from where you left.\n\nYou can use the flags `-b` and `-p` to edit notes from a different branch and project, respectivelly. If you just want to read the notes in the terminal without opening an editor, you can use `gn print` instead of `gn edit`.\n\nAll your notes will be stored in `$HOME/gitnotes` (by default), making them easy to version. gitnotes comes with commands to help you version your own notes on git, like `gn pull`, `gn commit` and `gn push`.\n\nIf you try to run `gn edit` on a directory that is not a git repository without providing a project and branch, it will error.\n\nRun `gn help` for more details.\n\n```bash\nusage: gn [-d] \u003ccommand\u003e \u003cargs\u003e\nAvailable commands:\n- edit: edit the git note\n- push: push notes to remote\n- pull: pull notes from remote\n- commit: commit notes\n- path: prints the notes path to stdio\n- print: prints the note to stdio\n- delete: delete notes\nrun 'gn [command] -h' for more details on each command\n```\n\n## Instalation\n\nDependencies:\n\n- Golang (building)\n- git\n\n1. Download source code\n\n```bash\ngit clone https://github.com/mcbattirola/gitnotes.git\n```\n\n2. Build and install\n\n```bash\nmake install\n```\n\nThis will build the binary and move it to `/usr/local/bin/gn`. You can run `make build` and move `./dist/gn` to another directory if you prefer.\n\n## Config file\n\ngitnotes will create a config file if it doesn't find `$HOME/.config/gitnotes/gn.conf`.\n\n### Default config file\n\n```bash\neditor=vim # binary name of the code editor (e.g. code, gedit, nvim, nano)\nnotes=$HOME/gitnotes # path in which notes will be stored\nalways-commit=false # commit after each `gn edit` (true/false)\n```\n\n## Troubleshooting\n\nIf you have problems running `gn push` to github, try running the following:\n\n```bash\nssh-keyscan -t rsa github.com \u003e ~/.ssh/known_hosts\nssh-keyscan -t ecdsa github.com \u003e\u003e ~/.ssh/known_hosts\n```\n\nSee [this](https://github.com/go-git/go-git/issues/411) issue for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmcbattirola%2Fgitnotes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmcbattirola%2Fgitnotes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmcbattirola%2Fgitnotes/lists"}