{"id":18632206,"url":"https://github.com/splode/jin","last_synced_at":"2025-04-11T07:30:52.890Z","repository":{"id":87648477,"uuid":"128665034","full_name":"Splode/jin","owner":"Splode","description":"A CLI app for taking simple notes without ever leaving the terminal.","archived":false,"fork":false,"pushed_at":"2019-01-07T19:45:13.000Z","size":725,"stargazers_count":12,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-25T10:42:37.867Z","etag":null,"topics":["cli","nodejs","notes","notes-app","terminal","terminal-app"],"latest_commit_sha":null,"homepage":"","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/Splode.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":"2018-04-08T17:25:10.000Z","updated_at":"2024-04-16T16:53:17.000Z","dependencies_parsed_at":null,"dependency_job_id":"75cf00ed-a16f-4194-ad90-c902991da7b6","html_url":"https://github.com/Splode/jin","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/Splode%2Fjin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Splode%2Fjin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Splode%2Fjin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Splode%2Fjin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Splode","download_url":"https://codeload.github.com/Splode/jin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248358835,"owners_count":21090442,"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","nodejs","notes","notes-app","terminal","terminal-app"],"created_at":"2024-11-07T05:10:40.468Z","updated_at":"2025-04-11T07:30:52.865Z","avatar_url":"https://github.com/Splode.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://github.com/Splode/jin/raw/master/.github/jin-icon--color.png\" height=\"150\"/\u003e\n\u003c/p\u003e\n\n# jin\n\n*A CLI app for taking simple notes without ever leaving the terminal.*\n\n\u003c!-- ![jin screenshot](https://github.com/Splode/jin/raw/master/.github/jin-ss.png) --\u003e\n\n## Overview\n\njin allows you to take and organize simple notes without ever leaving the command line. Capture ideas, track tasks, and reference code snippets with straightforward and intuitive commands.\n\n## Table of contents\n\n* [Overview](#overview)\n* [Installation](#installation)\n* [Usage](#usage)\n* [Related](#related-projects)\n* [License](#license)\n\n## Installation\n\n```bash\n$ npm install --global jin-app\n```\n\n## Usage\n\n### Commands\n\n* [`add`](#add-note)\n* [`list`](#list-notes)\n* [`edit`](#edit-note)\n* [`remove`](#remove-note)\n* [`export`](#export-notes)\n* [`help`](#help)\n\u003c!-- * [`backup`](#backup) --\u003e\n\n### Add Note\n\n```bash\n# Add a new note to an existing notebook.\n# If the notebook does not exist, it will be created.\n\n$ jin add [notebook] \u003cnote\u003e\n# jin a [notebook] \u003cnote\u003e\n```\n\n```bash\n# Create a new, empty notebook.\n\n$ jin add [notebook]\n# jin a [notebook]\n```\n\n\u003e Note: a notebook name is required.\n\n#### Example\n\n```console\n$ jin add nodejs \"Use 'util.promisify()' to promisify a callback-style function.\"\n\n    ✔ Added \"Use 'util.promisify()' to promisify a callback-style function.\" to \"nodejs\".\n```\n\n### List Notes\n\n```bash\n# List all notes in the given notebook.\n# Pass the --long|-l option to get detailed information.\n\n$ jin list [options] [notebook]\n# jin ls [options] [notebook]\n```\n\n```bash\n# List all notebooks.\n# Pass the --long|-l option to get detailed information.\n\n$ jin list [options]\n# jin ls [options]\n```\n\n#### Example\n\n```console\n$ jin list nodejs\n\n    nodejs Notes\n    ----------------\n    0   Use 'os.homedir()' to access the home directory.\n    1   Use 'util.promisify()' to promisify a callback-style function.\n```\n\n### Edit Note\n\n```bash\n# Edit the contents of a note at the given index of a given notebook.\n\n$ jin edit \u003cnotebook\u003e \u003cindex\u003e\n# jin ed \u003cnotebook\u003e \u003cindex\u003e\n```\n\n### Remove Note\n\n```bash\n# Remove a note at the given index of a given notebook.\n\n$ jin remove [notebook] \u003cindex\u003e\n# jin rm [notebook] \u003cindex\u003e\n```\n\n```bash\n# Remove a given notebook.\n\n$ jin remove [notebook]\n# jin rm [notebook]\n```\n\n\u003e Note: You must pass in the `--force` flag when attempting to remove a notebook that contains notes.\n\n#### Examples\n\n```console\n$ jin remove nodejs 0\n\n    ✔ Removed note at index 0 from nodejs notebook.\n```\n\n```console\n$ jin rm --force nodejs\n\n    ✔ Removed nodejs notebook.\n```\n\n\u003c!-- ### Backup --\u003e\n\n\u003c!-- WIP --\u003e\n\n### Export Notes\n\n```bash\n# Create an exports of the notes collection in the current directory.\n\n$ jin export\n# jin exp\n```\n\n\u003e The notes collection is stored in the user's home directory by default.\n\n### Help\n\n```bash\n# Display general help output.\n\n$ jin --help\n# jin -h\n```\n\n```bash\n# Display command-specific help output.\n\n$ jin [cmd] --help\n```\n\n## Related Projects\n\n* [Dnote](https://github.com/dnote-io/cli)\n* [Idea](https://github.com/IonicaBizau/idea)\n\n## License\n\nMIT \u0026copy; [Christopher Murphy](https://github.com/splode)\n\n[⬆ **Back to Top**](#jin)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsplode%2Fjin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsplode%2Fjin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsplode%2Fjin/lists"}