{"id":21637786,"url":"https://github.com/elitalpa/creanote","last_synced_at":"2025-05-07T11:21:23.669Z","repository":{"id":264512628,"uuid":"893518973","full_name":"elitalpa/creanote","owner":"elitalpa","description":"Easily create organized notes.","archived":false,"fork":false,"pushed_at":"2025-01-13T22:49:52.000Z","size":85,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-30T22:39:49.928Z","etag":null,"topics":["bash","cli","command-line","local-first","markdown","note-taker","note-taking","notes","productivity","shell"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/creanote","language":"TypeScript","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/elitalpa.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","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":"2024-11-24T16:47:34.000Z","updated_at":"2025-01-23T09:44:20.000Z","dependencies_parsed_at":null,"dependency_job_id":"a105e840-ba7c-4b0c-96be-a82ef7b70b3f","html_url":"https://github.com/elitalpa/creanote","commit_stats":null,"previous_names":["elitalpa/creanote"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elitalpa%2Fcreanote","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elitalpa%2Fcreanote/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elitalpa%2Fcreanote/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elitalpa%2Fcreanote/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/elitalpa","download_url":"https://codeload.github.com/elitalpa/creanote/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252866118,"owners_count":21816396,"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":["bash","cli","command-line","local-first","markdown","note-taker","note-taking","notes","productivity","shell"],"created_at":"2024-11-25T04:06:57.477Z","updated_at":"2025-05-07T11:21:23.638Z","avatar_url":"https://github.com/elitalpa.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# creanote\n\nEasily create organized notes.\n\n## About\n\nStoring notes in a plain text format like markdown ensures simplicity, portability, and long-term access without the risk of lock-in. It’s flexible, supported by many tools, and easy to move across systems.\n\nCreanote helps you create and manage your notes.\n\n## Get it\n\n### Requirements\n\n- install node (v20 LTS or higher) : [nodejs.org/en/download/prebuilt-binaries](https://nodejs.org/en/download/prebuilt-binaries)\n\n- npm is included with node\n\nCheck if it's installed and which version you have :\n\n```sh\nnode -v  # v20 or higher\nnpm -v   # make sure it's up to date\n```\n\n### Install\n\nYou can either use creanote with `npx` (without installing it) :\n\n```sh\nnpx creanote --help\n```\n\nor you can install it and have it available on your system with :\n\n```sh\nnpm install -g creanote\ncreanote --help\n```\n\n## Usage\n\n### help\n\nUse the `--help` option to see available commands.\n\n```sh\ncreanote --help\n```\n\n### initialize\n\nFirst, you will need to go to the directory of your notes and initialize creanote with :\n\n```sh\ncreanote init\n```\n\nThis will create a hidden `.creanote` directory with the following structure :\n\n```txt\n.creanote/\n├── config.json   # info and settings for creanote\n└── templates/\n    ├── daily.md  # default template for daily notes\n    └── note.md   # default template for regular notes\n```\n\n### add\n\nUse the `add` command to add a daily note or a regular note.\n\n```sh\ncreanote add note # will add a file as 2024-12-02.md\ncreanote add daily # will add a file in daily/2024/2024-12/week-49/2024-12-02.md\n```\n\n### daily notes\n\nThe goal of the `add daily` command is to end up with a structure similar to this for your daily notes :\n\n```\ndaily\n├── 2023\n│   ├── 2023-01\n│   ├── 2023-02\n│   ├── ...\n│   └── 2023-12\n├── 2024\n│   ├── 2024-01\n│   ├── 2024-02\n│   ├── ...\n│   └── 2024-12\n│       ├── week-49\n│       ├── week-50\n│       ├── week-51\n│       │   ├── 2024-12-16.md\n│       │   ├── ...\n│       │   └── 2024-12-22.md\n│       └── week-52\n│           ├── 2024-12-23.md\n│           ├── 2024-12-24.md\n│           ├── 2024-12-25.md\n│           ├── 2024-12-26.md\n│           ├── 2024-12-27.md\n│           ├── 2024-12-28.md\n│           └── 2024-12-29.md\n```\n\n### config\n\nYou can change the paths of the templates used and where the notes are created in the `.creanote/config.json` file :\n\n```json\n{\n  \"info\": {\n    ...\n  },\n  \"settings\": {\n    \"templatePath\": {\n      \"daily\": \".creanote/templates/daily.md\",\n      \"note\": \".creanote/templates/note.md\"\n    },\n    \"addPath\": {\n      \"daily\": \"./notenv-v/daily\",\n      \"note\": \"./notenv-v\"\n    }\n  }\n}\n```\n\n## Contributing\n\nPlease read the [CONTRIBUTING.md](CONTRIBUTING.md) guide.\n\n## License\n\nBuilt by [@elitalpa](https://github.com/elitalpa).  \nLicensed under the [MIT license](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felitalpa%2Fcreanote","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felitalpa%2Fcreanote","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felitalpa%2Fcreanote/lists"}