clickup-jetbrains v1.0.0

clickup-jetbrains - Manage ClickUp tasks in JetBrains IDE

This small package displays all ClickUp tasks from a 'ClickUp space' in your JetBrains IDE, because who wants to switch between apps all the time? As of now, JetBrains IDEs do not support ClickUp tasks out of the box, so this package is a workaround.

How it works

It runs a serve on your host machine that fetches all tasks from a ClickUp space and caches them. The JetBrains IDE then connects to this server and displays the tasks in the 'Tasks' view.

What you need

You need a ClickUp 'Personal API Key'. Follow the ClickUp docs to create one for free in seconds.

Configuration

1. Use .env or CLI arguments to add your ClickUp API key when prompted
2. Enter the ID of the space you want to read tasks from (you can find this in the URL when you are in the space in ClickUp)
3. In your JetBrains IDE go to Tools -> Tasks -> Servers and add 'Generic' server with the URL http://localhost:3000

You do not need any authentication to have JetBrains connect to your local host, so 'Login anonymously' should be set.

In Tab 'Server Configuration' you set the following options:

• Tasks List URL: {serverUrl}/tasks
• Single Task URL: Leave empty
• Response type: JSON
• Name and path mapping
  • tasks -> tasks
  • id -> id
  • summary -> summary
  • description -> description
  • updated -> updated
  • created -> created
  • issueUrl -> issueUrl

Usage

Start the server by running npm start. This will fetch the tasks, cache them and start the server on http://localhost:3000. Now you are ready to use the ClickUp integration. 1. Open the tasks in Jetbrains IDE (shortcut Shift+ALT+T, at least my shortcut) 2. Click on the + Open Task... and your tasks should be listed in the Open Task dialog

Features

• Allows you to define the ClickUp 'space' to read tasks from
• It will read all the tasks within that space, whether they are in a folder or 'folderless list'
• It will cache the results for a configurable amount of time to prevent hitting the ClickUp API too frequently