{"id":16209473,"url":"https://github.com/alichtman/fzf-notes","last_synced_at":"2025-03-19T08:31:04.810Z","repository":{"id":111159659,"uuid":"198810660","full_name":"alichtman/fzf-notes","owner":"alichtman","description":"A bash script combining fzf and vim for quickly editing your notes.","archived":false,"fork":false,"pushed_at":"2023-04-07T04:44:51.000Z","size":1658,"stargazers_count":30,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-28T16:59:07.104Z","etag":null,"topics":["cli","fzf","notes","notes-app","vim"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alichtman.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2019-07-25T10:31:18.000Z","updated_at":"2025-02-08T15:42:48.000Z","dependencies_parsed_at":null,"dependency_job_id":"6d4c84ba-9bee-48b6-b8ee-fee0820919b4","html_url":"https://github.com/alichtman/fzf-notes","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alichtman%2Ffzf-notes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alichtman%2Ffzf-notes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alichtman%2Ffzf-notes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alichtman%2Ffzf-notes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alichtman","download_url":"https://codeload.github.com/alichtman/fzf-notes/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243976478,"owners_count":20377691,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["cli","fzf","notes","notes-app","vim"],"created_at":"2024-10-10T10:29:50.161Z","updated_at":"2025-03-19T08:31:04.805Z","avatar_url":"https://github.com/alichtman.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# fzf-notes\n\n![demo](img/demo.png)\n\nThis script was originally written by Casey Brant, and explained in his blog post [Simple Notes Taking with `fzf` and `vim`](https://medium.com/adorableio/simple-note-taking-with-fzf-and-vim-2a647a39cfa).\n\nI've modified and extended it to better suit my note taking style. It now supports the usage of multiple notebooks. Once a notebook is open, the file selector loops which allows you to jump from file to file quickly.\n\n## Usage\n\n```bash\nfzf-notes [OPTIONS]\n     fzf-integrated notetaking.\n     Running this command without any arguments will open your default journal.\n     Written by Aaron Lichtman: https://github.com/alichtman/fzf-notes\n\nOptions:\n  -b                   browse notebooks\n  -c                   show config file path\n  --edit-config, -C    edit config\n  --help, -h           show this help text\n  -n                   open notebook by name\n  -s                   search for file in notebook\n```\n\nOnce installed, simply run `$ fzf-notes`. You will be led through the set up process the first time you run the program.\n\nYou can create new files by selecting `CREATE_NEW_FILE` at the menu.\n\n## Dependencies\n\n**macOS**\n\n- `bash`\n    - Tested on `v5.0`. macOS ships with an ancient version of bash, so if you're having issues running this, try upgrading to a more recent version.\n- [`fzf`](https://github.com/junegunn/fzf)\n    - `$ brew install fzf`\n- [`yq`](https://github.com/mikefarah/yq/)\n    * `$ brew install yq` (`v4` required)\n- [`gnu-getopt`](https://formulae.brew.sh/formula/gnu-getopt)\n    * `$ brew install gnu-getopt`\n    * Make sure to follow the post-install instructions.\n\n## Installation\n\n```bash\n$ git clone git@github.com:alichtman/fzf-notes.git\n$ cd fzf-notes\n$ chmod +x fzf-notes \u0026\u0026 cp fzf-notes /usr/local/bin/fzf-notes\n```\n\nTo update `fzf-notes`, come back to the directory you've cloned this repo into and run `$ git pull origin master`.\n\n## Configuration\n\n`fzf-notes` follows the [`XDG` spec](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html). The configuration file can be found at `$XDG_CONFIG_HOME/fzf-notes` if `$XDG_CONFIG_HOME` is set or `~/.config/fzf-notes`, otherwise.\n\nIt's a `YAML` file with the following structure:\n\n```yaml\nnotebooks:\n  default: ~/notes\n  non-default: /Users/alichtman/notes2\n  ...\n```\n\nBoth absolute and tilde-prepended paths are valid. A trailing forward slash is also valid.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falichtman%2Ffzf-notes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falichtman%2Ffzf-notes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falichtman%2Ffzf-notes/lists"}