@cipherly/plane-cli 1.0.0

package/src/projects/list.projects.ts

@@ -0,0 +1,30 @@
+import { Command } from "commander";
+import { checkRequiredOptionsAndReturn, requestPlaneAPI } from "../utils";
+
+export const listProjects = new Command("list")
+  .description("List projects")
+  .action(async (__, cmd: Command) => {
+    if (cmd.parent == null) return;
+    const { apiKey, apiBase, workspaceSlug, json } =
+      checkRequiredOptionsAndReturn(cmd);
+    const { result, status } = await requestPlaneAPI({
+      apiBase,
+      apiKey,
+      endpoint: `workspaces/${workspaceSlug}/projects/`,
+      method: "GET",
+    });
+    if (json) console.log(JSON.stringify(result));
+    else {
+      if (status !== 200) console.table(result);
+      else console.table(result.results.map(renderProject));
+    }
+  });
+
+export const renderProject = (project: any) => {
+  return {
+    id: project.id,
+    name: project.name,
+    description: project.description,
+    total_members: project.total_members,
+  };
+};

package/src/projects/update.projects.ts

@@ -0,0 +1,32 @@
+import { Command } from "commander";
+import { checkRequiredOptionsAndReturn, requestPlaneAPI } from "../utils";
+import { renderProject } from "./list.projects";
+
+export const updateProject = new Command("update")
+  .description("Update a project")
+  .requiredOption("-p, --project-id <projectId>", "Project's ID")
+  .option("-n, --name [name]", "Project's name")
+  .option("-d, --description [description]", "Project's description")
+  .action(async (__, cmd: Command) => {
+    if (cmd.parent == null) return;
+    const { apiKey, apiBase, workspaceSlug, json } =
+      checkRequiredOptionsAndReturn(cmd);
+    const projectId = cmd.getOptionValue("projectId");
+    const name = cmd.getOptionValue("name");
+    const description = cmd.getOptionValue("description");
+    const body: any = {};
+    if (name !== undefined) body.name = name;
+    if (description !== undefined) body.description = description;
+    const { result, status } = await requestPlaneAPI({
+      apiBase,
+      apiKey,
+      endpoint: `workspaces/${workspaceSlug}/projects/${projectId}/`,
+      method: "PATCH",
+      body,
+    });
+    if (json) console.log(JSON.stringify(result));
+    else {
+      if (status !== 200) console.table(result);
+      else console.table(renderProject(result));
+    }
+  });

package/src/states/create.states.ts

@@ -0,0 +1,32 @@
+import { Command } from "commander";
+import { checkRequiredOptionsAndReturn, requestPlaneAPI } from "../utils";
+import { renderState } from "./list.states";
+
+export const createState = new Command("create")
+  .description("Create a new state")
+  .requiredOption("-p, --project-id <projectId>", "Project's ID")
+  .requiredOption("-n, --name <name>", "State's name")
+  .requiredOption("-c, --color <color>", "State's color")
+  .action(async (__, cmd: Command) => {
+    if (cmd.parent == null) return;
+    const { apiKey, apiBase, workspaceSlug, json } =
+      checkRequiredOptionsAndReturn(cmd);
+    const projectId = cmd.getOptionValue("projectId");
+    const name = cmd.getOptionValue("name");
+    const color = cmd.getOptionValue("color");
+    const { result, status } = await requestPlaneAPI({
+      apiBase,
+      apiKey,
+      endpoint: `workspaces/${workspaceSlug}/projects/${projectId}/states/`,
+      method: "POST",
+      body: {
+        name,
+        color,
+      },
+    });
+    if (json) console.log(JSON.stringify(result));
+    else {
+      if (status !== 201) console.table(result);
+      else console.table(renderState(result));
+    }
+  });

package/src/states/delete.states.ts

@@ -0,0 +1,25 @@
+import { Command } from "commander";
+import { checkRequiredOptionsAndReturn, requestPlaneAPI } from "../utils";
+
+export const deleteState = new Command("delete")
+  .description("Delete a state")
+  .requiredOption("-p, --project-id <projectId>", "Project's ID")
+  .requiredOption("-s, --state-id <stateId>", "State's ID")
+  .action(async (__, cmd: Command) => {
+    if (cmd.parent == null) return;
+    const { apiKey, apiBase, workspaceSlug, json } =
+      checkRequiredOptionsAndReturn(cmd);
+    const projectId = cmd.getOptionValue("projectId");
+    const stateId = cmd.getOptionValue("stateId");
+    const { result, status } = await requestPlaneAPI({
+      apiBase,
+      apiKey,
+      endpoint: `workspaces/${workspaceSlug}/projects/${projectId}/states/${stateId}/`,
+      method: "DELETE",
+    });
+    if (json) console.log(JSON.stringify(result));
+    else {
+      if (status !== 204) console.table(result);
+      else console.table(result);
+    }
+  });

package/src/states/index.ts

@@ -0,0 +1,5 @@
+export * from "./list.states";
+export * from "./create.states";
+export * from "./update.states";
+export * from "./delete.states";
+

package/src/states/list.states.ts

@@ -0,0 +1,31 @@
+import { Command } from "commander";
+import { checkRequiredOptionsAndReturn, requestPlaneAPI } from "../utils";
+
+export const listStates = new Command("list")
+  .description("List states")
+  .requiredOption("-p, --project-id <projectId>", "Project's ID")
+  .action(async (__, cmd: Command) => {
+    if (cmd.parent == null) return;
+    const { apiKey, apiBase, workspaceSlug, json } =
+      checkRequiredOptionsAndReturn(cmd);
+    const projectId = cmd.getOptionValue("projectId");
+    const { result, status } = await requestPlaneAPI({
+      apiBase,
+      apiKey,
+      endpoint: `workspaces/${workspaceSlug}/projects/${projectId}/states/`,
+      method: "GET",
+    });
+    if (json) console.log(JSON.stringify(result));
+    else {
+      if (status !== 200) console.table(result);
+      else console.table(result.results.map(renderState));
+    }
+  });
+
+export const renderState = (state: any) => {
+  return {
+    id: state.id,
+    name: state.name,
+    description: state.description,
+  };
+};

package/src/states/update.states.ts

@@ -0,0 +1,31 @@
+import { Command } from "commander";
+import { checkRequiredOptionsAndReturn, requestPlaneAPI } from "../utils";
+import { renderState } from "./list.states";
+
+export const updateState = new Command("update")
+  .description("Update a state")
+  .requiredOption("-p, --project-id <projectId>", "Project's ID")
+  .requiredOption("-s, --state-id <stateId>", "State's ID")
+  .requiredOption("-n, --name <name>", "State's name")
+  .action(async (__, cmd: Command) => {
+    if (cmd.parent == null) return;
+    const { apiKey, apiBase, workspaceSlug, json } =
+      checkRequiredOptionsAndReturn(cmd);
+    const projectId = cmd.getOptionValue("projectId");
+    const stateId = cmd.getOptionValue("stateId");
+    const name = cmd.getOptionValue("name");
+    const { result, status } = await requestPlaneAPI({
+      apiBase,
+      apiKey,
+      endpoint: `workspaces/${workspaceSlug}/projects/${projectId}/states/${stateId}/`,
+      method: "PATCH",
+      body: {
+        name,
+      },
+    });
+    if (json) console.log(JSON.stringify(result));
+    else {
+      if (status !== 200) console.table(result);
+      else console.table(renderState(result));
+    }
+  });

package/src/users/index.ts

@@ -0,0 +1 @@
+export * from "./me.users";

package/src/users/me.users.ts

@@ -0,0 +1,30 @@
+import { Command } from "commander";
+import { checkRequiredOptionsAndReturn, requestPlaneAPI } from "../utils";
+
+export const getCurrentUser = new Command("me")
+  .description("Get current user")
+  .action(async (__, cmd: Command) => {
+    if (cmd.parent == null) return;
+    const { apiKey, apiBase, json } = checkRequiredOptionsAndReturn(cmd);
+    const { result, status } = await requestPlaneAPI({
+      apiBase,
+      apiKey,
+      endpoint: `users/me/`,
+      method: "GET",
+    });
+    if (json) console.log(JSON.stringify(result));
+    else {
+      if (status !== 200) console.table(result);
+      else console.table(renderUser(result));
+    }
+  });
+
+export const renderUser = (user: any) => {
+  return {
+    id: user.id,
+    first_name: user.first_name,
+    last_name: user.last_name,
+    email: user.email,
+    display_name: user.display_name,
+  };
+};

package/src/utils.ts

@@ -0,0 +1,81 @@
+import { Command } from "commander";
+
+export const checkApiKey = (apiKey: any) => {
+  if (!apiKey) {
+    console.error(
+      "No API key provided. Use: plane <command> --api-key <API_KEY> or set PLANE_API_KEY environment variable",
+    );
+    process.exit(1);
+  }
+};
+
+export const checkApiBase = (apiBase: any) => {
+  if (!apiBase) {
+    console.error(
+      "No API base provided. Use: plane <command> --api-base <API_BASE> or set PLANE_API_BASE environment variable",
+    );
+    process.exit(1);
+  }
+};
+
+export const checkWorkspaceSlug = (workspaceSlug: any) => {
+  if (!workspaceSlug) {
+    console.error(
+      "No workspace slug provided. Use: plane <command> --workspace-slug <SLUG> or set PLANE_WORKSPACE_SLUG environment variable",
+    );
+    process.exit(1);
+  }
+};
+
+export const checkRequiredOptionsAndReturn = (cmd: Command) => {
+  const apiKey = cmd.parent.getOptionValue("apiKey");
+  const apiBase = cmd.parent.getOptionValue("apiBase");
+  const workspaceSlug = cmd.parent.getOptionValue("workspaceSlug");
+  checkApiKey(apiKey);
+  checkApiBase(apiBase);
+  checkWorkspaceSlug(workspaceSlug);
+  const json = cmd.parent.getOptionValue("json");
+  return {
+    apiKey,
+    apiBase,
+    workspaceSlug,
+    json,
+  };
+};
+
+export const requestPlaneAPI = async ({
+  apiKey,
+  apiBase,
+  endpoint,
+  method,
+  body,
+  params,
+  no_v1,
+}: {
+  apiKey: string;
+  apiBase: string;
+  endpoint: string;
+  method: string;
+  body?: any;
+  params?: any;
+  no_v1?: boolean;
+}) => {
+  let url = `${apiBase}/api${(!!!no_v1 && "/v1") || ""}/${endpoint}`;
+  if (params) {
+    const qs = new URLSearchParams(params).toString();
+    url += `?${qs}`;
+  }
+  const headers = {
+    "X-API-Key": apiKey,
+    "Content-Type": "application/json",
+  };
+  const opts = { method, headers, body };
+  if (body) opts.body = JSON.stringify(body);
+  try {
+    const res = await fetch(url, opts);
+    return { result: await res.json(), status: res.status };
+  } catch (err) {
+    console.error("Request failed:", err.message);
+    process.exit(1);
+  }
+};

package/src/work-items/create.work-items.ts

@@ -0,0 +1,85 @@
+import { Command, Option } from "commander";
+import { checkRequiredOptionsAndReturn, requestPlaneAPI } from "../utils";
+
+export const createWorkItem = new Command("create")
+  .description("Create a new work-item")
+  .requiredOption("-p, --project-id <projectId>", "Project's ID")
+  .requiredOption("-n, --name <name>", "Work item's name")
+  .option(
+    "-d, --description [description_html]",
+    "Work item's description in HTML",
+  )
+  .option("-s, --state <state>", "Work item's state ID")
+  .option(
+    "-a, --assignees <assignees>",
+    "Work item's assignees IDs (comma seperated)",
+  )
+  .addOption(
+    new Option("-u, --priority <priority>", "Work item's priority").choices([
+      "none",
+      "urgent",
+      "high",
+      "medium",
+      "low",
+    ]),
+  )
+  .option("-l, --labels <labels>", "Work item's labels IDs (comma seperated)")
+  .option("--parent <parentId>", "Work item's parent ID")
+  .option("-ep, --estimate-point <estimatePoint>", "Work item's estimate point")
+  .option("-sd, --start-date <startDate>", "Work item's start date")
+  .option("-td, --target-date <targetDate>", "Work item's target date")
+  .option("-m, --module <moduleId>", "Work item's module id")
+  .action(async (__, cmd: Command) => {
+    if (cmd.parent == null) return;
+    const { apiKey, apiBase, workspaceSlug, json } =
+      checkRequiredOptionsAndReturn(cmd);
+    const projectId = cmd.getOptionValue("projectId");
+    const name = cmd.getOptionValue("name");
+    const description_html = cmd.getOptionValue("description");
+    const state = cmd.getOptionValue("state");
+    const assignees = cmd.getOptionValue("assignees");
+    const priority = cmd.getOptionValue("priority");
+    const labels = cmd.getOptionValue("labels");
+    const parent_id = cmd.getOptionValue("parent");
+    const estimate_point = cmd.getOptionValue("estimatePoint");
+    const start_date = cmd.getOptionValue("startDate");
+    const target_date = cmd.getOptionValue("targetDate");
+    const module_id = cmd.getOptionValue("module");
+    const { result, status } = await requestPlaneAPI({
+      apiBase,
+      apiKey,
+      endpoint: `workspaces/${workspaceSlug}/projects/${projectId}/issues/`,
+      method: "POST",
+      body: {
+        name,
+        description_html,
+        project_id: projectId,
+        state,
+        assignees,
+        priority,
+        labels,
+        parent: parent_id,
+        estimate_point,
+        start_date,
+        target_date,
+        module: module_id,
+      },
+      params: {
+        expand: "state,labels,assignees",
+      },
+    });
+    if (json) {
+      console.log(JSON.stringify(result));
+    } else {
+      if (status !== 201) console.table(result);
+      else console.table(renderNewWorkItem(result));
+    }
+  });
+
+export const renderNewWorkItem = (workItem: any) => {
+  return {
+    id: workItem.id,
+    name: workItem.name,
+    created: true,
+  };
+};

package/src/work-items/delete.work-items.ts

@@ -0,0 +1,25 @@
+import { Command } from "commander";
+import { checkRequiredOptionsAndReturn, requestPlaneAPI } from "../utils";
+
+export const deleteWorkItem = new Command("delete")
+  .description("Delete a work-item")
+  .requiredOption("-p, --project-id <projectId>", "Project's ID")
+  .requiredOption("-w, --work-item-id <workItemId>", "Work item's ID")
+  .action(async (__, cmd: Command) => {
+    if (cmd.parent == null) return;
+    const { apiKey, apiBase, workspaceSlug, json } =
+      checkRequiredOptionsAndReturn(cmd);
+    const projectId = cmd.getOptionValue("projectId");
+    const workItemId = cmd.getOptionValue("workItemId");
+    const { result, status } = await requestPlaneAPI({
+      apiBase,
+      apiKey,
+      endpoint: `workspaces/${workspaceSlug}/projects/${projectId}/work-items/${workItemId}/`,
+      method: "DELETE",
+    });
+    if (json) console.log(JSON.stringify(result));
+    else {
+      if (status !== 204) console.table(result);
+      else console.table(result);
+    }
+  });

package/src/work-items/index.ts

@@ -0,0 +1,5 @@
+export * from "./list.work-items";
+export * from "./create.work-items";
+export * from "./update.work-items";
+export * from "./delete.work-items";
+export * from "./types";

package/src/work-items/list.work-items.ts

@@ -0,0 +1,43 @@
+import { Command } from "commander";
+import { checkRequiredOptionsAndReturn, requestPlaneAPI } from "../utils";
+
+export const listWorkItems = new Command("list")
+  .description("List work items")
+  .requiredOption("-p, --project-id <projectId>", "Project's ID")
+  .action(async (__, cmd: Command) => {
+    if (cmd.parent == null) return;
+    const { apiKey, apiBase, workspaceSlug, json } =
+      checkRequiredOptionsAndReturn(cmd);
+    const projectId = cmd.getOptionValue("projectId");
+    const { result, status } = await requestPlaneAPI({
+      apiBase,
+      apiKey,
+      endpoint: `workspaces/${workspaceSlug}/projects/${projectId}/work-items/`,
+      method: "GET",
+      params: {
+        expand: "state,labels,assignees",
+      },
+    });
+    if (json) console.log(JSON.stringify(result));
+    else {
+      if (status !== 200) console.table(result);
+      else console.table(result.results.map(renderWorkItem));
+    }
+  });
+
+export const renderWorkItem = (workItem: any) => {
+  return {
+    id: workItem.id,
+    name: workItem.name,
+    state: (workItem.state && workItem.state.name) || null,
+    labels:
+      (workItem.labels && workItem.labels.map((label: any) => label.name)) ||
+      [],
+    assignees:
+      (workItem.assignees &&
+        workItem.assignees.map((user: any) =>
+          `${user.first_name} ${user.last_name}`.trim(),
+        )) ||
+      [],
+  };
+};

package/src/work-items/types/index.ts

@@ -0,0 +1 @@
+export * from "./list.types.work-items";

package/src/work-items/types/list.types.work-items.ts

@@ -0,0 +1,36 @@
+import { Command } from "commander";
+import { checkRequiredOptionsAndReturn, requestPlaneAPI } from "../../utils";
+
+// WARN: THIS ENDPOINT IS WIP
+export const listWorkItemTypes = new Command("list")
+  .description("List work item types")
+  .requiredOption("-p, --project-id <projectId>", "Project's ID")
+  .action(async (__, cmd: Command) => {
+    if (cmd.parent == null) return;
+    const { apiKey, apiBase, workspaceSlug, json } =
+      checkRequiredOptionsAndReturn(cmd);
+    const projectId = cmd.getOptionValue("projectId");
+    const { result, status } = await requestPlaneAPI({
+      apiBase,
+      apiKey,
+      endpoint: `workspaces/${workspaceSlug}/projects/${projectId}/work-item-types/`,
+      method: "GET",
+    });
+    if (json) console.log(JSON.stringify(result));
+    else {
+      if (status !== 200) console.table(result);
+      else console.table(result.results.map(renderWorkItemType));
+    }
+  });
+
+export const renderWorkItemType = (workItemType: any) => {
+  return {
+    id: workItemType.id,
+    name: workItemType.name,
+    description: workItemType.description,
+    is_epic: workItemType.is_epic,
+    is_default: workItemType.is_default,
+    is_active: workItemType.is_active,
+    level: workItemType.level,
+  };
+};

package/src/work-items/update.work-items.ts

@@ -0,0 +1,79 @@
+import { Command, Option } from "commander";
+import { checkRequiredOptionsAndReturn, requestPlaneAPI } from "../utils";
+
+export const updateWorkItem = new Command("update")
+  .description("Update a work-item")
+  .requiredOption("-p, --project-id <projectId>", "Project's ID")
+  .requiredOption("-w, --work-item-id <workItemId>", "Work item's ID")
+  .option("-n, --name [name]", "Work item's name")
+  .option("-d, --description [description]", "Work item's description in HTML")
+  .option("-s, --state <state>", "Work item's state ID")
+  .option(
+    "-a, --assignees <assignees>",
+    "Work item's assignees IDs (comma seperated)",
+  )
+  .addOption(
+    new Option("-u, --priority <priority>", "Work item's priority").choices([
+      "none",
+      "urgent",
+      "high",
+      "medium",
+      "low",
+    ]),
+  )
+  .option("-l, --labels <labels>", "Work item's labels IDs (comma seperated)")
+  .option("--parent <parentId>", "Work item's parent ID")
+  .option("-ep, --estimate-point <estimatePoint>", "Work item's estimate point")
+  .option("-sd, --start-date <startDate>", "Work item's start date")
+  .option("-td, --target-date <targetDate>", "Work item's target date")
+  .option("-m, --module <moduleId>", "Work item's module id")
+  .action(async (__, cmd: Command) => {
+    if (cmd.parent == null) return;
+    const { apiKey, apiBase, workspaceSlug, json } =
+      checkRequiredOptionsAndReturn(cmd);
+    const projectId = cmd.getOptionValue("projectId");
+    const workItemId = cmd.getOptionValue("workItemId");
+    const name = cmd.getOptionValue("name");
+    const description = cmd.getOptionValue("description");
+    const state = cmd.getOptionValue("state");
+    const assignees = cmd.getOptionValue("assignees");
+    const priority = cmd.getOptionValue("priority");
+    const labels = cmd.getOptionValue("labels");
+    const parent_id = cmd.getOptionValue("parent");
+    const estimate_point = cmd.getOptionValue("estimatePoint");
+    const start_date = cmd.getOptionValue("startDate");
+    const target_date = cmd.getOptionValue("targetDate");
+    const module_id = cmd.getOptionValue("module");
+    const body: any = {};
+    if (name !== undefined) body.name = name;
+    if (description !== undefined) body.description = description;
+    if (state !== undefined) body.state = state;
+    if (assignees !== undefined) body.assignees = assignees;
+    if (priority !== undefined) body.priority = priority;
+    if (labels !== undefined) body.labels = labels;
+    if (parent_id !== undefined) body.parent = parent_id;
+    if (estimate_point !== undefined) body.estimate_point = estimate_point;
+    if (start_date !== undefined) body.start_date = start_date;
+    if (target_date !== undefined) body.target_date = target_date;
+    if (module_id !== undefined) body.module = module_id;
+    const { result, status } = await requestPlaneAPI({
+      apiBase,
+      apiKey,
+      endpoint: `workspaces/${workspaceSlug}/projects/${projectId}/work-items/${workItemId}/`,
+      method: "PATCH",
+      body,
+    });
+    if (json) console.log(JSON.stringify(result));
+    else {
+      if (status !== 200) console.table(result);
+      else console.table(renderUpdatedWorkItem(result));
+    }
+  });
+
+export const renderUpdatedWorkItem = (workItem: any) => {
+  return {
+    id: workItem.id,
+    name: workItem.name,
+    updated: true,
+  };
+};

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "CommonJS",
+    "outDir": "dist",
+    "rootDir": "src",
+    "moduleResolution": "Node",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": false,
+    "skipLibCheck": true,
+    "lib": ["ES2020", "DOM"]
+  }
+}