checkbox-cli 1.1.0

package/dist/checkbox.d.ts

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+/**
+ * Checkbox CLI
+ *
+ * Command-line interface for the Checkbox capability API.
+ *
+ * Usage:
+ *   checkbox capabilities                          — list all capabilities
+ *   checkbox command <type> <payload-json> [--org <id>]  — execute a command
+ *   checkbox query <type> <payload-json> --org <id>      — execute a query
+ *   checkbox workspace --org <id>                  — get workspace graph
+ *   checkbox entities --org <id> [--type <t>] [--search <s>]  — find entities
+ *   checkbox schema --org <id> [--type <t>]        — get entity schemas
+ *   checkbox permissions --org <id>                — check permissions
+ *
+ * Environment variables:
+ *   CHECKBOX_API_URL    — Base URL (default: https://checkbox.my)
+ *   CHECKBOX_API_TOKEN  — API key (ck_live_...) or Supabase JWT
+ *
+ * Get your API key:
+ *   1. Log in to checkbox.my
+ *   2. Go to Developer Hub (sidebar)
+ *   3. Create an API key — it never expires unless you set an expiry
+ */
+export {};

package/dist/checkbox.js

@@ -0,0 +1,207 @@
+#!/usr/bin/env node
+/**
+ * Checkbox CLI
+ *
+ * Command-line interface for the Checkbox capability API.
+ *
+ * Usage:
+ *   checkbox capabilities                          — list all capabilities
+ *   checkbox command <type> <payload-json> [--org <id>]  — execute a command
+ *   checkbox query <type> <payload-json> --org <id>      — execute a query
+ *   checkbox workspace --org <id>                  — get workspace graph
+ *   checkbox entities --org <id> [--type <t>] [--search <s>]  — find entities
+ *   checkbox schema --org <id> [--type <t>]        — get entity schemas
+ *   checkbox permissions --org <id>                — check permissions
+ *
+ * Environment variables:
+ *   CHECKBOX_API_URL    — Base URL (default: https://checkbox.my)
+ *   CHECKBOX_API_TOKEN  — API key (ck_live_...) or Supabase JWT
+ *
+ * Get your API key:
+ *   1. Log in to checkbox.my
+ *   2. Go to Developer Hub (sidebar)
+ *   3. Create an API key — it never expires unless you set an expiry
+ */
+const API_URL = process.env.CHECKBOX_API_URL ?? 'https://checkbox.my';
+const API_TOKEN = process.env.CHECKBOX_API_TOKEN ?? '';
+function getHeaders() {
+    return {
+        'Content-Type': 'application/json',
+        ...(API_TOKEN ? { Authorization: `Bearer ${API_TOKEN}` } : {}),
+    };
+}
+async function apiGet(path) {
+    const res = await fetch(`${API_URL}${path}`, { method: 'GET', headers: getHeaders() });
+    return res.json();
+}
+async function apiPost(path, body) {
+    const res = await fetch(`${API_URL}${path}`, {
+        method: 'POST',
+        headers: getHeaders(),
+        body: JSON.stringify(body),
+    });
+    return res.json();
+}
+function print(data) {
+    console.log(JSON.stringify(data, null, 2));
+}
+function fail(message) {
+    console.error(`Error: ${message}`);
+    process.exit(1);
+}
+function getFlag(args, flag) {
+    const idx = args.indexOf(flag);
+    if (idx === -1 || idx + 1 >= args.length)
+        return undefined;
+    return args[idx + 1];
+}
+// ── Subcommands ─────────────────────────────────────────────────────
+async function cmdCapabilities() {
+    print(await apiGet('/api/v2/introspection/capabilities'));
+}
+async function cmdCommand(args) {
+    const type = args[0];
+    const payloadRaw = args[1];
+    if (!type)
+        fail('Usage: checkbox command <type> <payload-json> [--org <id>]');
+    const payload = payloadRaw ? JSON.parse(payloadRaw) : {};
+    const orgId = getFlag(args, '--org');
+    const body = { type, payload };
+    if (orgId)
+        body.organization_id = orgId;
+    print(await apiPost('/api/v2/commands', body));
+}
+async function cmdQuery(args) {
+    const type = args[0];
+    const payloadRaw = args[1];
+    const orgId = getFlag(args, '--org');
+    if (!type || !orgId)
+        fail('Usage: checkbox query <type> <payload-json> --org <id>');
+    const payload = payloadRaw ? JSON.parse(payloadRaw) : {};
+    print(await apiPost('/api/v2/query', {
+        type,
+        organization_id: orgId,
+        payload: { ...payload, organization_id: orgId },
+    }));
+}
+async function cmdWorkspace(args) {
+    const orgId = getFlag(args, '--org');
+    if (!orgId)
+        fail('Usage: checkbox workspace --org <id>');
+    print(await apiPost('/api/v2/introspection/workspace', { organization_id: orgId }));
+}
+async function cmdEntities(args) {
+    const orgId = getFlag(args, '--org');
+    if (!orgId)
+        fail('Usage: checkbox entities --org <id> [--type <t>] [--search <s>]');
+    const entityType = getFlag(args, '--type');
+    const search = getFlag(args, '--search');
+    const limit = getFlag(args, '--limit');
+    print(await apiPost('/api/v2/introspection/entities', {
+        organization_id: orgId,
+        entity_type: entityType,
+        search,
+        limit: limit ? parseInt(limit, 10) : undefined,
+    }));
+}
+async function cmdSchema(args) {
+    const orgId = getFlag(args, '--org');
+    if (!orgId)
+        fail('Usage: checkbox schema --org <id> [--type <t>] [--entity-id <id>]');
+    const entityType = getFlag(args, '--type');
+    const entityId = getFlag(args, '--entity-id');
+    print(await apiPost('/api/v2/introspection/schema', {
+        organization_id: orgId,
+        entity_type: entityType,
+        entity_id: entityId,
+    }));
+}
+async function cmdPermissions(args) {
+    const orgId = getFlag(args, '--org');
+    if (!orgId)
+        fail('Usage: checkbox permissions --org <id>');
+    print(await apiPost('/api/v2/introspection/permissions', { organization_id: orgId }));
+}
+async function cmdOrganizations() {
+    print(await apiPost('/api/v2/query', {
+        type: 'list_my_organizations',
+        payload: {},
+    }));
+}
+function printUsage() {
+    console.log(`Checkbox CLI — interact with the Checkbox capability API
+
+Usage:
+  checkbox orgs                                          List your organizations
+  checkbox capabilities                                  List all capabilities
+  checkbox command <type> [payload-json] [--org <id>]    Execute a command
+  checkbox query <type> [payload-json] --org <id>        Execute a query
+  checkbox workspace --org <id>                          Get workspace graph
+  checkbox entities --org <id> [--type <t>] [--search <s>]  Find entities
+  checkbox schema --org <id> [--type <t>]                Get entity schemas
+  checkbox permissions --org <id>                        Check permissions
+
+Environment:
+  CHECKBOX_API_URL    Base URL (default: https://checkbox.my)
+  CHECKBOX_API_TOKEN  API key (ck_live_...) or Supabase JWT
+
+Get your API key:
+  1. Log in to checkbox.my
+  2. Go to Developer Hub (sidebar)
+  3. Create an API key — it never expires unless you configure an expiry
+
+Examples:
+  export CHECKBOX_API_TOKEN="ck_live_your_key_here"
+
+  checkbox orgs
+  checkbox capabilities
+  checkbox command create_plan '{"name":"Q2 Safety"}' --org <org-id>
+  checkbox command complete_task '{"task_id":"abc-123"}' --org <org-id>
+  checkbox query get_task_states '{"date":"2026-03-12"}' --org <org-id>
+  checkbox entities --org <org-id> --type task --search "Daily check"
+`);
+}
+// ── Main ────────────────────────────────────────────────────────────
+async function main() {
+    const args = process.argv.slice(2);
+    const sub = args[0];
+    const rest = args.slice(1);
+    if (!API_TOKEN && sub !== undefined && sub !== 'help' && sub !== '--help') {
+        console.error('Warning: CHECKBOX_API_TOKEN is not set. Authenticated requests will fail.');
+        console.error('Get an API key: log in to checkbox.my → Developer Hub → Create Key\n');
+    }
+    switch (sub) {
+        case 'orgs':
+        case 'organizations':
+            return cmdOrganizations();
+        case 'capabilities':
+            return cmdCapabilities();
+        case 'command':
+        case 'cmd':
+            return cmdCommand(rest);
+        case 'query':
+            return cmdQuery(rest);
+        case 'workspace':
+            return cmdWorkspace(rest);
+        case 'entities':
+            return cmdEntities(rest);
+        case 'schema':
+            return cmdSchema(rest);
+        case 'permissions':
+            return cmdPermissions(rest);
+        case 'help':
+        case '--help':
+        case '-h':
+        case undefined:
+            return printUsage();
+        default:
+            console.error(`Unknown subcommand: ${sub}\n`);
+            printUsage();
+            process.exit(1);
+    }
+}
+main().catch((err) => {
+    console.error('Fatal:', err);
+    process.exit(1);
+});
+export {};

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "checkbox-cli",
+  "version": "1.1.0",
+  "description": "CLI for the Checkbox capability API — create compliance plans, manage tasks, query workspaces, and automate from the terminal.",
+  "type": "module",
+  "main": "dist/checkbox.js",
+  "bin": {
+    "checkbox": "dist/checkbox.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "tsc",
+    "start": "node dist/checkbox.js",
+    "dev": "tsx src/checkbox.ts"
+  },
+  "keywords": [
+    "checkbox",
+    "compliance",
+    "cli",
+    "automation",
+    "task-management",
+    "ai-agent"
+  ],
+  "author": "Checkbox <hello@checkbox.my>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/fadhelcarlos/checkbox.git",
+    "directory": "cli"
+  },
+  "homepage": "https://checkbox.my",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.0",
+    "tsx": "^4.19.0",
+    "@types/node": "^22.0.0"
+  }
+}