Skip to content
/ notidb Public

CLI tool which simplifies adding entries to Notion databases

License

Notifications You must be signed in to change notification settings

ChmaraX/notidb

Repository files navigation

Nest Logo

NotiDB is a command line tool which simplifies the process of adding entries to a Notion database.

Description

This tool was mostly created as a way to quickly add entries to a database without having to open Notion and navigate to the database.

Its effective for things like quickly adding ad-hoc tasks, ideas, notes, todos, etc.

demo_2

Installation

Homebrew

brew tap chmarax/chmarax
brew install notidb

Go

go install github.com/ChmaraX/notidb

Or download binaries from the releases

Usage

Notion API

NotiDB uses the Notion API to interact with your Notion workspace. You will need to create an integration in your Notion workspace and obtain an API key.

  1. Go to Notion's My Integrations page and click on "New integration".
  2. Give your integration a name and click "Submit".
  3. Copy the "Internal Integration Secret" (this is your API key).
  4. Go to any of your Notion databases you want to interact with in your workspace
  5. Click on the 3 dots in the top right corner of the database and select "Add connection", then select the name of the integration you just created.

Initialize NotiDB with your API key:

notidb init

NotiDB is now ready to use.

Default database

You set a default database to use with NotiDB at the init step. You can change the default database at any time by running the following command:

notidb sd

demo_3

This command will list all the allowed (connected) databases in your workspace.

Adding entries

Adding a new entry, providing a title and a content/body:

notidb add -t "Title" -c "Content"

# shorthands
notidb a -t "Title" -c "Content"
notidb a "Title" "Content"

demo_2

Adding a new entry using form generated from the database schema:

notidb add # this will prompt you to fill in the fields

demo_1

Currently, NotiDB supports the following Notion API field types:

  • Title
  • Rich text
  • Select
  • Multi-select
  • Date
  • Checkbox
  • Number
  • Email
  • Phone number