Use the Plane CLI from KosmoKrator to call Plane tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.
Plane can be configured headlessly with `kosmokrator integrations:configure plane`.
# Install KosmoKrator first if it is not available on PATH.curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash# Configure and verify this integration.kosmokrator integrations:configure plane --set api_key="$PLANE_API_KEY" --enable --read allow --write ask --jsonkosmokrator integrations:doctor plane --jsonkosmokrator integrations:status --json
Credentials
Authentication type: API keyapi_key. Configure credentials once, then use the same stored profile from
scripts, coding CLIs, Lua code mode, and the MCP gateway.
Key
Env var
Type
Required
Label
api_key
PLANE_API_KEY
Secret secret
yes
API Key
url
PLANE_URL
URL url
no
API Base URL
workspace_slug
PLANE_WORKSPACE_SLUG
Text string
no
Default Workspace Slug
Call Plane Headlessly
Use the generic call form when another coding CLI or script needs a stable universal interface.
Every function below can be called headlessly. The generic form is stable across all integrations;
the provider shortcut is shorter but specific to Plane.
plane.plane_list_workspaces
Read read
List all Plane.so workspaces the authenticated user belongs to.
Returns workspace slug, name, and owner info. Use the slug to reference workspaces in other tools.
List all projects in a Plane.so workspace.
Returns project ID, name, identifier, description, and status.
Use the project ID to reference projects in other tools.
Create a new project in a Plane.so workspace. Requires a name and identifier (short code, e.g., "PROJ").
Optionally set description, cover image, project lead, and default assignee.
List issues in a Plane.so project. Supports filtering by state, priority, assignee, labels, and more.
Returns issue ID, name, sequence ID, state, priority, assignees, labels, start/target dates, and created date.
Search issues across all projects in a Plane.so workspace. Provide a search query to find issues by name or description.
Optionally filter by project, state, priority, or assignee.
Get detailed information about a single Plane.so issue, including description, state, priority, assignees, labels, dates, and relations.
The issue_id may be a UUID or an issue reference like KOS-55 on Plane deployments that support it.
Create a new issue in a Plane.so project. Requires a title. Optionally set description (HTML), state, priority, assignees, labels, start/target dates, and parent issue.
Update an existing Plane.so issue. Provide only the fields you want to change — name, description, state, priority, assignees, labels, dates, or parent.
List all modules in a Plane.so project. Modules group related issues together (e.g., "Auth System", "Payment Integration").
Returns module ID, name, description, status, and dates.
Create a new module in a Plane.so project. Modules group related issues together (e.g., "Auth System", "Payment Integration").
Optionally set description, status, and date range.
List all workflow states in a Plane.so project. Returns state UUID, name, group (backlog/unstarted/started/completed/cancelled), and color.
Use state UUIDs when creating or updating issues.
Create a new workflow state in a Plane.so project. States represent issue statuses (e.g., "In Review", "Ready for QA").
Requires a name and group (backlog, unstarted, started, completed, cancelled). Optionally set color and description.
Create a new label in a Plane.so project. Labels categorize issues (e.g., "bug", "feature", "urgent").
Requires a name. Optionally set color (hex) and description. Supports hierarchical labels via parent UUID.
List all pages in a Plane.so project. Pages are Notion-like documents for notes, specs, and documentation.
Returns page ID, name, description, and ownership info.
Create a new page in a Plane.so project. Pages are Notion-like documents for notes, specs, and documentation.
Requires a name. Optionally set HTML content.
List activity/audit events on a Plane.so issue. Returns changes made to the issue (state changes, assignments, updates, comments) with who made them and when.
List all relations on a Plane.so issue. Relations describe how issues connect: blocking, blocked_by, duplicate, relates_to, start_before, start_after, finish_before, finish_after.
List members of a Plane.so workspace or project. If project_id is provided, returns project members only; otherwise returns all workspace members.
Returns member ID, display name, email, and role.
Get the currently authenticated Plane.so user. Returns user ID, display name, email, and avatar.
Useful for verifying API credentials and identifying the current user context.
On some self-hosted Plane deployments where the user endpoint is unavailable, this falls back to verifying workspace-scoped access.
Use these parameter tables when building CLI payloads without calling integrations:schema first.
plane.plane_list_workspaces
List all Plane.so workspaces the authenticated user belongs to.
Returns workspace slug, name, and owner info. Use the slug to reference workspaces in other tools.
List all projects in a Plane.so workspace.
Returns project ID, name, identifier, description, and status.
Use the project ID to reference projects in other tools.
Create a new project in a Plane.so workspace. Requires a name and identifier (short code, e.g., "PROJ").
Optionally set description, cover image, project lead, and default assignee.
List issues in a Plane.so project. Supports filtering by state, priority, assignee, labels, and more.
Returns issue ID, name, sequence ID, state, priority, assignees, labels, start/target dates, and created date.
Filter by priority: urgent, high, medium, low, none.
assignee
string
no
Filter by assignee UUID.
labels
string
no
Comma-separated label UUIDs to filter by.
search
string
no
Search query to filter issues by name.
parent
string
no
Filter by parent issue UUID.
cycle
string
no
Filter by cycle UUID.
module
string
no
Filter by module UUID.
plane.plane_search_issues
Search issues across all projects in a Plane.so workspace. Provide a search query to find issues by name or description.
Optionally filter by project, state, priority, or assignee.
Filter by priority: urgent, high, medium, low, none.
assignee
string
no
Filter by assignee UUID.
plane.plane_get_issue
Get detailed information about a single Plane.so issue, including description, state, priority, assignees, labels, dates, and relations.
The issue_id may be a UUID or an issue reference like KOS-55 on Plane deployments that support it.
Create a new issue in a Plane.so project. Requires a title. Optionally set description (HTML), state, priority, assignees, labels, start/target dates, and parent issue.
Update an existing Plane.so issue. Provide only the fields you want to change — name, description, state, priority, assignees, labels, dates, or parent.
List all modules in a Plane.so project. Modules group related issues together (e.g., "Auth System", "Payment Integration").
Returns module ID, name, description, status, and dates.
Create a new module in a Plane.so project. Modules group related issues together (e.g., "Auth System", "Payment Integration").
Optionally set description, status, and date range.
List all workflow states in a Plane.so project. Returns state UUID, name, group (backlog/unstarted/started/completed/cancelled), and color.
Use state UUIDs when creating or updating issues.
Create a new workflow state in a Plane.so project. States represent issue statuses (e.g., "In Review", "Ready for QA").
Requires a name and group (backlog, unstarted, started, completed, cancelled). Optionally set color and description.
Create a new label in a Plane.so project. Labels categorize issues (e.g., "bug", "feature", "urgent").
Requires a name. Optionally set color (hex) and description. Supports hierarchical labels via parent UUID.
List all pages in a Plane.so project. Pages are Notion-like documents for notes, specs, and documentation.
Returns page ID, name, description, and ownership info.
Create a new page in a Plane.so project. Pages are Notion-like documents for notes, specs, and documentation.
Requires a name. Optionally set HTML content.
List activity/audit events on a Plane.so issue. Returns changes made to the issue (state changes, assignments, updates, comments) with who made them and when.
List all relations on a Plane.so issue. Relations describe how issues connect: blocking, blocked_by, duplicate, relates_to, start_before, start_after, finish_before, finish_after.
List members of a Plane.so workspace or project. If project_id is provided, returns project members only; otherwise returns all workspace members.
Returns member ID, display name, email, and role.
Optional project UUID to list project-specific members.
plane.plane_get_current_user
Get the currently authenticated Plane.so user. Returns user ID, display name, email, and avatar.
Useful for verifying API credentials and identifying the current user context.
On some self-hosted Plane deployments where the user endpoint is unavailable, this falls back to verifying workspace-scoped access.
Headless calls still follow the integration read/write permission policy. Configure read/write defaults
with integrations:configure. Add --force only for trusted automation that should bypass that policy.