theapsgroup / steampipe-plugin-clickup

Use SQL to instantly query ClickUp tasks, goals and more. Open source CLI. No DB required.

ClickUp plugin for Steampipe

Use SQL to instantly query ClickUp tasks, goals and more. Open source CLI. No DB required.

• Get started ->
• Documentation: Table definitions & examples
• Community: Join #steampipe on Slack →
• Get involved: Issues

Quick start

Install the plugin with Steampipe:

steampipe plugin install theapsgroup/clickup

Setup the configuration:

vi ~/.steampipe/config/clickup.spc

or set the following Environment Variables

• CLICKUP_TOKEN : The API Key / Token to use.

Run a query:

Interactive Mode:

select
  id,
  name,
  color
from
  clickup_team;

or from CLI:

steampipe query "select id, name, color from clickup_team"

Developing

Prerequisites:

• Steampipe
• Golang
• ClickUp API Token

Clone:

git clone https://github.com/theapsgroup/steampipe-plugin-clickup.git
cd steampipe-plugin-clickup

Build, which automatically installs the new version to your ~/.steampipe/plugins directory:

make

Configure the plugin:

cp config/* ~/.steampipe/config
vi ~/.steampipe/config/clickup.spc

Try it!

steampipe query
> .inspect clickup

Further reading:

• Writing plugins
• Writing your first table

Contributing

Please see the contribution guidelines and our code of conduct. All contributions are subject to the Apache 2.0 open source license.

help wanted issues:

• Steampipe
• ClickUp Plugin