โ† Back to Search & Research
Search & Research by @vaguilera-jinko

plane

Manage Plane.so projects and work items using the `plane` CLI

0
Source Code

Plane Skill

Interact with Plane.so project management via the plane CLI.

Installation

Download the CLI script and make it executable:

curl -o ~/.local/bin/plane https://raw.githubusercontent.com/JinkoLLC/plane-skill/main/scripts/plane
chmod +x ~/.local/bin/plane

Make sure ~/.local/bin is in your PATH.

Setup

export PLANE_API_KEY="your-api-key"
export PLANE_WORKSPACE="your-workspace-slug"

Get your API key from: Plane โ†’ Profile Settings โ†’ Personal Access Tokens

The workspace slug is the URL path segment (e.g., for https://app.plane.so/my-team/ the slug is my-team).

Commands

Current User

plane me                      # Show authenticated user info

Workspace Members

plane members                 # List all workspace members (name, email, role, ID)

Projects

plane projects list                                      # List all projects
plane projects get PROJECT_ID                            # Get project details
plane projects create --name "My Project" --identifier "PROJ"  # Create project

Work Items (Issues)

# List work items
plane issues list -p PROJECT_ID
plane issues list -p PROJECT_ID --priority high --assignee USER_ID

# Get details
plane issues get -p PROJECT_ID ISSUE_ID

# Create
plane issues create -p PROJECT_ID --name "Fix login bug" --priority high
plane issues create -p PROJECT_ID --name "Feature" --assignee USER_ID --label LABEL_ID

# Update
plane issues update -p PROJECT_ID ISSUE_ID --state STATE_ID --priority medium

# Assign to members
plane issues assign -p PROJECT_ID ISSUE_ID USER_ID_1 USER_ID_2

# Delete
plane issues delete -p PROJECT_ID ISSUE_ID

# Search across workspace
plane issues search "login bug"

Comments

plane comments list -p PROJECT_ID -i ISSUE_ID            # List comments on a work item
plane comments list -p PROJECT_ID -i ISSUE_ID --all      # Show all activity (not just comments)
plane comments add -p PROJECT_ID -i ISSUE_ID "Looks good, merging now"  # Add a comment

Cycles (Sprints)

plane cycles list -p PROJECT_ID
plane cycles get -p PROJECT_ID CYCLE_ID
plane cycles create -p PROJECT_ID --name "Sprint 1" --start 2026-01-27 --end 2026-02-10

Modules

plane modules list -p PROJECT_ID
plane modules get -p PROJECT_ID MODULE_ID
plane modules create -p PROJECT_ID --name "Auth Module" --description "Authentication features"

States & Labels

plane states -p PROJECT_ID    # List workflow states (useful for getting state IDs)
plane labels -p PROJECT_ID    # List labels (useful for getting label IDs)

Output Formats

Default output is a formatted table. Add -f json for raw JSON:

plane projects list -f json
plane issues list -p PROJECT_ID -f json

Typical Workflow

  1. plane projects list โ€” find your project ID
  2. plane states -p PROJECT_ID โ€” see available states
  3. plane members โ€” find member IDs for assignment
  4. plane issues create -p PROJECT_ID --name "Task" --priority high --assignee USER_ID
  5. plane comments add -p PROJECT_ID -i ISSUE_ID "Started working on this"