Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arandilopez/noteesh
Manage notes in command line
https://github.com/arandilopez/noteesh
cli crystal notes todolist
Last synced: 30 days ago
JSON representation
Manage notes in command line
- Host: GitHub
- URL: https://github.com/arandilopez/noteesh
- Owner: arandilopez
- License: mit
- Created: 2017-10-03T03:58:50.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2017-10-12T02:18:41.000Z (about 7 years ago)
- Last Synced: 2024-08-03T17:12:33.093Z (4 months ago)
- Topics: cli, crystal, notes, todolist
- Language: Crystal
- Homepage:
- Size: 11.7 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-crystal - noteesh - Notes and Todo list in command line (Cli Utils)
README
# Noteesh
Tracking notes in your command line
## Installation
### Build from code source
**You should have the crystal compiler installed** check it out [here](https://crystal-lang.org/docs/installation/)
1. Clone this repo
```
$ cd some/path
$ git clone https://github.com/arandilopez/noteesh.git
$ cd noteesh/
```
2. Run make commands
```
$ sudo make
# then run
$ sudo make install
```
## Update
- If you cloned the repo, pull new changes
```
$ cd path/to/noteesh
$ git pull origin master
$ sudo make reinstall
```
## Usage
- Check your notes
```
$ noteesh
```
- Add a new note
```
$ noteesh --add "Buy a coke"
```
- Mark a note as done
```
$ noteesh --done 1
```
- Clear your notes
```
$ noteesh --clear
```
## Development
Run the make command to compile as development
```
$ make compile
# then run the bin file
$ bin/noteesh
```
Run make test to run a build and specs
```
$ make test
```
## Contributing
1. Fork it ( https://github.com/arandilopez/noteesh/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request
## Contributors
- [@arandilopez](https://github.com/arandilopez) Arandi Lopez - creator, maintainer