{"id":17036846,"url":"https://github.com/pg07codes/gitn","last_synced_at":"2025-04-12T13:20:33.463Z","repository":{"id":46642481,"uuid":"273474230","full_name":"pg07codes/gitn","owner":"pg07codes","description":"a super simple cross-platform command line note taking application that makes life much more easier","archived":false,"fork":false,"pushed_at":"2023-07-11T03:26:02.000Z","size":198,"stargazers_count":3,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-26T07:51:16.262Z","etag":null,"topics":["cmdline","command-line-tool","cross-platform","git","gitn","note-managment","notes"],"latest_commit_sha":null,"homepage":"https://npmjs.com/package/gitn","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/pg07codes.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":"2020-06-19T11:10:25.000Z","updated_at":"2022-09-14T03:37:42.000Z","dependencies_parsed_at":"2022-09-23T04:40:33.618Z","dependency_job_id":null,"html_url":"https://github.com/pg07codes/gitn","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pg07codes%2Fgitn","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pg07codes%2Fgitn/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pg07codes%2Fgitn/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pg07codes%2Fgitn/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pg07codes","download_url":"https://codeload.github.com/pg07codes/gitn/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248111975,"owners_count":21049578,"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":["cmdline","command-line-tool","cross-platform","git","gitn","note-managment","notes"],"created_at":"2024-10-14T08:52:10.575Z","updated_at":"2025-04-12T13:20:33.407Z","avatar_url":"https://github.com/pg07codes.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://user-images.githubusercontent.com/34238240/86224948-2bfaa300-bba7-11ea-9ceb-41f80a4c3744.png\" alt=\"gitnLogo\"\u003e\n\u003c/p\u003e\n\n\u003e a super simple cross-platform command line note taking application that makes life much more easier\n\n## What exactly is `gitn` ?\n- If you work on **CLI** a lot and don't want to waste your time managing your notes from anywhere but the **command line**\n- `gitn` follows the same commands as `git` and so there is nothing new to know or learn. Just install and use.\n\n## Installation and Usage\n```\n\u003e\u003e\u003e npm install -g gitn \n\n\u003e\u003e\u003e gitn config -g '/absolute/path/to/your/notes/directory/where-gitn-will-save-notes'\n\n\u003e\u003e\u003e gitn --help  // to know all the commands that gitn offers \n\n```\n\n## What you mean exactly by `similar to git`  ?\n\n- Firstly dont confuse gitn for some **Version Control System** . It follows same commands as git and is a powerful notes manager for folks who :heart: **CLI** but apart from it , it is not related to vcs.\n- This illustration will make it much more clear on how commands for `gitn` are similar to `git` and what it means when you create a branch/commit in **gitn**\n\n![GIT GITN equivalence](https://user-images.githubusercontent.com/34238240/86394990-1d061480-bcbd-11ea-9447-ec743834bf5d.png)\n\n###  Now, have a look at the **gitn**  commands ( same as git isn't it ?)\n\n![cmdline](https://user-images.githubusercontent.com/34238240/86395175-71a98f80-bcbd-11ea-8e60-5f8b89079499.png)\n\n\n## Simple Internals\n- gitn maintains a root directory (which you specify using `gitn config -g \u003cabsolute-path-to-root-directory\u003e`) for your notes and maintains text files for your branches in this root directory.\n- This makes it easy to access the notes through any text editor in case you need to.\n- In case you don't feel like using gitn anymore, just uninstall it. Your notes are always there.\n- Have a look at it in this pic (root directory with `.txt` files  )\n![notes-folder](https://user-images.githubusercontent.com/34238240/86396157-082a8080-bcbf-11ea-8891-18b70912db1c.png)\n\n## Commands \nAs of now, gitn supports the following commands \n- gitn config - to update configuration parameters\n- gitn status - to see which branch user is currently on\n- gitn commit - to add a new commit (aka note) to the branch user is currently on\n- gitn log - to view all commits (allows for searching using grep) \n- gitn branch - to view/create/delete branches(aka text-files)\n- gitn checkout - to switch to a different branch ( use -b flag to create and switch)\n- gitn rebase - select specific commits to be deleted from current branch \n- gitn reset - to delete all commits from current branch \n- gitn merge - to merge two branches (and their commits) onto a single branch\n\n## TODOS \n- [X]  git like command line API (version 0.1.0)\n- [X]  allow for notes searching using words or RegEx\n- [ ]  allow for users to encrypt notes \n- [ ]  add date to each note to allow for date based searching\n- [ ]  allow for adding notes to any directory using `git init` and `git add` commands \n- [ ]  and many many more . Make an issue if you think a feature is cool enough to be added to gitn\n\n\n## Developed and Maintained By \n- Pranav Gupta\n- If you like it, consider :star: ing this repo  :smile: \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpg07codes%2Fgitn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpg07codes%2Fgitn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpg07codes%2Fgitn/lists"}