brex-cli 0.0.0-canary.107cbde

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ex3ndr
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,552 @@
+# brex-cli
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+A powerful CLI for the [Brex Platform API](https://developer.brex.com/). Manage accounts, transactions, transfers, recipients, webhooks, and more from your terminal.
+
+## Features
+
+- **Full Brex API coverage** — accounts, transactions, transfers, recipients, cards, statements, webhooks, and more
+- **Multiple output formats** — human-readable tables or JSON for scripting
+- **Secure token storage** — credentials stored safely in `~/.brex/`
+- **Cash & card accounts** — unified interface for both account types
+- **Scriptable** — no interactive prompts, perfect for CI/CD and automation
+
+## Installation
+
+```bash
+npm install -g brex-cli
+```
+
+### Requirements
+
+- Node.js v18 or later
+
+---
+
+## Quick Start
+
+```bash
+# 1. Get your API token from Brex Developer Portal
+#    https://developer.brex.com/
+
+# 2. Authenticate
+brex login --token <YOUR_API_TOKEN>
+
+# 3. List your accounts
+brex accounts list
+
+# 4. View transactions
+brex transactions <account-id>
+```
+
+---
+
+## Global Options
+
+All commands support these global options:
+
+| Option | Description |
+|--------|-------------|
+| `--json` | Output as JSON instead of human-readable tables |
+| `-h`, `--help` | Show help for the command |
+| `-v`, `--version` | Show CLI version |
+
+---
+
+## Authentication
+
+Brex CLI uses API tokens for authentication. Tokens are stored locally in `~/.brex/token`.
+
+### Getting Your API Token
+
+1. Log in to the [Brex Developer Portal](https://developer.brex.com/)
+2. Create an API token with the appropriate scopes
+3. Copy the token
+
+### `brex login`
+
+Store an API token for authentication.
+
+**Syntax:**
+```
+brex login --token <TOKEN>
+brex login --token-stdin
+```
+
+**Flags:**
+
+| Flag | Required | Description |
+|------|----------|-------------|
+| `--token <TOKEN>` | One of these | API token string |
+| `--token-stdin` | One of these | Read token from stdin |
+
+**Examples:**
+
+```bash
+# Direct token input
+brex login --token "brex_prod_xxx..."
+
+# From environment variable
+brex login --token "$BREX_TOKEN"
+
+# From stdin (CI/CD friendly)
+echo "$BREX_TOKEN" | brex login --token-stdin
+
+# From file
+cat ~/.secrets/brex | brex login --token-stdin
+```
+
+---
+
+### `brex logout`
+
+Remove stored authentication token.
+
+```bash
+brex logout
+```
+
+---
+
+### `brex status`
+
+Show current authentication and configuration status.
+
+```bash
+brex status
+```
+
+**Example Output:**
+```
+Brex CLI Status
+──────────────────
+Authenticated: Yes
+Token: brex_prod...xxxx
+API Base URL: https://platform.brexapis.com
+Default Account: abc123-def456-...
+```
+
+---
+
+## Token Storage & Configuration
+
+| File | Purpose |
+|------|---------|
+| `~/.brex/token` | API token |
+| `~/.brex/config.json` | Optional configuration (default account, API base URL) |
+
+---
+
+## Accounts
+
+Manage Brex bank accounts (cash and card).
+
+**Aliases:** `account`, `acc`
+
+### `brex accounts list`
+
+List all accounts.
+
+**Syntax:**
+```
+brex accounts list [--type cash|card|all] [--cursor <cursor>] [--json]
+```
+
+**Options:**
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `--type` | string | `all` | Account type: `cash`, `card`, or `all` |
+| `--cursor` | string | none | Pagination cursor for next page |
+
+### `brex accounts get`
+
+Get detailed information about a specific account.
+
+**Syntax:**
+```
+brex accounts get <account-id> [--type cash|card] [--json]
+```
+
+---
+
+## Transactions
+
+View account transactions.
+
+**Aliases:** `tx`, `txn`
+
+### `brex transactions`
+
+List transactions for an account.
+
+**Syntax:**
+```
+brex transactions <account-id> [options] [--json]
+```
+
+**Options:**
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `--type` | string | `cash` | Account type: `cash` or `card` |
+| `--limit <N>` | integer | 25 | Maximum number of transactions to return |
+| `--cursor` | string | none | Pagination cursor |
+| `--start <date>` | ISO date | none | Filter transactions on or after this date |
+| `--end <date>` | ISO date | none | Filter transactions on or before this date |
+
+**Examples:**
+
+```bash
+# List recent transactions for a cash account
+brex transactions abc123-def456-...
+
+# Card transactions with limit
+brex transactions abc123-def456-... --type card --limit 50
+
+# Filter by date range
+brex transactions abc123-def456-... --start 2024-01-01 --end 2024-12-31
+
+# Paginate results
+brex transactions abc123-def456-... --cursor <cursor>
+```
+
+### `brex transactions get`
+
+Get detailed information about a specific transaction.
+
+**Syntax:**
+```
+brex transactions get <account-id> <transaction-id> [--type cash|card] [--json]
+```
+
+---
+
+## Transfers (Payments API)
+
+Create and manage outbound transfers.
+
+### `brex transfer`
+
+Send funds to a counterparty.
+
+**Syntax:**
+```
+brex transfer --from <cash-account-id> --to <counterparty-id> --amount <decimal> --idempotency-key <key> [--currency <code>] [--json]
+```
+
+**Options:**
+
+| Option | Required | Type | Description |
+|--------|----------|------|-------------|
+| `--from` | Yes | string | Source cash account ID |
+| `--to` | Yes | string | Counterparty ID (recipient) |
+| `--amount` | Yes | decimal | Amount (e.g., `125.50`) |
+| `--idempotency-key` | Yes | string | Unique key to prevent duplicate transfers |
+| `--currency` | No | string | Currency code (default: `USD`) |
+
+**Examples:**
+
+```bash
+# Send $125.50 to a recipient
+brex transfer --from acc-123 --to cpty-456 --amount 125.50 --idempotency-key "inv-2024-001"
+```
+
+### `brex transfer get`
+
+Get details about a specific transfer.
+
+```bash
+brex transfer get <transfer-id> [--json]
+```
+
+### `brex transfer list`
+
+List transfers with optional filters.
+
+**Syntax:**
+```
+brex transfer list [--status <status>] [--limit <N>] [--cursor <cursor>] [--json]
+```
+
+**Options:**
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `--status` | string | Filter by status (e.g., `PROCESSING`, `COMPLETED`) |
+| `--limit` | integer | Maximum results |
+| `--cursor` | string | Pagination cursor |
+| `--from-account-id` | string | Filter by source account |
+| `--to-counterparty-id` | string | Filter by recipient |
+
+---
+
+## Recipients (Payment Counterparties)
+
+Manage payment recipients for outbound transfers.
+
+**Aliases:** `recipient`, `recip`
+
+### `brex recipients list`
+
+List all recipients.
+
+**Syntax:**
+```
+brex recipients [list] [--limit <N>] [--cursor <cursor>] [--name <name>] [--json]
+```
+
+### `brex recipients get`
+
+Get details about a recipient.
+
+```bash
+brex recipients get <counterparty-id> [--json]
+```
+
+### `brex recipients add`
+
+Add a new payment recipient.
+
+**Syntax:**
+```
+brex recipients add --name <name> --account <number> --routing <number> [options] [--json]
+```
+
+**Options:**
+
+| Option | Required | Type | Description |
+|--------|----------|------|-------------|
+| `--name` | Yes | string | Recipient name |
+| `--account` | Yes | string | Bank account number |
+| `--routing` | Yes | string | Bank routing number (9 digits) |
+| `--account-type` | No | string | `CHECKING` or `SAVINGS` |
+| `--country` | No | string | Country code |
+| `--currency` | No | string | Currency code |
+
+### `brex recipients delete`
+
+Delete a recipient.
+
+```bash
+brex recipients delete <counterparty-id>
+```
+
+---
+
+## Cards
+
+View card information.
+
+**Aliases:** `card`
+
+### `brex cards list`
+
+List cards with optional filters.
+
+**Syntax:**
+```
+brex cards [list] [--user-id <user-id>] [--cursor <cursor>] [--limit <N>] [--json]
+```
+
+### `brex cards get`
+
+Get details about a specific card.
+
+```bash
+brex cards get <card-id> [--json]
+```
+
+---
+
+## Users
+
+List and view organization members.
+
+**Aliases:** `user`
+
+### `brex users list`
+
+List all users in the organization.
+
+**Syntax:**
+```
+brex users [list] [--cursor <cursor>] [--email <email>] [--json]
+```
+
+### `brex users get`
+
+Get details about a specific user.
+
+```bash
+brex users get <user-id> [--json]
+```
+
+---
+
+## Organization
+
+**Aliases:** `org`
+
+### `brex organization`
+
+Get organization information (legal name, DBA, status, address).
+
+```bash
+brex organization [--json]
+```
+
+---
+
+## Statements
+
+View card account statements.
+
+**Aliases:** `statement`
+
+### `brex statements`
+
+List statements for a card account.
+
+**Syntax:**
+```
+brex statements [--scope primary|additional] [--account-id <id>] [--cursor <cursor>] [--json]
+```
+
+**Options:**
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `--scope` | string | `primary` | `primary` or `additional` card account |
+| `--account-id` | string | none | Required when scope is `additional` |
+| `--cursor` | string | none | Pagination cursor |
+
+### `brex statements get`
+
+Get a specific statement.
+
+```bash
+brex statements get <statement-id> [--scope primary|additional] [--account-id <id>] [--json]
+```
+
+---
+
+## Webhooks
+
+Manage webhook endpoints.
+
+**Aliases:** `webhook`, `wh`
+
+### `brex webhooks list`
+
+List all webhook endpoints.
+
+```bash
+brex webhooks [list] [--cursor <cursor>] [--limit <N>] [--json]
+```
+
+### `brex webhooks get`
+
+Get details about a webhook.
+
+```bash
+brex webhooks get <webhook-id> [--json]
+```
+
+### `brex webhooks create`
+
+Create a new webhook endpoint.
+
+**Syntax:**
+```
+brex webhooks create --url <url> [--events <event1,event2>] [--status <status>] [--json]
+```
+
+**Event Types:** `PAYMENT_COMPLETED`, `TRANSFER_COMPLETED`, and others.
+
+### `brex webhooks update`
+
+Update an existing webhook.
+
+```bash
+brex webhooks update <webhook-id> [--url <url>] [--status <status>] [--events <events>] [--json]
+```
+
+### `brex webhooks delete`
+
+Delete a webhook endpoint.
+
+```bash
+brex webhooks delete <webhook-id>
+```
+
+---
+
+## Events
+
+View webhook event history.
+
+**Aliases:** `event`
+
+### `brex events list`
+
+List webhook events.
+
+**Syntax:**
+```
+brex events [list] [--event-type <type>] [--after-date <ISO>] [--before-date <ISO>] [--cursor <cursor>] [--limit <N>] [--json]
+```
+
+### `brex events get`
+
+Get details about a specific event.
+
+```bash
+brex events get <event-id> [--json]
+```
+
+---
+
+## Scripting Examples
+
+### Export Transactions to CSV
+
+```bash
+brex transactions "$ACCOUNT_ID" --json | \
+  jq -r '.[] | [.id, .status, .amount, .counterpartyName] | @csv'
+```
+
+### Daily Balance Check
+
+```bash
+brex accounts get "$ACCOUNT_ID" --type cash --json | jq -r '.availableBalance'
+```
+
+---
+
+## API Reference
+
+- **Base URL:** `https://platform.brexapis.com`
+- **Authentication:** Bearer token
+- **Documentation:** [developer.brex.com](https://developer.brex.com/)
+
+### API Sources
+
+| Domain | Reference |
+|--------|-----------|
+| Authentication | [developer.brex.com/openapi/authentication](https://developer.brex.com/openapi/authentication) |
+| Transactions | [developer.brex.com/openapi/transactions](https://developer.brex.com/openapi/transactions) |
+| Team | [developer.brex.com/openapi/team](https://developer.brex.com/openapi/team) |
+| Payments | [developer.brex.com/openapi/payments](https://developer.brex.com/openapi/payments) |
+| Webhooks | [developer.brex.com/openapi/webhooks](https://developer.brex.com/openapi/webhooks) |
+
+---
+
+## Disclaimer
+
+This is an unofficial CLI. Verify scopes, permissions, and request payload requirements in Brex docs before production use.
+
+## License
+
+MIT License. See [LICENSE](LICENSE) for details.