Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/chmarax/notidb

CLI tool which simplifies adding entries to Notion databases
https://github.com/chmarax/notidb

cli go golang notion notion-api notion-integrations tui

Last synced: about 1 month ago
JSON representation

CLI tool which simplifies adding entries to Notion databases

Host: GitHub
URL: https://github.com/chmarax/notidb
Owner: ChmaraX
License: mit
Created: 2024-02-09T16:18:42.000Z (11 months ago)
Default Branch: main
Last Pushed: 2024-11-12T11:02:25.000Z (about 1 month ago)
Last Synced: 2024-11-12T12:18:07.893Z (about 1 month ago)
Topics: cli, go, golang, notion, notion-api, notion-integrations, tui
Language: Go
Homepage:
Size: 4.31 MB
Stars: 4
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

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](imgs/demo_2.gif)

## Installation

### Homebrew

```bash
brew tap chmarax/chmarax
brew install notidb
```

### Go

```bash
go install github.com/ChmaraX/notidb
```

Or download binaries from the [releases](https://github.com/ChmaraX/notidb/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](https://www.notion.so/my-integrations) 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:

```bash
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:

```bash
notidb sd
```

![demo_3](imgs/demo_3.gif)

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:

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

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

![demo_2](imgs/demo_2.gif)

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

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

![demo_1](imgs/demo_1.gif)

Currently, NotiDB supports the following Notion API field types:

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