https://github.com/tahul/journapi-cli
👩💻 Write in your bullet journal through CLI
https://github.com/tahul/journapi-cli
bullet-journal cli
Last synced: over 1 year ago
JSON representation
👩💻 Write in your bullet journal through CLI
- Host: GitHub
- URL: https://github.com/tahul/journapi-cli
- Owner: Tahul
- License: mit
- Created: 2020-05-08T12:25:17.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-05-10T16:17:48.000Z (about 6 years ago)
- Last Synced: 2024-10-19T04:27:02.391Z (over 1 year ago)
- Topics: bullet-journal, cli
- Language: JavaScript
- Homepage: https://journapi.app
- Size: 90.8 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
Journapi CLI
Write your in your bullet journal through CLI. 👨💻
This is my first CLI, if you have any advice, you can open an issue! :)
## 💻 Stack
I'm using the following libraries / templates:
- [NodeJS CLI Boilerplate](https://github.com/sindresorhus/node-cli-boilerplate)
- [Meow](https://github.com/sindresorhus/meow)
- [Terminal Kit](https://www.npmjs.com/package/terminal-kit)
- [Axios](https://github.com/axios/axios)
## ⌨️ Install
```
$ npm install --global journapi-cli
```
## 🛠 Usage
```bash
$ journal --help
📓 Usage:
$ journal Your message
🛠 Options:
--site Open the web app
--help Show the help of your journal
--key Set the API key for this CLI
--api Set the API url for this CLI
--list Read your journal from this CLI
👁 Examples:
$ journal --key Mrq5wMtD1yMX6gh694ORhgtxaYZtkAFWX3pko4Do // This is a dummy key.
$ journal --api https://myjournapiinstance.com/api // Your self-hosted URL; the default is already set.
$ journal I learned how to create a CLI
```
## 🔗 Others links
- 🎩 [Alfred Workflow](https://www.notion.so/Journapi-Alfred-workflow-5af3174c7e174b9d8f9a823570dd529b)
- ⌨️ [The API](https://github.com/Tahul/journapi)
- 🐦 [Twitter](https://twitter.com/yaeeelglx)