@getalby/cli 0.0.0 → 0.0.1

package/README.md

@@ -48,14 +48,41 @@ npx @getalby/cli -c "nostr+walletconnect://..." make-invoice --amount 1000 --des
 # Pay an invoice
 npx @getalby/cli -c "nostr+walletconnect://..." pay-invoice --invoice "lnbc..."
 
+# Send a keysend payment
+npx @getalby/cli -c "nostr+walletconnect://..." pay-keysend --pubkey "02abc..." --amount 100
+
 # Look up an invoice by payment hash
 npx @getalby/cli -c "nostr+walletconnect://..." lookup-invoice --payment-hash "abc123..."
 
 # List transactions
 npx @getalby/cli -c "nostr+walletconnect://..." list-transactions --limit 10
 
+# Get wallet budget
+npx @getalby/cli -c "nostr+walletconnect://..." get-budget
+
+# Sign a message
+npx @getalby/cli -c "nostr+walletconnect://..." sign-message --message "Hello, World!"
+
 # Fetch L402-protected resource
 npx @getalby/cli -c "nostr+walletconnect://..." fetch-l402 --url "https://example.com/api"
+
+# Wait for a payment notification
+npx @getalby/cli -c "nostr+walletconnect://..." wait-for-payment --payment-hash "abc123..."
+```
+
+### HOLD Invoices
+
+HOLD invoices allow you to accept payments conditionally - the payment is held until you settle or cancel it.
+
+```bash
+# Create a HOLD invoice (you provide the payment hash)
+npx @getalby/cli -c "nostr+walletconnect://..." make-hold-invoice --amount 1000 --payment-hash "abc123..."
+
+# Settle a HOLD invoice (claim the payment)
+npx @getalby/cli -c "nostr+walletconnect://..." settle-hold-invoice --preimage "def456..."
+
+# Cancel a HOLD invoice (reject the payment)
+npx @getalby/cli -c "nostr+walletconnect://..." cancel-hold-invoice --payment-hash "abc123..."
 ```
 
 ### Lightning Tools
@@ -66,28 +93,61 @@ These commands don't require a wallet connection:
 # Convert USD to sats
 npx @getalby/cli fiat-to-sats --currency USD --amount 10
 
+# Convert sats to USD
+npx @getalby/cli sats-to-fiat --amount 1000 --currency USD
+
 # Parse a BOLT-11 invoice
 npx @getalby/cli parse-invoice --invoice "lnbc..."
 
+# Verify a preimage against an invoice
+npx @getalby/cli verify-preimage --invoice "lnbc..." --preimage "abc123..."
+
 # Request invoice from lightning address
-npx @getalby/cli request-invoice --address "hello@getalby.com" --amount 1000
+npx @getalby/cli request-invoice-from-lightning-address --address "hello@getalby.com" --amount 1000
 ```
 
 ## Command Reference
 
+### Wallet Commands
+
+These require `--connection-secret`:
+
 | Command | Description | Required Options |
 |---------|-------------|------------------|
 | `get-balance` | Get wallet balance | - |
 | `get-info` | Get wallet info | - |
 | `get-wallet-service-info` | Get wallet capabilities | - |
+| `get-budget` | Get wallet budget | - |
 | `make-invoice` | Create a lightning invoice | `--amount` |
 | `pay-invoice` | Pay a lightning invoice | `--invoice` |
+| `pay-keysend` | Send a keysend payment | `--pubkey`, `--amount` |
 | `lookup-invoice` | Look up an invoice | `--payment-hash` or `--invoice` |
 | `list-transactions` | List transactions | - |
+| `sign-message` | Sign a message with wallet key | `--message` |
+| `wait-for-payment` | Wait for payment notification | `--payment-hash` |
+| `fetch-l402` | Fetch L402-protected resource | `--url` |
+
+### HOLD Invoice Commands
+
+These require `--connection-secret`:
+
+| Command | Description | Required Options |
+|---------|-------------|------------------|
+| `make-hold-invoice` | Create a HOLD invoice | `--amount`, `--payment-hash` |
+| `settle-hold-invoice` | Settle a HOLD invoice | `--preimage` |
+| `cancel-hold-invoice` | Cancel a HOLD invoice | `--payment-hash` |
+
+### Lightning Tools
+
+These don't require a wallet connection:
+
+| Command | Description | Required Options |
+|---------|-------------|------------------|
 | `fiat-to-sats` | Convert fiat to sats | `--currency`, `--amount` |
+| `sats-to-fiat` | Convert sats to fiat | `--amount`, `--currency` |
 | `parse-invoice` | Parse a BOLT-11 invoice | `--invoice` |
-| `request-invoice` | Request invoice from lightning address | `--address`, `--amount` |
-| `fetch-l402` | Fetch L402-protected resource | `--url` |
+| `verify-preimage` | Verify preimage against invoice | `--invoice`, `--preimage` |
+| `request-invoice-from-lightning-address` | Request invoice from lightning address | `--address`, `--amount` |
 
 ## Output
 

package/build/commands/{request-invoice.js → request-invoice-from-lightning-address.js}

@@ -1,15 +1,15 @@
-import { requestInvoice } from "../tools/lightning/request_invoice.js";
+import { requestInvoiceFromLightningAddress } from "../tools/lightning/request_invoice_from_lightning_address.js";
 import { handleError, output } from "../utils.js";
-export function registerRequestInvoiceCommand(program) {
+export function registerRequestInvoiceFromLightningAddressCommand(program) {
     program
-        .command("request-invoice")
-        .description("Request invoice from lightning address")
+        .command("request-invoice-from-lightning-address")
+        .description("Request an invoice from a lightning address")
         .requiredOption("-a, --address <ln-address>", "Lightning address")
         .requiredOption("-s, --amount <sats>", "Amount in sats", parseInt)
         .option("--comment <text>", "Optional comment")
         .action(async (options) => {
         await handleError(async () => {
-            const result = await requestInvoice({
+            const result = await requestInvoiceFromLightningAddress({
                 lightning_address: options.address,
                 amount_in_sats: options.amount,
                 comment: options.comment,

package/build/index.js

@@ -18,7 +18,7 @@ import { registerFiatToSatsCommand } from "./commands/fiat-to-sats.js";
 import { registerSatsToFiatCommand } from "./commands/sats-to-fiat.js";
 import { registerParseInvoiceCommand } from "./commands/parse-invoice.js";
 import { registerVerifyPreimageCommand } from "./commands/verify-preimage.js";
-import { registerRequestInvoiceCommand } from "./commands/request-invoice.js";
+import { registerRequestInvoiceFromLightningAddressCommand } from "./commands/request-invoice-from-lightning-address.js";
 import { registerFetchL402Command } from "./commands/fetch-l402.js";
 const program = new Command();
 program
@@ -45,6 +45,6 @@ registerFiatToSatsCommand(program);
 registerSatsToFiatCommand(program);
 registerParseInvoiceCommand(program);
 registerVerifyPreimageCommand(program);
-registerRequestInvoiceCommand(program);
+registerRequestInvoiceFromLightningAddressCommand(program);
 registerFetchL402Command(program);
 program.parse();

package/build/test/lightning-tools.test.js

@@ -28,8 +28,8 @@ describe("Lightning Tools (no wallet required)", () => {
         expect(result.success).toBe(true);
         expect(result.output.valid).toBe(false);
     });
-    test("request-invoice requests invoice from lightning address", async () => {
-        const result = runCli(`request-invoice -a "${exampleLightningAddress}" -s 100`);
+    test("request-invoice-from-lightning-address requests invoice from lightning address", async () => {
+        const result = runCli(`request-invoice-from-lightning-address -a "${exampleLightningAddress}" -s 100`);
         expect(result.success).toBe(true);
         expect(result.output.paymentRequest.toLowerCase()).toMatch(/^lnbc/);
     });

package/build/tools/lightning/{request_invoice.js → request_invoice_from_lightning_address.js}

@@ -1,5 +1,5 @@
 import { LightningAddress } from "@getalby/lightning-tools";
-export async function requestInvoice(params) {
+export async function requestInvoiceFromLightningAddress(params) {
     const ln = new LightningAddress(params.lightning_address);
     await ln.fetch();
     const { satoshi, ...invoice } = await ln.requestInvoice({

package/package.json

@@ -2,7 +2,7 @@
   "name": "@getalby/cli",
   "description": "CLI for Nostr Wallet Connect (NIP-47) with a few additional useful lightning tools",
   "repository": "https://github.com/getAlby/cli.git",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "type": "module",
   "main": "build/index.js",
   "bin": {