{"id":17617370,"url":"https://github.com/gumieri/note","last_synced_at":"2025-04-30T18:12:17.665Z","repository":{"id":57516218,"uuid":"130412772","full_name":"gumieri/note","owner":"gumieri","description":"Quick and easy Command-line tool for taking notes.","archived":false,"fork":false,"pushed_at":"2018-08-27T17:18:56.000Z","size":31,"stargazers_count":51,"open_issues_count":1,"forks_count":1,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-30T18:12:12.089Z","etag":null,"topics":["cli-tool","command-line-tool","go","golang","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/gumieri.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-04-20T20:52:06.000Z","updated_at":"2024-09-08T22:06:46.000Z","dependencies_parsed_at":"2022-08-28T16:50:50.361Z","dependency_job_id":null,"html_url":"https://github.com/gumieri/note","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gumieri%2Fnote","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gumieri%2Fnote/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gumieri%2Fnote/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gumieri%2Fnote/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gumieri","download_url":"https://codeload.github.com/gumieri/note/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251758173,"owners_count":21638989,"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-tool","command-line-tool","go","golang","notes"],"created_at":"2024-10-22T19:13:09.244Z","updated_at":"2025-04-30T18:12:17.643Z","avatar_url":"https://github.com/gumieri.png","language":"Go","readme":"# Note\n\nQuick and easy Command-line tool for taking notes\n\n## Installation\n\n1. Download the executable for your Operating System at [note/releases](https://github.com/gumieri/note/releases/latest);\n2. Rename the executable to `note`;\n3. Place the executable in a directory loaded by the system ([about these directories](https://en.wikipedia.org/wiki/PATH_%28variable%29));\n4. Give it permission to be executable (only if you are using Mac OS or Linux).\n\nOr, if you are using a Mac OS or Linux, you can just execute the commands described at the [note/releases](https://github.com/gumieri/note/releases/latest).\n\n## Configurations\n\nThe default configuration is:\n```yml\neditor: vim\nnotePath: ~/Notes\n```\n\nYou can create a `.noteconfig.yml` (or json, or toml) in your home directory to o override these configurations.\nIf you create a configuration file in a specific directory, it will take priority over the default and the configuration in the home directory.\nAs well the `EDITOR` and `NOTE_PATH` environment variables has priority over these configuration files.\n\n## Usage\n\n```bash\nnote [just type a text] [or command] [with command options]\n```\n\nNote is very easy and simple to use.\nStart by typing `note` command and continue describing what you want to take as note:\n```bash\nnote there is no place like home\n```\n\nIf using special character, just use quotes or escape the character:\n```bash\nnote \"there's no place like home\"\n```\n```bash\nnote there\\'s no place like home\n```\n\nIt will create a file named `0 - there's no place like home` at the notePath.\nIn case of you need a text editor you can just type `note` without any argument.\nIt will open the `EDITOR` defined as environment variable or the configured one.\n\n#### Title\n\nTo define a title, just use the flag option `--title` (or `-t`).\nIf no title is informed, `note` will take some words from the first line as it.\nAll titles start with a number (integer) increasing by one from the last note for better identification.\n\n### Other commands\n\n#### Show\n\nShow a note content.\nIt will search for a note using the given arguments executing a fuzzy search:\n```\nnote show like home\n```\nIf it's your first note, you can surely show it by typing:\n```\nnote show 0\n```\nThe search is case insensitive, use the flag option `--case-sensitive` / `-s` if you want to match the case.\n\n#### Edit\n\nEdit a note content.\nLike the show command, will use the given arguments to search for a note but will open it content in your text editor.\n```\nnote edit 0\n```\n```\nnote e 0\n```\n\n#### Edit Note's title\n\nEdit the title of a note.\nIt's the edit command with `--title` / `-t` flag option.\nSo you can rename a note title:\n```\nnote edit --title renamed 0\n```\n```\nnote edit -t renamed 0\n```\n\n#### Delete\n\nDelete a note.\nLike show and edit, but delete a note.\nIt will ask for confirmation if not given the flag option `--yes` / `-y`.\n```\nnote delete 0\n```\n```\nnote del 0\n```\n```\nnote d 0\n```\n```\nnote rm 0\n```\n\n#### List\nList notes.\nHas no arguments. Simply list the notes at the `notePath`.\n```\nnote list\n```\n```\nnote ls\n```\n```\nnote l\n```\n\n## Code Status\n\n[![Go Report Card](https://goreportcard.com/badge/github.com/gumieri/note)](https://goreportcard.com/report/github.com/gumieri/note)\n[![Build Status](https://travis-ci.org/gumieri/note.svg?branch=master)](https://travis-ci.org/gumieri/note)\n\n\n## License\n\nNote is released under the [MIT License](http://www.opensource.org/licenses/MIT).\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgumieri%2Fnote","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgumieri%2Fnote","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgumieri%2Fnote/lists"}