aiolabs/bitspire
9
0
Fork 0
Code Issues 52 Pull requests 2 Projects Releases Packages Wiki Activity Actions

docs: add new dev.sh commands to README

Browse source 
- Add atm, zeus, mine commands to table
- Add --machine flag documentation
- Ignore docker/.state/ directory (generated files)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Patrick Mulligan 2026-02-15 15:02:11 -05:00
commit 0dafb7d8a8
6 changed files with 29 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

52
README.md
View file

@ -41,23 +41,27 @@ If status shows all services running and ATM funded, you're ready to develop!
./docker/dev.sh <command> [options]
```
| Command | Description |
| ------------- | ---------------------------------------------- |
| `up` | Start regtest + Lightning.Pub + relay |
| `up --fund` | Start and auto-fund ATM with 100k sats |
| `down` | Stop all services |
| `status` | Show service status and ATM balance |
| `fund [sats]` | Fund ATM app owner (default: 100000) |
| `logs` | Follow service logs |
| `reset` | Stop services and clear all state |
| Command | Description |
| ---------------- | -------------------------------------- |
| `up` | Start regtest + Lightning.Pub + relay |
| `up --fund` | Start and auto-fund ATM with 100k sats |
| `up --machine` | Start and launch ATM app |
| `down` | Stop all services |
| `status` | Show service status and ATM balance |
| `atm` | Launch ATM application (Electron) |
| `zeus` | Show Zeus wallet connection QR code |
| `fund [sats]` | Fund ATM app owner (default: 100000) |
| `mine [blocks]` | Mine regtest blocks (default: 1) |
| `logs [service]` | Follow service logs |
| `reset` | Stop services and clear all state |
### pnpm Scripts
| Command | Description |
| -------------- | -------------------------- |
| `pnpm dev` | Start machine app (Vite + Electron) |
| `pnpm build` | Build all packages |
| `pnpm test` | Run unit tests |
| Command | Description |
| ------------ | ----------------------------------- |
| `pnpm dev` | Start machine app (Vite + Electron) |
| `pnpm build` | Build all packages |
| `pnpm test` | Run unit tests |
### Machine App
@ -85,16 +89,16 @@ lamassu-next/
## Infrastructure Services
| Service | Port | Description |
| ----------------- | ----- | ------------------------------------ |
| strfry | 7777 | Nostr relay (ws://localhost:7777) |
| bitcoind | 18443 | Bitcoin regtest node |
| lnd-1 | 10001 | Lightning.Pub's LND node |
| lnd-2 | 10002 | Peer node for channel |
| lnd-3 | 10003 | Funding source (auto-miner rewards) |
| Lightning.Pub | 1776 | Nostr-native accounts API |
| Withdraw Extension| 1777 | LNURL-withdraw for cash-in |
| PostgreSQL | 5432 | Lightning.Pub database |
| Service | Port | Description |
| ------------------ | ----- | ----------------------------------- |
| strfry | 7777 | Nostr relay (ws://localhost:7777) |
| bitcoind | 18443 | Bitcoin regtest node |
| lnd-1 | 10001 | Lightning.Pub's LND node |
| lnd-2 | 10002 | Peer node for channel |
| lnd-3 | 10003 | Funding source (auto-miner rewards) |
| Lightning.Pub | 1776 | Nostr-native accounts API |
| Withdraw Extension | 1777 | LNURL-withdraw for cash-in |
| PostgreSQL | 5432 | Lightning.Pub database |
## Testing Cash-In Flow