Skip to content

Command-line AlgoChat client for sending encrypted messages on Algorand

Notifications You must be signed in to change notification settings

corvid-agent/algochat-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

algochat-cli

CLI client for AlgoChat — encrypted on-chain messaging on Algorand.

Install

bun install

Usage

# Generate a new account
bun run dev keygen

# Check balance
ALGOCHAT_MNEMONIC="your 25 words..." bun run dev balance

# Send a message
ALGOCHAT_MNEMONIC="your 25 words..." bun run dev send RECIPIENT_ADDRESS "Hello from AlgoChat"

# Read recent messages
ALGOCHAT_MNEMONIC="your 25 words..." bun run dev read

Environment

Variable Description Default
ALGOCHAT_MNEMONIC 25-word Algorand mnemonic Required for send
ALGOCHAT_NETWORK testnet or mainnet testnet

Commands

Command Description
send <address> <message> Send a message to an address
read [address] Read recent messages
balance [address] Check account balance
status Show network status
keygen Generate a new Algorand account

Protocol

Messages are sent as Algorand payment transactions with content in the note field. The AlgoChat protocol supports encryption via X25519 key exchange and XChaCha20-Poly1305. This CLI currently sends plaintext — encrypted messaging will be added once @corvidlabs/ts-algochat is published.

License

MIT

About

Command-line AlgoChat client for sending encrypted messages on Algorand

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •