@timbrix/cli 0.1.0

package/README.md

@@ -0,0 +1,319 @@
+# @timbrix/cli
+
+```
+  _____ _           _          _      
+ |_   _(_)_ __ ___ | |__  _ __(_)_  __
+   | | | | '_ ` _ \| '_ \| '__| \ \/ /
+   | | | | | | | | | |_) | |  | |>  < 
+   |_| |_|_| |_| |_|_.__/|_|  |_/_/\_\
+```
+
+Official CLI tool for the Timbrix API.
+
+## Installation
+
+```bash
+npm install -g @timbrix/cli
+# or
+pnpm add -g @timbrix/cli
+```
+
+## Quick Start
+
+```bash
+# Login to your Timbrix account
+timbrix login
+
+# List your organizations
+timbrix organizations list
+
+# Create a webhook
+timbrix webhooks create --org <organization-id>
+
+# Logout
+timbrix logout
+```
+
+## Authentication
+
+### Login
+
+```bash
+timbrix login
+# Or provide email directly
+timbrix login --email user@example.com
+```
+
+Credentials are saved to `~/.timbrix/config.json`
+
+### Logout
+
+```bash
+timbrix logout
+```
+
+## Commands
+
+### Organizations
+
+```bash
+# List all organizations
+timbrix organizations list
+
+# Get organization details
+timbrix organizations get <slug>
+
+# Create organization
+timbrix organizations create
+timbrix organizations create --name "Acme Corp" --slug acme-corp
+
+# Delete organization (PERMANENT)
+timbrix organizations delete <slug>
+timbrix organizations delete <slug> --force  # Skip confirmation
+```
+
+### Webhooks
+
+```bash
+# List webhooks
+timbrix webhooks list --org <organization-id>
+
+# Get webhook details
+timbrix webhooks get <webhook-id> --org <organization-id>
+
+# Create webhook
+timbrix webhooks create --org <organization-id>
+timbrix webhooks create --org <organization-id> --url https://example.com/webhook
+
+# Delete webhook (PERMANENT)
+timbrix webhooks delete <webhook-id> --org <organization-id>
+timbrix webhooks delete <webhook-id> --org <organization-id> --force
+```
+
+### API Keys
+
+```bash
+# List API keys
+timbrix api-keys list --org <organization-id>
+
+# Get API key details
+timbrix api-keys get <api-key-id> --org <organization-id>
+
+# Create API key
+timbrix api-keys create --org <organization-id>
+timbrix api-keys create --org <organization-id> --name "Production Key"
+timbrix api-keys create --org <organization-id> --name "Staging Key" --expires 2025-12-31T23:59:59Z
+
+# Revoke API key (PERMANENT)
+timbrix api-keys delete <api-key-id> --org <organization-id>
+timbrix api-keys delete <api-key-id> --org <organization-id> --force
+```
+
+## Global Commands
+
+```bash
+# Show help for any command
+timbrix --help
+timbrix <command> --help
+
+# Show CLI version
+timbrix --version
+
+# Update to latest version
+timbrix update
+```
+
+## Examples
+
+### Complete Workflow
+
+```bash
+# 1. Login
+timbrix login
+
+# 2. Create organization
+timbrix organizations create --name "My Company" --slug my-company
+
+# 3. Get organization ID
+timbrix organizations get my-company
+# Copy the ID from output
+
+# 4. Create webhook
+timbrix webhooks create --org <org-id> --url https://api.mycompany.com/webhooks
+
+# 5. Create API key for external services
+timbrix api-keys create --org <org-id> --name "Production API Key"
+
+# 6. List all resources
+timbrix organizations list
+timbrix webhooks list --org <org-id>
+timbrix api-keys list --org <org-id>
+```
+
+### Using in CI/CD
+
+```bash
+# Set credentials as environment variable in CI
+export TIMBRIX_TOKEN="your-token"
+
+# Or login programmatically (if your API supports it)
+echo "password" | timbrix login --email ci@example.com
+
+# Create API key for deployment
+timbrix api-keys create --org $ORG_ID --name "CI/CD Key"
+```
+
+## Configuration
+
+Configuration is stored in `~/.timbrix/config.json`:
+
+```json
+{
+  "bearerToken": "eyJhbGc...",
+  "email": "user@example.com",
+  "baseUrl": "http://localhost:3001/api"
+}
+```
+
+To use a different API URL:
+
+```bash
+timbrix login --base-url https://api.timbrix.com
+```
+
+### Theme Customization
+
+The CLI comes with a modern color theme. Users can customize it by creating a `theme.json` file in `~/.timbrix/`:
+
+```json
+{
+  "bin": "cyan",
+  "command": "greenBright",
+  "flag": "blueBright",
+  "flagRequired": "redBright"
+}
+```
+
+To disable the theme:
+
+```bash
+TIMBRIX_DISABLE_THEME=1 timbrix --help
+```
+
+### Update Notifications
+
+The CLI automatically checks for updates once per week and notifies you when a new version is available.
+
+**Update manually:**
+
+```bash
+# Check and update to latest version
+timbrix update
+
+# The update command will:
+# - Check for new versions
+# - Detect your package manager (pnpm, yarn, or npm)
+# - Update automatically to the latest version
+```
+
+**Disable notifications:**
+
+```bash
+NO_UPDATE_NOTIFIER=1 timbrix login
+```
+
+## Features
+
+### 🎨 Modern UI
+
+- **ASCII Logo**: Beautiful Timbrix logo displayed on help and login commands
+- **Custom Theme**: Vibrant color scheme with cyan, green, and blue highlights
+- **Syntax Highlighting**: Color-coded JSON output for better readability
+
+### 🔔 Update Notifications
+
+The CLI automatically checks for new versions once per week and notifies you when an update is available. Checks are non-blocking and respect CI environments.
+
+### 🛠️ Built with
+
+- **oclif**: Modern CLI framework
+- **TypeScript**: Type-safe development
+- **chalk**: Terminal colors
+- **inquirer**: Interactive prompts
+- **ora**: Elegant spinners
+- **cli-table3**: Beautiful tables
+
+## Architecture
+
+```
+src/
+├── commands/           # CLI commands
+│   ├── login.ts       # Authentication
+│   ├── logout.ts
+│   ├── organizations/ # Organization management
+│   ├── webhooks/      # Webhook management
+│   └── api-keys/      # API key management
+├── config/
+│   └── auth.ts        # Auth configuration manager
+├── utils/
+│   ├── logo.ts        # ASCII logo
+│   ├── table.ts       # Table formatting
+│   ├── client.ts      # API client
+│   └── update-notifier.ts
+├── hooks/
+│   └── init/
+│       └── update-check.ts  # Update check hook
+└── help.ts            # Custom help class
+```
+
+## Development
+
+```bash
+# Install dependencies
+pnpm install
+
+# Build
+pnpm build
+
+# Run locally with hot-reload
+pnpm dev
+
+# Link for local testing
+pnpm link --global
+
+# Type check
+pnpm check-types
+
+# Lint
+pnpm lint
+```
+
+## Troubleshooting
+
+### Authentication Error
+
+```bash
+Error: Not authenticated. Please run 'timbrix login' first.
+```
+
+**Solution**: Run `timbrix login` to authenticate.
+
+### API Connection Error
+
+```bash
+Failed to fetch organizations: connect ECONNREFUSED
+```
+
+**Solution**: Check that your API is running and the base URL is correct.
+
+### Invalid Token
+
+```bash
+Authentication failed: 401 Unauthorized
+```
+
+**Solution**: Your token may have expired. Run `timbrix logout` then `timbrix login` again.
+
+## License
+
+MIT

package/bin/run.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { execute } from '@oclif/core'
+
+await execute({development: false, dir: import.meta.url})

package/dist/commands/api-keys/create.d.ts

@@ -0,0 +1,12 @@
+import { Command } from "@oclif/core";
+export default class ApiKeysCreate extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        org: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        name: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        expires: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}
+//# sourceMappingURL=create.d.ts.map

package/dist/commands/api-keys/create.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create.d.ts","sourceRoot":"","sources":["../../../src/commands/api-keys/create.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAS,MAAM,aAAa,CAAA;AAM5C,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,OAAO;IAChD,OAAgB,WAAW,SAAyB;IAEpD,OAAgB,QAAQ,WAGvB;IAED,OAAgB,KAAK;;;;MAepB;IAEY,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAmDlC"}

package/dist/commands/api-keys/create.js

@@ -0,0 +1,65 @@
+import { input } from "@inquirer/prompts";
+import { Command, Flags } from "@oclif/core";
+import chalk from "chalk";
+import ora from "ora";
+import { createClient } from "../../utils/client.js";
+import { getErrorMessage } from "../../utils/error.js";
+export default class ApiKeysCreate extends Command {
+    static description = "Create a new API key";
+    static examples = [
+        "<%= config.bin %> <%= command.id %> --org acme-corp-id",
+        "<%= config.bin %> <%= command.id %> --org acme-corp-id --name 'Production Key'",
+    ];
+    static flags = {
+        org: Flags.string({
+            char: "o",
+            description: "Organization ID",
+            required: true,
+        }),
+        name: Flags.string({
+            char: "n",
+            description: "API key name",
+        }),
+        expires: Flags.string({
+            char: "e",
+            description: "Expiration date (ISO 8601 format, e.g., 2025-12-31T23:59:59Z)",
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(ApiKeysCreate);
+        const client = createClient();
+        try {
+            // Get API key name
+            const name = flags.name ||
+                (await input({
+                    message: "API key name:",
+                    validate: (value) => {
+                        if (value.length < 3) {
+                            return "Name must be at least 3 characters";
+                        }
+                        return true;
+                    },
+                }));
+            const spinner = ora("Creating API key...").start();
+            const apiKey = await client.apiKeys.create(flags.org, {
+                name,
+                expiresAt: flags.expires,
+            });
+            spinner.succeed(chalk.green("✓ API key created successfully!"));
+            this.log(chalk.gray("\nAPI Key Details:"));
+            this.log(`  ${chalk.bold("ID:")} ${apiKey.apiKey.id}`);
+            this.log(`  ${chalk.bold("Name:")} ${apiKey.apiKey.name}`);
+            this.log(`  ${chalk.bold("Key:")} ${apiKey.plainKey}`);
+            if (apiKey.apiKey.expiresAt) {
+                this.log(`  ${chalk.bold("Expires:")} ${new Date(apiKey.apiKey.expiresAt).toLocaleString()}`);
+            }
+            else {
+                this.log(`  ${chalk.bold("Expires:")} Never`);
+            }
+            this.log(chalk.yellow("\n⚠️  Save these credentials - they won't be shown again!"));
+        }
+        catch (error) {
+            this.error(chalk.red(`Failed to create API key: ${getErrorMessage(error)}`));
+        }
+    }
+}

package/dist/commands/api-keys/delete.d.ts

@@ -0,0 +1,14 @@
+import { Command } from "@oclif/core";
+export default class ApiKeysDelete extends Command {
+    static description: string;
+    static examples: string[];
+    static args: {
+        id: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static flags: {
+        org: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}
+//# sourceMappingURL=delete.d.ts.map

package/dist/commands/api-keys/delete.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"delete.d.ts","sourceRoot":"","sources":["../../../src/commands/api-keys/delete.ts"],"names":[],"mappings":"AACA,OAAO,EAAQ,OAAO,EAAS,MAAM,aAAa,CAAA;AAMlD,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,OAAO;IAChD,OAAgB,WAAW,SAAkC;IAE7D,OAAgB,QAAQ,WAGvB;IAED,OAAgB,IAAI;;MAKnB;IAED,OAAgB,KAAK;;;MAWpB;IAEY,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAgClC"}

package/dist/commands/api-keys/delete.js

@@ -0,0 +1,55 @@
+import { confirm } from "@inquirer/prompts";
+import { Args, Command, Flags } from "@oclif/core";
+import chalk from "chalk";
+import ora from "ora";
+import { createClient } from "../../utils/client.js";
+import { getErrorMessage } from "../../utils/error.js";
+export default class ApiKeysDelete extends Command {
+    static description = "Revoke an API key (PERMANENT)";
+    static examples = [
+        "<%= config.bin %> <%= command.id %> api-key-id --org acme-corp-id",
+        "<%= config.bin %> <%= command.id %> api-key-id --org acme-corp-id --force",
+    ];
+    static args = {
+        id: Args.string({
+            description: "API key ID",
+            required: true,
+        }),
+    };
+    static flags = {
+        org: Flags.string({
+            char: "o",
+            description: "Organization ID",
+            required: true,
+        }),
+        force: Flags.boolean({
+            char: "f",
+            description: "Skip confirmation prompt",
+            default: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(ApiKeysDelete);
+        const client = createClient();
+        try {
+            // Confirm deletion
+            if (!flags.force) {
+                const confirmed = await confirm({
+                    message: chalk.yellow(`Are you sure you want to revoke this API key? This action cannot be undone.`),
+                    default: false,
+                });
+                if (!confirmed) {
+                    this.log(chalk.gray("Revocation cancelled"));
+                    return;
+                }
+            }
+            const spinner = ora("Revoking API key...").start();
+            await client.apiKeys.delete(flags.org, args.id);
+            spinner.succeed(chalk.green("✓ API key revoked successfully!"));
+            this.log(chalk.gray("\nThe API key will stop working immediately."));
+        }
+        catch (error) {
+            this.error(chalk.red(`Failed to revoke API key: ${getErrorMessage(error)}`));
+        }
+    }
+}

package/dist/commands/api-keys/get.d.ts

@@ -0,0 +1,13 @@
+import { Command } from "@oclif/core";
+export default class ApiKeysGet extends Command {
+    static description: string;
+    static examples: string[];
+    static args: {
+        id: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static flags: {
+        org: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}
+//# sourceMappingURL=get.d.ts.map

package/dist/commands/api-keys/get.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get.d.ts","sourceRoot":"","sources":["../../../src/commands/api-keys/get.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAe,MAAM,aAAa,CAAA;AAMlD,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,OAAO;IAC7C,OAAgB,WAAW,SAAwB;IAEnD,OAAgB,QAAQ,WAEvB;IAED,OAAgB,IAAI;;MAKnB;IAED,OAAgB,KAAK;;MAMpB;IAEY,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAgClC"}

package/dist/commands/api-keys/get.js

@@ -0,0 +1,46 @@
+import { Command, Args, Flags } from "@oclif/core";
+import { createClient } from "../../utils/client.js";
+import { getErrorMessage } from "../../utils/error.js";
+import chalk from "chalk";
+import ora from "ora";
+export default class ApiKeysGet extends Command {
+    static description = "Get API key details";
+    static examples = [
+        "<%= config.bin %> <%= command.id %> api-key-id --org acme-corp-id",
+    ];
+    static args = {
+        id: Args.string({
+            description: "API key ID",
+            required: true,
+        }),
+    };
+    static flags = {
+        org: Flags.string({
+            char: "o",
+            description: "Organization ID",
+            required: true,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(ApiKeysGet);
+        const client = createClient();
+        const spinner = ora("Fetching API key...").start();
+        try {
+            const apiKey = await client.apiKeys.get(flags.org, args.id);
+            spinner.stop();
+            this.log(chalk.cyan.bold("\nAPI Key Details:"));
+            this.log(`  ${chalk.bold("ID:")} ${apiKey.id}`);
+            this.log(`  ${chalk.bold("Organization ID:")} ${apiKey.organizationId}`);
+            this.log(`  ${chalk.bold("Name:")} ${apiKey.name}`);
+            this.log(`  ${chalk.bold("Key:")} ${apiKey.keyPreview}`);
+            this.log(`  ${chalk.bold("Last Used:")} ${apiKey.lastUsedAt ? new Date(apiKey.lastUsedAt).toLocaleString() : chalk.gray("Never")}`);
+            this.log(`  ${chalk.bold("Expires:")} ${apiKey.expiresAt ? new Date(apiKey.expiresAt).toLocaleString() : chalk.gray("Never")}`);
+            this.log(`  ${chalk.bold("Created:")} ${new Date(apiKey.createdAt).toLocaleString()}`);
+            this.log(`  ${chalk.bold("Updated:")} ${new Date(apiKey.updatedAt).toLocaleString()}`);
+        }
+        catch (error) {
+            spinner.fail(chalk.red("Failed to fetch API key"));
+            this.error(getErrorMessage(error));
+        }
+    }
+}

package/dist/commands/api-keys/list.d.ts

@@ -0,0 +1,10 @@
+import { Command } from "@oclif/core";
+export default class ApiKeysList extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        org: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}
+//# sourceMappingURL=list.d.ts.map

package/dist/commands/api-keys/list.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.d.ts","sourceRoot":"","sources":["../../../src/commands/api-keys/list.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAS,MAAM,aAAa,CAAA;AAQ5C,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,OAAO;IAC9C,OAAgB,WAAW,SAA0C;IAErE,OAAgB,QAAQ,WAEvB;IAED,OAAgB,KAAK;;MAMpB;IAEY,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAmDlC"}

package/dist/commands/api-keys/list.js

@@ -0,0 +1,61 @@
+import { Command, Flags } from "@oclif/core";
+import chalk from "chalk";
+import ora from "ora";
+import { createClient } from "../../utils/client.js";
+import { getErrorMessage } from "../../utils/error.js";
+import { createTable } from "../../utils/table.js";
+export default class ApiKeysList extends Command {
+    static description = "List all API keys for an organization";
+    static examples = [
+        "<%= config.bin %> <%= command.id %> --org acme-corp-id",
+    ];
+    static flags = {
+        org: Flags.string({
+            char: "o",
+            description: "Organization ID",
+            required: true,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(ApiKeysList);
+        const client = createClient();
+        const spinner = ora("Fetching API keys...").start();
+        try {
+            const apiKeys = await client.apiKeys.list(flags.org);
+            spinner.stop();
+            if (apiKeys.length === 0) {
+                this.log(chalk.yellow("No API keys found"));
+                this.log(chalk.gray(`\nCreate an API key with: timbrix api-keys create --org ${flags.org}`));
+                return;
+            }
+            const table = createTable([
+                "ID",
+                "Name",
+                "Key",
+                "Last Used",
+                "Expires",
+                "Created",
+            ]);
+            apiKeys.forEach((key) => {
+                table.push([
+                    key.id.substring(0, 8) + "...",
+                    key.name,
+                    key.keyPreview,
+                    key.lastUsedAt
+                        ? new Date(key.lastUsedAt).toLocaleDateString()
+                        : chalk.gray("Never"),
+                    key.expiresAt
+                        ? new Date(key.expiresAt).toLocaleDateString()
+                        : chalk.gray("Never"),
+                    new Date(key.createdAt).toLocaleDateString(),
+                ]);
+            });
+            this.log(table.toString());
+            this.log(chalk.gray(`\nTotal: ${apiKeys.length} API key(s)`));
+        }
+        catch (error) {
+            spinner.fail(chalk.red("Failed to fetch API keys"));
+            this.error(getErrorMessage(error));
+        }
+    }
+}

package/dist/commands/login.d.ts

@@ -0,0 +1,11 @@
+import { Command } from "@oclif/core";
+export default class Login extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        email: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        "base-url": import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}
+//# sourceMappingURL=login.d.ts.map

package/dist/commands/login.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"login.d.ts","sourceRoot":"","sources":["../../src/commands/login.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAS,MAAM,aAAa,CAAA;AAQ5C,MAAM,CAAC,OAAO,OAAO,KAAM,SAAQ,OAAO;IACxC,OAAgB,WAAW,SAAkC;IAE7D,OAAgB,QAAQ,WAGvB;IAED,OAAgB,KAAK;;;MAUpB;IAEY,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAgDlC"}