plc-cli 0.1.1

package/examples/config.yaml

@@ -0,0 +1,95 @@
+# Full configuration reference: docs/CONFIGURATION.md
+
+active_profile: production
+
+# Credentials live in a separate file (~/.config/plane-cli/hosts.yaml) and are
+# managed with `plc auth login` / `plc auth logout`. This file is meant to
+# be safe to commit.
+
+profiles:
+  production:
+    server:
+      base_url: https://plane.company.com
+      workspace_slug: acme
+      timeout_ms: 10000
+      headers:
+        X-Forwarded-Proto: https
+      tls:
+        reject_unauthorized: true
+
+    defaults:
+      # This profile's project universe. The TUI scans all of them by default;
+      # the CLI (plc issue list without --project) uses the first one.
+      projects: ["ENG", "OPS", "DESIGN"]
+      # TUI auto-refresh interval for every view. Omit for the 15s default;
+      # set 0 to disable (manual refresh still works).
+      auto_refresh_seconds: 15
+      # Profile-wide default sort, inherited by any view that declares no `sort`
+      # of its own. A view's `sort` replaces this wholesale (no merging).
+      sort:
+        - project: asc
+        - priority: desc
+        - state: asc
+        - updated_at: desc
+
+    cache:
+      provider: sqlite
+      ttl: 300
+      redis:
+        url: redis://localhost:6379
+        key_prefix: plc
+
+    # Semantic color theme. A built-in preset plus optional per-token overrides.
+    # Applies to the TUI and the `plc issue list` table. Omit for the default look.
+    theme:
+      preset: catppuccin # default | catppuccin | gruvbox | tokyonight
+      colors:
+        accent: "#89b4fa" # override a single token on top of the preset
+        priority:
+          urgent: "#f38ba8"
+
+    views:
+      # No `projects`: inherits defaults.projects and aggregates issues from all
+      # of them. The legacy scalar `sort` still works (read as priority desc).
+      - name: "My open"
+        filters:
+          assignee: me
+          state_group: [unstarted, started]
+        sort: priority
+
+      # Multi-level sort: each key breaks ties of the ones above it. This view's
+      # own `sort` overrides defaults.sort entirely.
+      - name: "Triage"
+        projects: ["ENG", "OPS"]
+        sort:
+          - assign: asc # group by assignee; unassigned issues last
+          - priority: desc # urgent first within each assignee
+          - updated_at: desc
+
+      # `projects` restricts to a subset of defaults.projects. cycle/module are
+      # only allowed when the view resolves to a single project.
+      - name: "Current sprint"
+        projects: ["ENG"]
+        filters:
+          cycle: current
+          state_group: [started]
+
+      # Multi-project view: aggregates critical bugs from ENG and OPS into one set.
+      - name: "Critical bugs"
+        projects: ["ENG", "OPS"]
+        filters:
+          labels: [bug]
+          priority: [urgent, high]
+        # Per-column layout (TUI only): hide STATE, widen ASSIGN, TITLE grows.
+        # The responsive solver still drops columns if the terminal is too narrow.
+        layout:
+          state: { hidden: true }
+          assign: { width: 24 }
+          title: { grow: true }
+
+  staging:
+    server:
+      base_url: https://plane-staging.company.com
+      workspace_slug: acme-staging
+    # Authenticate with `plc auth login` (writes to hosts.yaml). For a config file
+    # that holds the key directly, set `auth.api_key` here instead.

package/examples/keybindings.yaml

@@ -0,0 +1,27 @@
+# ~/.config/plane-cli/keybindings.yaml
+#
+# Configuration reference (config.yaml, profiles, views): docs/CONFIGURATION.md
+#
+# Each entry maps an action id to a key spec. Action ids are stable strings;
+# the full list is shown inside the TUI when you press `?`.
+#
+# Key spec grammar:
+#   single character: "j", "G", "?"
+#   special key:      enter, escape, tab, space, backspace, delete,
+#                     up, down, left, right, pageUp, pageDown, home, end,
+#                     f1..f12
+#   modifiers:        ctrl+x, shift+f1, ctrl+shift+r
+#
+# Unknown action ids fail at startup so typos surface immediately.
+
+list.next: down
+list.prev: up
+list.page-down: pageDown
+list.page-up: pageUp
+list.top: g
+list.bottom: G
+
+global.refresh: r
+global.refresh-all: R
+global.help: "?"
+global.quit: q

package/package.json

@@ -0,0 +1,90 @@
+{
+  "name": "plc-cli",
+  "version": "0.1.1",
+  "description": "CLI and TUI for Plane (Cloud and self-hosted), inspired by gh and gh dash.",
+  "license": "MIT",
+  "author": "Bruno Mariano",
+  "homepage": "https://github.com/brunoomariano/PlaneCockpit#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/brunoomariano/PlaneCockpit.git"
+  },
+  "bugs": {
+    "url": "https://github.com/brunoomariano/PlaneCockpit/issues"
+  },
+  "keywords": [
+    "plane",
+    "cli",
+    "tui",
+    "project-management",
+    "issues",
+    "ink",
+    "terminal"
+  ],
+  "type": "module",
+  "bin": {
+    "plc": "./dist/cli.js"
+  },
+  "main": "./dist/cli.js",
+  "files": [
+    "dist/cli.js",
+    "README.md",
+    "LICENSE",
+    "examples"
+  ],
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "packageManager": "pnpm@11.4.0",
+  "scripts": {
+    "build": "pnpm run gen:schema && tsup",
+    "gen:schema": "tsx scripts/gen-schema.ts",
+    "schema:check": "tsx scripts/gen-schema.ts --check",
+    "dev": "tsx src/cli.ts",
+    "fmt": "prettier --write .",
+    "fmt:check": "prettier --check .",
+    "lint": "eslint .",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:cov": "vitest run --coverage",
+    "audit": "pnpm audit --prod --audit-level high",
+    "deadcode": "knip --include files,dependencies",
+    "deadcode:strict": "knip",
+    "quality": "pnpm run lint && pnpm run deadcode:strict",
+    "secrets:scan": "bash scripts/scan-secrets.sh",
+    "ci": "pnpm run fmt:check && pnpm run lint && pnpm run typecheck && pnpm run build && pnpm run test:cov && pnpm run deadcode:strict && pnpm run audit && pnpm run schema:check && pnpm run secrets:scan",
+    "prepublishOnly": "pnpm run ci"
+  },
+  "dependencies": {
+    "@inquirer/prompts": "^8.5.0",
+    "better-sqlite3": "^12.10.0",
+    "cli-table3": "^0.6.5",
+    "commander": "^14.0.3",
+    "ink": "^7.0.4",
+    "ioredis": "^5.11.0",
+    "marked": "^18.0.4",
+    "open": "^11.0.0",
+    "react": "^19.2.6",
+    "turndown": "^7.2.4",
+    "yaml": "^2.9.0",
+    "zod": "^4.4.3"
+  },
+  "devDependencies": {
+    "@types/better-sqlite3": "^7.6.13",
+    "@types/node": "^24.12.4",
+    "@types/react": "^19.2.15",
+    "@types/turndown": "^5.0.6",
+    "@vitest/coverage-v8": "^4.1.7",
+    "eslint": "^10.4.0",
+    "ink-testing-library": "^4.0.0",
+    "knip": "^6.14.2",
+    "prettier": "^3.8.3",
+    "tsup": "^8.5.1",
+    "tsx": "^4.22.3",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.60.0",
+    "vite": "^8.0.14",
+    "vitest": "^4.1.7"
+  }
+}