{"id":16255633,"url":"https://github.com/JLiscom/OpenNote-CLI","last_synced_at":"2025-03-19T21:30:46.258Z","repository":{"id":148150550,"uuid":"115667285","full_name":"JLiscom/OpenNote-CLI","owner":"JLiscom","description":null,"archived":false,"fork":false,"pushed_at":"2018-07-04T20:03:09.000Z","size":56,"stargazers_count":4,"open_issues_count":2,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-28T23:21:23.643Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/JLiscom.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-12-28T23:25:56.000Z","updated_at":"2023-04-03T03:15:53.000Z","dependencies_parsed_at":"2023-05-19T08:00:41.753Z","dependency_job_id":null,"html_url":"https://github.com/JLiscom/OpenNote-CLI","commit_stats":null,"previous_names":["jliscom/opennote-cli"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JLiscom%2FOpenNote-CLI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JLiscom%2FOpenNote-CLI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JLiscom%2FOpenNote-CLI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JLiscom%2FOpenNote-CLI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JLiscom","download_url":"https://codeload.github.com/JLiscom/OpenNote-CLI/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244056406,"owners_count":20390719,"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":[],"created_at":"2024-10-10T15:43:31.536Z","updated_at":"2025-03-19T21:30:46.253Z","avatar_url":"https://github.com/JLiscom.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenNote CLI\n\nOpen Note CLI is, well, a CLI client for OpenNote.\n[OpenNote](https://github.com/FoxUSA/OpenNote/) is HTML5 progressive/Offline webapp that is: a minimal, text focused, note taking software that supports tree structures and tags. The datastore is CouchDB mostly because it take like 5 lines to have bi-directional sync.\n\n## Install\n\nThis is designed to be installed in your path. This is for multiple notebook support. Much like Git, to have another notebook just create another folder somewhere. The `.openNote` contains localDB and CouchDB replication url. Then install in your path\n```\nsudo cp opennote-cli-linux /usr/local/bin/opennote\nsudo cp -r node_modules/ /usr/local/bin/\n```\n\n## Help file\n```\nnode index.js\n\n   index.js 18.03.0-Alpha - CLI client for OpenNote\n\n   USAGE\n\n     index.js \u003ccommand\u003e [options]\n\n   COMMANDS\n\n     sync [mode]         Sync with CouchDB server                                             \n     config \u003curl\u003e        Creates .openNote folder and sets replication url required properties\n     delta                                                                                    \n     save                                                                                     \n     help \u003ccommand\u003e      Display help for a specific command                                  \n\n   GLOBAL OPTIONS\n\n     -h, --help         Display help                                      \n     -V, --version      Display version                                   \n     --no-color         Disable colors                                    \n     --quiet            Quiet mode - only displays warn and error messages\n     -v, --verbose      Verbose mode - will also output debug messages    \n\n```\n\n---\n\n## Example Workflow\n```\n# Setup\nnode index.js config http://admin:password@127.0.0.1:5984/opennote\n\n# Pull down files\nnode index.js sync write\n\n# Edit some files with your editor of choice.\nnano reallyCoolFolder/note.md\n\n# Show me my changes\nnode index.js delta\n\n# Save my changes into the local copy of the db\nnode index.js save\n\n# Sync my local db to the remote server\nnode index.js sync\n\n```\n\n---\n\n## FAQ\n### Can I use this without the web client or CouchDB?\nYou could but I have no idea why you would want to. Its basically Git without the branches. IE cookies without sugar. Whole idea is its an eco system. Read and modify notes if you are offline and sync them around.\n\n### Can you use Mongo as a datastore\nNo.\n\n### I don't like _______ please fix it!\nThis code is Open Source Software (OSS). You are welcome to take the code and fork it.\n\n\n### Fun use cases?\n- As a text editor, akin to notepad, in your browser!\n- Use with Git to allow history. Just do a `git init` in the parent folder and marvel at the `.git` and `.opennote` support folders.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJLiscom%2FOpenNote-CLI","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FJLiscom%2FOpenNote-CLI","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJLiscom%2FOpenNote-CLI/lists"}