https://github.com/marcusleonas/notebutler
A simple CLI tool to manage your notes.
https://github.com/marcusleonas/notebutler
cli golang markdown notes-tool
Last synced: 11 months ago
JSON representation
A simple CLI tool to manage your notes.
- Host: GitHub
- URL: https://github.com/marcusleonas/notebutler
- Owner: marcusleonas
- License: mit
- Created: 2024-03-30T19:41:50.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-31T13:01:37.000Z (about 2 years ago)
- Last Synced: 2024-04-28T13:36:58.606Z (almost 2 years ago)
- Topics: cli, golang, markdown, notes-tool
- Language: Go
- Homepage: https://marcusleonas.github.io/notebutler/
- Size: 434 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Read the docs
# Notebutler
A little cli tool to manage your notes. Written in Golang.
## Installation
Download the binary from the [releases page](https://github.com/marcusleonas/notebutler/releases) and put it somewhere in your `$PATH`.
## Usage
### Initialise a notebook:
```sh
notebutler init
```
### Create a new note
```sh
notebutler new
```
**Flags:**
(all flags are optional)
- `-n, --name`: Name of the note.
- `-t, --template`: Template to use for the note (found inside `.notebutler/templates`). Do not include the `.md` extension. Defaults to `default`.
- `-o, --open`: Open the file in the default editor after creation. Defaults to `false`.
### Read a note
```sh
notebutler read
```
## Build
Install [Go](https://golang.org/doc/install).
### For current architecture
```sh
go build .
```
### For all architectures
```sh
./build.sh github.com/marcusleonas/notebutler
```
## License
Licensed under the MIT License. See [LICENSE](LICENSE) for details.