https://github.com/elitalpa/creanote
Easily create organized notes.
https://github.com/elitalpa/creanote
bash cli command-line local-first markdown note-taker note-taking notes productivity shell
Last synced: 6 months ago
JSON representation
Easily create organized notes.
- Host: GitHub
- URL: https://github.com/elitalpa/creanote
- Owner: elitalpa
- License: mit
- Created: 2024-11-24T16:47:34.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-01-13T22:49:52.000Z (9 months ago)
- Last Synced: 2025-04-30T22:39:49.928Z (6 months ago)
- Topics: bash, cli, command-line, local-first, markdown, note-taker, note-taking, notes, productivity, shell
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/creanote
- Size: 83 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# creanote
Easily create organized notes.
## About
Storing 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.
Creanote helps you create and manage your notes.
## Get it
### Requirements
- install node (v20 LTS or higher) : [nodejs.org/en/download/prebuilt-binaries](https://nodejs.org/en/download/prebuilt-binaries)
- npm is included with node
Check if it's installed and which version you have :
```sh
node -v # v20 or higher
npm -v # make sure it's up to date
```
### Install
You can either use creanote with `npx` (without installing it) :
```sh
npx creanote --help
```
or you can install it and have it available on your system with :
```sh
npm install -g creanote
creanote --help
```
## Usage
### help
Use the `--help` option to see available commands.
```sh
creanote --help
```
### initialize
First, you will need to go to the directory of your notes and initialize creanote with :
```sh
creanote init
```
This will create a hidden `.creanote` directory with the following structure :
```txt
.creanote/
├── config.json # info and settings for creanote
└── templates/
├── daily.md # default template for daily notes
└── note.md # default template for regular notes
```
### add
Use the `add` command to add a daily note or a regular note.
```sh
creanote add note # will add a file as 2024-12-02.md
creanote add daily # will add a file in daily/2024/2024-12/week-49/2024-12-02.md
```
### daily notes
The goal of the `add daily` command is to end up with a structure similar to this for your daily notes :
```
daily
├── 2023
│ ├── 2023-01
│ ├── 2023-02
│ ├── ...
│ └── 2023-12
├── 2024
│ ├── 2024-01
│ ├── 2024-02
│ ├── ...
│ └── 2024-12
│ ├── week-49
│ ├── week-50
│ ├── week-51
│ │ ├── 2024-12-16.md
│ │ ├── ...
│ │ └── 2024-12-22.md
│ └── week-52
│ ├── 2024-12-23.md
│ ├── 2024-12-24.md
│ ├── 2024-12-25.md
│ ├── 2024-12-26.md
│ ├── 2024-12-27.md
│ ├── 2024-12-28.md
│ └── 2024-12-29.md
```
### config
You can change the paths of the templates used and where the notes are created in the `.creanote/config.json` file :
```json
{
"info": {
...
},
"settings": {
"templatePath": {
"daily": ".creanote/templates/daily.md",
"note": ".creanote/templates/note.md"
},
"addPath": {
"daily": "./notenv-v/daily",
"note": "./notenv-v"
}
}
}
```
## Contributing
Please read the [CONTRIBUTING.md](CONTRIBUTING.md) guide.
## License
Built by [@elitalpa](https://github.com/elitalpa).
Licensed under the [MIT license](./LICENSE).