plane-api

Original：🇺🇸 English

Translated

1 scriptsChecked / no sensitive code detected

Connect to a self-hosted Plane.so instance via API. Use this skill when the user wants to interact with Plane for project management tasks including managing workspaces, projects, work items (issues), cycles, modules, states, and labels.

3installs

Sourcemontagao/skills

Added on2026-02-22

NPX Install

npx skill4agent add montagao/skills plane-api

SKILL.md Content

View Translation Comparison →

Plane API Integration

This skill enables interaction with a self-hosted Plane.so instance using the

plane.py

CLI tool.

Setup

The user must set these environment variables:

bash

export PLANE_API_URL="https://plane.example.com"
export PLANE_API_KEY="plane_api_..."
export PLANE_WORKSPACE_SLUG="my-team"  # Optional, can pass --workspace instead

Using the CLI Tool

All operations use

plane.py

located at

~/.skills/plane-api/plane.py

.

Check API Compatibility

First, verify the Plane instance supports the v1 API (requires Plane v0.20+):

bash

python ~/.skills/plane-api/plane.py check-version

List Projects

bash

python ~/.skills/plane-api/plane.py projects
python ~/.skills/plane-api/plane.py projects --workspace other-team

List Work Items (Issues)

bash

python ~/.skills/plane-api/plane.py work-items <project_id>

Create Work Item

bash

python ~/.skills/plane-api/plane.py create-work-item <project_id> "Issue title"
python ~/.skills/plane-api/plane.py create-work-item <project_id> "Bug fix" --priority high
python ~/.skills/plane-api/plane.py create-work-item <project_id> "Feature" --priority medium --state-id <uuid> --description "Details here"

Priority values:

urgent

,

high

,

medium

,

low

,

none

List States

Get available states to use when creating work items:

bash

python ~/.skills/plane-api/plane.py states <project_id>

List Cycles

bash

python ~/.skills/plane-api/plane.py cycles <project_id>

List Modules

bash

python ~/.skills/plane-api/plane.py modules <project_id>

Typical Workflow

Run
```
check-version
```
to verify API access
Run
```
projects
```
to get project IDs
Run
```
states <project_id>
```
to get state UUIDs
Run
```
create-work-item
```
with the appropriate state and priority

API Reference

For operations not covered by the CLI (like adding items to cycles/modules, creating labels, bulk operations), use curl directly:

bash

curl -H "X-API-Key: $PLANE_API_KEY" \
     -H "Content-Type: application/json" \
     "$PLANE_API_URL/api/v1/workspaces/$PLANE_WORKSPACE_SLUG/..."

Key endpoints:

```
GET /api/v1/workspaces/{slug}/projects/
```
- List projects

GET /api/v1/workspaces/{slug}/projects/{id}/work-items/

- List work items

POST /api/v1/workspaces/{slug}/projects/{id}/work-items/

- Create work item

GET /api/v1/workspaces/{slug}/projects/{id}/states/

- List states

GET /api/v1/workspaces/{slug}/projects/{id}/cycles/

- List cycles

POST /api/v1/workspaces/{slug}/projects/{id}/cycles/{id}/work-items/

- Add to cycle

GET /api/v1/workspaces/{slug}/projects/{id}/modules/

- List modules

GET /api/v1/workspaces/{slug}/projects/{id}/labels/

- List labels

Rate limit: 60 requests/minute per API key.

plane-api

NPX Install

Tags

SKILL.md Content

Plane API Integration

Setup

Using the CLI Tool

Check API Compatibility

List Projects

List Work Items (Issues)

Create Work Item

List States

List Cycles

List Modules

Typical Workflow

API Reference