Git Product home page Git Product logo

notion-cli's Introduction

notion-cli

Command line Notion task management

List tasks output

Description

A command line app that lets you interact with a Notion task board through Notion's API.

Notion setup

This app requires some setup in Notion before use.

Integration

  1. Visit https://www.notion.so/my-integrations and click Create new integration
  2. Give the integration a name and ensure your personal workspace is selected
  3. Select the following capabilities and click submit Required capabilities
  4. Copy the internal integration token and give it to the app with the command notion config token set <TOKEN>

Page and Database

  1. Ensure you're in the same workspace your integration was linked to
  2. Click Add a page on the left sidebar
  3. Click Templates in the newly created page
  4. Expand the Personal dropdown on thr right side and click โœ”๏ธ Task List, then Use This Template at the top. You now have a Notion Page and Database setup for use with the cli
  5. In the new page, click Share at the top right. Then click the textbox, select your integration and click invite.
  6. Run the command notion config database list to list eligible databases for task management. The newly created Database should be listed in the command's output. Copy the ID of the database
  7. Paste the database ID in the following command: notion config database set <ID>

Now you're all set up! ๐ŸŽ‰

Example usage

More details on command usage can be found by running notion tasks <COMMAND> --help

Add

Add a new todo task to the board:

notion tasks add "Adopt five cats" --status todo

List

List all tasks:

notion tasks list

List all tasks and their IDs:

notion tasks list --with-id

List all in-progress tasks:

notion tasks list --status doing

Done

Mark a task as done by name:

notion tasks done --name "Boil ocean"

Mark a task as done by ID:

notion tasks done 59ad73ec-efbd-4b37-ad53-02c8f3b17c56

Update

Move a task to todo and update it's name:

notion tasks update 59ad73ec-efbd-4b37-ad53-02c8f3b17c56 --to todo --name "Finish civ6 game"

notion-cli's People

Contributors

jacobmichels avatar

Watchers

 avatar

notion-cli's Issues

Notion API wrapper

The notion module shouldn't contain any business logic, only wrapping Notion HTTP calls. Consider refactoring

Board builder

Have a command that will build a notion board for the user

Replace reqwest

Reqwest is used in blocking mode, but it still brings in async dependencies like tokio. In the name of reducing compile times it'll be best to shave some dependencies. ureq seems like a good candidate.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.