tylergets/linear-notion-sync

linear-notion-sync

Linear Notion Sync

A CLI tool to sync Linear issues to Notion pages.

• Setup
• Usage
• Commands

Disclaimer

This project is currently a work in progress, and may not be ready for production use. Please use at your own risk and report issues. Thanks!

Follow me on Twitter @TylerGetsay for updates.

Setup

You will need to create a Linear API Token and a Notion API Token. Please follow respective guides for each service.

After creating the tokens, you can run the setup command to create a Notion Database with the Linear template.

• You will need to provide the Linear Team ID, Notion Page ID, and both API Tokens.

After the setup command is run, you can run the sync command to sync Linear issues to the Notion Database.

• You will need to provide the Linear Team ID, Notion Database ID, and both API Tokens.

Notion and Linear API tokens may be provided as environment variables NOTION_TOKEN and LINEAR_TOKEN respectively.

Usage

$ npm install -g linear-notion-sync
$ linear-notion-sync COMMAND
running command...
$ linear-notion-sync (--version)
linear-notion-sync/0.1.2 linux-x64 node-v18.12.1
$ linear-notion-sync --help [COMMAND]
USAGE
  $ linear-notion-sync COMMAND
...

Commands

• linear-notion-sync help [COMMANDS]
• linear-notion-sync linear teams
• linear-notion-sync setup
• linear-notion-sync sync
• linear-notion-sync test

linear-notion-sync help [COMMANDS]

Display help for linear-notion-sync.

USAGE
  $ linear-notion-sync help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for linear-notion-sync.

See code: @oclif/plugin-help

linear-notion-sync linear teams

Get Linear Teams

USAGE
  $ linear-notion-sync linear teams --linearToken <value> --notionToken <value>

FLAGS
  --linearToken=<value>  (required) Linear API Token
  --notionToken=<value>  (required) Notion API Token

DESCRIPTION
  Get Linear Teams

linear-notion-sync setup

Setup Notion Database with Linear Template

USAGE
  $ linear-notion-sync setup --linearToken <value> --notionToken <value> -t <value> -n <value>

FLAGS
  -n, --notionPageId=<value>  (required) Notion Page ID to contain Database
  -t, --linearTeam=<value>    (required) Linear Team ID
  --linearToken=<value>       (required) Linear API Token
  --notionToken=<value>       (required) Notion API Token

DESCRIPTION
  Setup Notion Database with Linear Template

See code: dist/commands/setup.ts

linear-notion-sync sync

Sync Linear issues to Notion Database

USAGE
  $ linear-notion-sync sync --linearToken <value> --notionToken <value> -t <value> -n <value> [-s]

FLAGS
  -n, --notionDatabase=<value>  (required) Notion Database ID
  -s, --slow                    Slow down sync to avoid rate limits
  -t, --linearTeam=<value>      (required) Linear Team ID
  --linearToken=<value>         (required) Linear API Token
  --notionToken=<value>         (required) Notion API Token

DESCRIPTION
  Sync Linear issues to Notion Database

See code: dist/commands/sync.ts

linear-notion-sync test

Test Linear and Notion Connections

USAGE
  $ linear-notion-sync test --linearToken <value> --notionToken <value>

FLAGS
  --linearToken=<value>  (required) Linear API Token
  --notionToken=<value>  (required) Notion API Token

DESCRIPTION
  Test Linear and Notion Connections

See code: dist/commands/test.ts