# @maxklammer/surface-random-notion-note

> Will open a random notion note

Latest version **0.0.3** (published 2022-02-15) · UNLICENSED license · 0 weekly downloads

## Install

```sh
npm install @maxklammer/surface-random-notion-note
pnpm add @maxklammer/surface-random-notion-note
yarn add @maxklammer/surface-random-notion-note
bun add @maxklammer/surface-random-notion-note
```

Provides the commands `surface`, `surface-random-notion-note`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2022-02-15 |
| First published | 2022-02-12 |
| Weekly downloads | 0 |
| License | UNLICENSED |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Max Klammer |
| Maintainers | maxklammer |
| Keywords | surface-random-notion-note, Max Klammer |

## Links

- npm: https://www.npmjs.com/package/@maxklammer/surface-random-notion-note
- Repository: https://github.com/misterbracket/surface-random-notion-note
- Homepage: https://github.com/misterbracket/surface-random-notion-note#readme
- Issues: https://github.com/misterbracket/surface-random-notion-note/issues
- npm.io page: https://npm.io/package/@maxklammer/surface-random-notion-note

## Dependencies (9)

- [meow](https://npm.io/package/meow.md) ^9.0.0
- [open](https://npm.io/package/open.md) ^8.4.0
- [chalk](https://npm.io/package/chalk.md) ^5.0.0
- [cli-alerts](https://npm.io/package/cli-alerts.md) ^1.2.2
- [cli-welcome](https://npm.io/package/cli-welcome.md) ^2.2.2
- [cli-meow-help](https://npm.io/package/cli-meow-help.md) ^2.0.2
- [@notionhq/client](https://npm.io/package/@notionhq/client.md) ^0.4.13
- [cli-handle-error](https://npm.io/package/cli-handle-error.md) ^4.4.0
- [cli-handle-unhandled](https://npm.io/package/cli-handle-unhandled.md) ^1.1.1

## Recent versions

- 0.0.3 (latest) — 2022-02-15
- 0.0.2 — 2022-02-12
- 0.0.1 — 2022-02-12

## README

# Surface Random Notion Notes

## Introduction

This little utility will open a random note that you took in Notion. You can decide which databases you want to use.

Currently, it will only surface notes that are part of a database. 

## Usage

You can use `npx` to run this utility.

```bash
npx @maxklammer/surface-random-notion-note
```

Alternatively you can install this utility globally.

```bash
npm i -g @maxklammer/surface-random-notion-note

// To run the utility
 surface
 // or
 surface-random-notion-note

```

## Configuration

You need to add an integration your Notion account.
Go to the Notion Setting and add an integration. Copy the integration key and place it in your shell `rc` file of your choice. This might be `.zshrc` or `.bashrc`, depending on the shell you use. 

```bash
export NOTION_KEY="<your notion integration key>"
```
Restart your shell and run `echo $NOTION_KEY`to make sure that the key was saved properly. 

Finally back in Notion, you need to share the pages that contain the databases with the integration.

---
_Source: https://npm.io/package/@maxklammer/surface-random-notion-note · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._