A terminal UI for managing Octez blockchain services (nodes, bakers, accusers, DAL nodes, Signatory remote signers, octez-index).

Documentation

Warning
Octez Manager is in active development. Use at your own risk, especially on mainnet.

• Install and manage Octez services as systemd units (nodes, bakers, accusers, DAL, Signatory, octez-index)
• Terminal UI with tab-based navigation, real-time monitoring, logs, and 13 built-in themes
• Web interface for browser-based remote management
• Wallets — View balances, transfer, stake, delegate, and manage keys across all installed services
• Baker operations — Register, stake/unstake, set delegate parameters, governance voting via om baker
• Instance groups — Organize services into logical groups with shared lifecycle operations
• Binary management — Download, register, and prune Octez versions; cascade version updates with rollback
• RPC Browser — Interactively explore and query RPC endpoints with syntax highlighting and streaming
• Import external services — Detect unmanaged Octez systemd units and bring them under management
• Signatory integration for secure remote signing with HSM/cloud KMS support
• Snapshot import from tzinit.org with automatic download
• Self-update — Check for and install octez-manager updates
• Sandbox — Isolated Tezos sandbox environments for local testing (Experimental)
• Rewards engine — Built-in reward distribution for bakers with continual mode (Experimental)
• Network discovery from teztnets.com (mainnet, shadownet, etc.)

Quick install (default location):

curl -fsSL https://raw.githubusercontent.com/trilitech/octez-manager/main/install.sh | sh

• Root user: installs to /usr/local/bin (system-wide)
• Regular user: installs to ~/.local/bin (user-local)

Custom installation directory:

curl -fsSL https://raw.githubusercontent.com/trilitech/octez-manager/main/install.sh | sh -s -- --prefix=/custom/path

• OCaml 5.1+, opam 2.1+
• systemd
• sudo access (for system-wide services)

# Terminal UI
octez-manager

# Web interface (browser-based, for remote access)
octez-manager web --port 8080

The UI provides installation wizards, service monitoring, log viewing, and snapshot management. The web interface offers the same features accessible from any browser.

When running in matrix mode (MIAOU_DRIVER=matrix), you can tune responsiveness and redraw behavior:

# Tick/render rate caps (defaults are 60)
export MIAOU_MATRIX_TPS=60
export MIAOU_MATRIX_FPS=60

# Full-screen scrub cadence (default 30 frames, 0 disables)
export MIAOU_MATRIX_SCRUB_FRAMES=30

Useful presets:

• Lower CPU on constrained hosts: MIAOU_MATRIX_TPS=30 MIAOU_MATRIX_FPS=30
• Maximum smoothness on fast terminals: keep defaults at 60/60
• Investigating redraw artifacts: lower MIAOU_MATRIX_SCRUB_FRAMES (or disable with 0)

# Install a node with snapshot
octez-manager install-node \
  --instance shadownet \
  --network shadownet \
  --snapshot \
  --history-mode rolling

# Install a baker
octez-manager install-baker \
  --instance baker-shadownet \
  --node-instance shadownet \
  --delegate tz1...

# List services
octez-manager list

# Service actions
octez-manager instance <name> start|stop|restart|logs|purge

# Baker wallet operations
octez-manager baker <instance> status|stake|transfer|vote

# Manage binaries
octez-manager binaries download latest
octez-manager binaries list

Run octez-manager --help for all commands.

• CONTRIBUTING.md - Development guidelines
• CHANGELOG.md - Version history
• docs/TUI_TESTING_GUIDE.md - Writing TUI tests
• COVERAGE_PRIORITIES.md - Test coverage roadmap

MIT - see LICENSE.