https://github.com/stackclash/exobrain-util
A CLI tool to help automate my second brain
https://github.com/stackclash/exobrain-util
Last synced: 3 months ago
JSON representation
A CLI tool to help automate my second brain
- Host: GitHub
- URL: https://github.com/stackclash/exobrain-util
- Owner: Stackclash
- License: unlicense
- Created: 2023-02-07T16:04:21.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-07T16:13:41.000Z (over 2 years ago)
- Last Synced: 2025-01-27T23:18:46.029Z (4 months ago)
- Language: JavaScript
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# exobrain-util
This project is a command line utility to help automate parts of my second brain (exobrain) in Notion.
## Usage
The CLI requires a Notion integration secret to connect to Notion through the API. You can create one [here](https://www.notion.so/my-integrations).
`node exobrain-util.js [options] [command]`
```bash
Usage: exobrain-util [options] [command]
CLI to help automate aspects of my exobrain in Notion
Options:
-V, --version output the version number
-n, --notion-secret Required: Notion integration secret (env: NOTION_SECRET)
--reviews-id Required: The Notion database id of the Reviews database (env: REVIEWS_DB_ID)
--daily-tracking-id Required: The Notion database id of the Daily Tracking database (env: DAILY_TRACKING_DB_ID)
-h, --help display help for command
Commands:
daily [options] [date] Create a new record in Daily Tracking
review [options] [date] Create a weekly, monthly, and quarterly review if they do not exist
help [command] display help for command
```
## Available Actions
Currently there are two available commands: `daily` and `review`.
Both of these commands will not create new records if it finds that one already exists.
### Daily Command
The `daily` command takes a date argument and creates a record in the Daily Tracking Notion Database. After the new record is created or an existing one is found for the given date It connects it to the appropriate Weekly Review record. If a Weekly Review record is not found one is created.
```bash
Usage: exobrain-util daily [options] [date]
Create a new record in Daily Tracking
Arguments:
date Date string formatted as YYYY-MM-DD (default: "2023-02-06T17:37:13.955Z")
Options:
--no-review Skip connecting weekly review to new Daily Tracking Record
-h, --help display help for command
```
### Review Command
The `review` command sets up the hierarchy of Reviews in my Notion workspace. There are three different types: `weekly`, `monthly`, and `quarterly`. This command creates Review records of the type you specify unless one is already found. It then connects them together as `weekly->monthly->quarterly`. If you need to connect two records together ie. weekly and monthly, but they already exists run: `node exobrain-util.js review [date] -t weekly monthly` and it will find these two records and connect them.
```bash
Usage: exobrain-util review [options] [date]
Create a weekly, monthly, and quarterly review if they do not exist
Arguments:
date Date string formatted as YYYY-MM-DD (default: "2023-02-06T17:42:16.931Z")
Options:
-t, --type [type...] The type of Review to create (choices: "weekly", "monthly", "quarterly", default: ["weekly","monthly","quarterly"])
-h, --help display help for command
```