cdk-cli-0.13.1 is not a library.
CDK CLI
Warning This project is in early development, it does however work with real sats! Always use amounts you don't mind losing.
A command-line Cashu wallet implementation built with the Cashu Development Kit (CDK). This tool allows you to interact with Cashu mints from the terminal, performing operations like minting, melting, and transferring ecash tokens.
Features
- Multiple Mint Support: Connect to and manage multiple Cashu mints
- Token Operations: Mint, melt, send, and receive Cashu tokens
- Wallet Management: Create and manage multiple wallets
- Lightning Integration: Pay Lightning invoices and receive payments
- Token Storage: Secure local storage of tokens and mint configurations
Installation
Option 1: Download Pre-built Binary
Download the latest release from the GitHub releases page.
Option 2: Build from Source
# Binary will be at ./target/release/cdk-cli
Quick Start
1. Add a Mint
# Add a mint (use a real mint URL or start your own with cdk-mintd)
2. Mint Tokens
# Create a mint quote for 100 sats
# Pay the Lightning invoice shown, then mint the tokens
3. Send Tokens
# Send 50 sats as a token
4. Receive Tokens
# Receive a token from someone else
5. Check Balance
# View your current balance
Basic Usage
Wallet Operations
# List all wallets
# Create a new wallet
# Set default wallet
# Show wallet info
Mint Management
# List connected mints
# Remove a mint
# Get mint information
Payment Operations
# Pay a Lightning invoice
# Create melt quote for an invoice
# Execute the melt
Token Management
# List all tokens
# Check token states
# Restore wallet from seed
Configuration
The CLI stores its configuration and wallet data in:
- Linux/macOS:
~/.config/cdk-cli/
- Windows:
%APPDATA%\cdk-cli\
Examples
Complete Workflow Example
# 1. Start a test mint (in another terminal)
# 2. Add the mint
# 3. Create a mint quote
# 4. Pay the Lightning invoice (if using real Lightning backend)
# or wait a few seconds if using fake wallet
# 5. Mint the tokens
# 6. Check balance
# 7. Send some tokens
# 8. The recipient can receive with:
Working with Multiple Wallets
# Create wallets for different purposes
# Switch between wallets
Help and Documentation
# General help
# Help for specific commands
License
Code is under the MIT License
Contribution
All contributions are welcome.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, shall be licensed as above, without any additional terms or conditions.